SchemaBuilder (autotransform.schema.builder)

The base class and associated classes for SchemaBuilders.

class autotransform.schema.builder.SchemaBuilder

Bases: NamedComponent

The base for SchemaBuilders. SchemaBuilders are used for programatic Schema generation. This can be used in conjunction with inputs or configuration to customize Schemas run through automation. Can also be used to generate JSON Schemas that can be utilized.

build() → AutoTransformSchema

Builds a Schema based on the state of the SchemaBuilder.

Returns:: The Schema produced by this SchemaBuilder.
Return type:: AutoTransformSchema

dump_to_file(path: str) → None

Dumps the Schema this SchemaBuilder would produce to the file located at the provided path.

Parameters:: path (str) – The path of the file to dump the JSON encoded Schema to.

get_batcher() → Batcher

Get the Batcher for the Schema.

Returns:: The Batcher that will be used in the built Schema.
Return type:: Batcher

get_commands() → List[Command]

Get the Commands for the Schema.

Returns:: The Commands that will be used in the built Schema.
Return type:: List[Command]

get_config() → SchemaConfig

Get the SchemaConfig for the Schema.

Returns:: The SchemaConfig that will be used in the built Schema.
Return type:: SchemaConfig

get_filters() → List[Filter]

Get the Filters for the Schema.

Returns:: The Filters that will be used in the built Schema.
Return type:: List[Filter]

abstract get_input() → Input

Get the Input for the Schema.

Returns:: The Input that will be used in the built Schema.
Return type:: Input

get_repo() → Repo | None

Get the Repo for the Schema.

Returns:: The Repo that will be used in the built Schema.
Return type:: Repo

abstract get_transformer() → Transformer

Get the Transformer for the Schema.

Returns:: The Transformer that will be used in the built Schema.
Return type:: Transformer

get_validators() → List[Validator]

Get the Validators for the Schema.

Returns:: The Validators that will be used in the built Schema.
Return type:: List[Validator]

model_config: ClassVar[ConfigDict] = {}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class autotransform.schema.builder.SchemaBuilderName(value)

Bases: str, Enum

A simple enum for mapping.