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]

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'¶