FastSurferCNN.utils.dataclasses

exception FastSurferCNN.utils.dataclasses.FrozenInstanceError

FastSurferCNN.utils.dataclasses.asdict(obj, *, dict_factory=<class 'dict'>)

Return the fields of a dataclass instance as a new dictionary mapping field names to field values.

Example usage:

@dataclass
class C:
    x: int
    y: int

c = C(1, 2)
assert asdict(c) == {'x': 1, 'y': 2}

If given, ‘dict_factory’ will be used instead of built-in dict. The function applies recursively to field values that are dataclass instances. This will also look into built-in containers: tuples, lists, and dicts. Other objects are copied with ‘copy.deepcopy()’.

FastSurferCNN.utils.dataclasses.astuple(obj, *, tuple_factory=<class 'tuple'>)

Return the fields of a dataclass instance as a new tuple of field values.

Example usage:

@dataclass
class C:
    x: int
    y: int

c = C(1, 2)
assert astuple(c) == (1, 2)

If given, ‘tuple_factory’ will be used instead of built-in tuple. The function applies recursively to field values that are dataclass instances. This will also look into built-in containers: tuples, lists, and dicts. Other objects are copied with ‘copy.deepcopy()’.

FastSurferCNN.utils.dataclasses.dataclass(cls=None, /, *, init=True, repr=True, eq=True, order=False, unsafe_hash=False, frozen=False, match_args=True, kw_only=False, slots=False, weakref_slot=False)

Add dunder methods based on the fields defined in the class.

Examines PEP 526 __annotations__ to determine fields.

If init is true, an __init__() method is added to the class. If repr is true, a __repr__() method is added. If order is true, rich comparison dunder methods are added. If unsafe_hash is true, a __hash__() method is added. If frozen is true, fields may not be assigned to after instance creation. If match_args is true, the __match_args__ tuple is added. If kw_only is true, then by default all fields are keyword-only. If slots is true, a new class with a __slots__ attribute is returned.

FastSurferCNN.utils.dataclasses.field(*, default=<dataclasses._MISSING_TYPE object>, default_factory=<dataclasses._MISSING_TYPE object>, help='', flags=(), init=True, repr=True, hash=None, compare=True, metadata=None, kw_only=False)

Extends dataclasses.field() to add help and flags to the metadata.

Parameters:

helpstr, default=””

A help string to be used in argparse description of parameters.

flagstuple of str, default=()

A list of default flags to add for this attribute.

Returns:

Field

A dataclass Field object with the extended metadata.

See also

dataclasses.field

The standard dataclass field function.

FastSurferCNN.utils.dataclasses.fields(class_or_instance)

Return a tuple describing the fields of this dataclass.

Accepts a dataclass or an instance of one. Tuple elements are of type Field.

FastSurferCNN.utils.dataclasses.get_field(dc, fieldname)

Return a specific Field object associated with a dataclass class or object.

Parameters:

dcdataclass, type[dataclass]

The dataclass containing the field.

fieldnamestr

The name of the field.

Returns:

Field, None

The Field object associated with fieldname or None if the field does not exist.

See also

dataclasses.fields

Return a tuple of Field objects for the dataclass.

FastSurferCNN.utils.dataclasses.is_dataclass(obj)

Returns True if obj is a dataclass or an instance of a dataclass.

FastSurferCNN.utils.dataclasses.make_dataclass(cls_name, fields, *, bases=(), namespace=None, init=True, repr=True, eq=True, order=False, unsafe_hash=False, frozen=False, match_args=True, kw_only=False, slots=False, weakref_slot=False, module=None)

Return a new dynamically created dataclass.

The dataclass name will be ‘cls_name’. ‘fields’ is an iterable of either (name), (name, type) or (name, type, Field) objects. If type is omitted, use the string ‘typing.Any’. Field objects are created by the equivalent of calling ‘field(name, type [, Field-info])’.:

C = make_dataclass('C', ['x', ('y', int), ('z', int, field(init=False))], bases=(Base,))

is equivalent to:

@dataclass
class C(Base):
    x: 'typing.Any'
    y: int
    z: int = field(init=False)

For the bases and namespace parameters, see the builtin type() function.

The parameters init, repr, eq, order, unsafe_hash, frozen, match_args, kw_only, slots, and weakref_slot are passed to dataclass().

If module parameter is defined, the ‘__module__’ attribute of the dataclass is set to that value.

FastSurferCNN.utils.dataclasses.replace(obj, /, **changes)

Return a new object replacing specified fields with new values.

This is especially useful for frozen classes. Example usage:

@dataclass(frozen=True)
class C:
    x: int
    y: int

c = C(1, 2)
c1 = replace(c, x=3)
assert c1.x == 3 and c1.y == 2