Input (autotransform.input.base)

The base class and associated classes for Input components.

class autotransform.input.base.Input

Bases: NamedComponent

The base for Input components. Used by AutoTransform to get Items that represent potentially transformable units for a Schema. Usually returns files but any Item can be returned as long as Schema components work with it.

name

The name of the component.

Type:

ClassVar[InputName]

abstract get_items() → Sequence[Item]

Get a list of Items to be used by the transformation based on the Input criteria. Usually returns FileItems.

Returns:

The eligible Items for transformation.

Return type:

Sequence[Item]

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

name: ClassVar[InputName]

class autotransform.input.base.InputName(value)

Bases: str, Enum

A simple enum for mapping.

DIRECTORY = 'directory'

EMPTY = 'empty'

GIT_GREP = 'git_grep'

INLINE = 'inline'

INLINE_FILE = 'inline_file'

INLINE_GENERIC = 'inline_generic'

SCRIPT = 'script'

TARGET = 'target'