Item (autotransform.item.base)

The base class and associated classes for Item components. Can be used as a generic Item.

class autotransform.item.base.Item(*, key: str, extra_data: Dict[str, Any] = None)

Bases: NamedComponent

The base for Item components. Returned by Input components and act as the units on which AutoTransform operates.

key

A unique key used to represent this item, such as a file path.

Type

str

extra_data

Any extra data that needs to be associated with this Item. Should be JSON encodable. Defaults to None.

Type

Optional[Dict[str, Any]], optional

name

The name of the component.

Type

ClassVar[ItemName]

extra_data: Optional[Dict[str, Any]]

key: str

name: ClassVar[ItemName] = 'generic'

class autotransform.item.base.ItemName(value)

Bases: str, Enum

A simple enum for mapping.

FILE = 'file'

GENERIC = 'generic'