data_designer.config.utils.type_helpers

Module Contents

Classes

Name	Description
`StrEnum`	str(object=”) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Functions

Name	Description
`create_str_enum_from_discriminated_type_union`	Create a string enum from a type union.
`get_sampler_params`	Returns a dictionary of sampler parameter classes.
`resolve_string_enum`	None

Data

SAMPLER_PARAMS

API

1 class data_designer.config.utils.type_helpers.StrEnum

Bases: str, enum.Enum

1 data_designer.config.utils.type_helpers.create_str_enum_from_discriminated_type_union(
2     enum_name: str,
3     type_union: type,
4     discriminator_field_name: str
5 ) -> data_designer.config.utils.type_helpers.StrEnum

Create a string enum from a type union.

The type union is assumed to be a union of configs (Pydantic models) that have a discriminator field, which must be a Literal string type - e.g., Literal[“expression”].

Parameters:

enum_name

str

Name of the StrEnum.

type_union

type

Type union of configs (Pydantic models).

discriminator_field_name

str

Name of the discriminator field.

Returns:

data_designer.config.utils.type_helpers.StrEnum

StrEnum with values being the discriminator field values of the configs in the type union.

Example:

1 DataDesignerColumnType = create_str_enum_from_discriminated_type_union(
2     enum_name="DataDesignerColumnType",
3     type_union=ColumnConfigT,
4     discriminator_field_name="column_type",
5 )

1 data_designer.config.utils.type_helpers.get_sampler_params() -> dict[str, type[pydantic.BaseModel]]

Returns a dictionary of sampler parameter classes.

1 data_designer.config.utils.type_helpers.resolve_string_enum(
2     enum_instance: typing.Any,
3     enum_type: type[enum.Enum]
4 ) -> enum.Enum

1 SAMPLER_PARAMS = get_sampler_params(...)

1	data_designer.config.utils.type_helpers.create_str_enum_from_discriminated_type_union(
2	enum_name: str,
3	type_union: type,
4	discriminator_field_name: str
5	) -> data_designer.config.utils.type_helpers.StrEnum

1	DataDesignerColumnType = create_str_enum_from_discriminated_type_union(
2	enum_name="DataDesignerColumnType",
3	type_union=ColumnConfigT,
4	discriminator_field_name="column_type",
5	)

1	data_designer.config.utils.type_helpers.resolve_string_enum(
2	enum_instance: typing.Any,
3	enum_type: type[enum.Enum]
4	) -> enum.Enum