Skip to content

Data Types

T module-attribute 

T = TypeVar('T', bound=Type[DataType])

deprecated_string_types module-attribute 

deprecated_string_types = {'sql', 'email', 'url', 'pythoncode'}

logger module-attribute 

logger = logging.getLogger(__name__)

Boolean 

Boolean(children: Dict[str, Any], format_attr: FormatAttr, optional: bool, name: Optional[str], description: Optional[str])

Bases: ScalarType

Element tag: <bool>

_children instance-attribute 

_children = children

children property 

children: SimpleNamespace

Return a SimpleNamespace of the children of this DataType.

description instance-attribute 

description = description

format_attr instance-attribute 

format_attr = format_attr

name instance-attribute 

name = name

optional instance-attribute 

optional = optional

rail_alias instance-attribute 

rail_alias: str

tag class-attribute instance-attribute 

tag = 'bool'

__eq__ 

__eq__(other)

__repr__ 

__repr__() -> str

_constructor_validation 

_constructor_validation(key: str, value: Any) -> FieldValidation

Creates a "FieldValidation" object for ValidatorService to run over, which specifies the key, value, and validators for a given field.

Its children should be populated by its nested fields' FieldValidations.

collect_validation 

collect_validation(key: str, value: Any, schema: Dict) -> FieldValidation

Gather validators on a value.

Case 

Case(children: Dict[str, Any], format_attr: FormatAttr, optional: bool, name: Optional[str], description: Optional[str])

Bases: NonScalarType

Element tag: <case>

_children instance-attribute 

_children = children

children property 

children: SimpleNamespace

Return a SimpleNamespace of the children of this DataType.

description instance-attribute 

description = description

format_attr instance-attribute 

format_attr = format_attr

name instance-attribute 

name = name

optional instance-attribute 

optional = optional

rail_alias instance-attribute 

rail_alias: str

tag class-attribute instance-attribute 

tag = 'case'

__eq__ 

__eq__(other)

__repr__ 

__repr__() -> str

_constructor_validation 

_constructor_validation(key: str, value: Any) -> FieldValidation

Creates a "FieldValidation" object for ValidatorService to run over, which specifies the key, value, and validators for a given field.

Its children should be populated by its nested fields' FieldValidations.

collect_validation 

collect_validation(key: str, value: Any, schema: Dict) -> FieldValidation

Choice 

Choice(children: Dict[str, Any], format_attr: FormatAttr, optional: bool, name: Optional[str], description: Optional[str], discriminator_key: str)

Bases: NonScalarType

Element tag: <object>

_children instance-attribute 

_children = children

children property 

children: SimpleNamespace

Return a SimpleNamespace of the children of this DataType.

description instance-attribute 

description = description

discriminator_key instance-attribute 

discriminator_key = discriminator_key

format_attr instance-attribute 

format_attr = format_attr

name instance-attribute 

name = name

optional instance-attribute 

optional = optional

rail_alias instance-attribute 

rail_alias: str

tag class-attribute instance-attribute 

tag = 'choice'

__eq__ 

__eq__(other)

__repr__ 

__repr__() -> str

_constructor_validation 

_constructor_validation(key: str, value: Any) -> FieldValidation

Creates a "FieldValidation" object for ValidatorService to run over, which specifies the key, value, and validators for a given field.

Its children should be populated by its nested fields' FieldValidations.

collect_validation 

collect_validation(key: str, value: Any, schema: Dict) -> FieldValidation

Date 

Date(children: Dict[str, Any], format_attr: FormatAttr, optional: bool, name: Optional[str], description: Optional[str])

Bases: ScalarType

Element tag: <date>

To configure the date format, create a date-format attribute on the element. E.g. <date name="..." ... date-format="%Y-%m-%d" />

_children instance-attribute 

_children = children

children property 

children: SimpleNamespace

Return a SimpleNamespace of the children of this DataType.

date_format instance-attribute 

date_format = None

description instance-attribute 

description = description

format_attr instance-attribute 

format_attr = format_attr

name instance-attribute 

name = name

optional instance-attribute 

optional = optional

rail_alias instance-attribute 

rail_alias: str

tag class-attribute instance-attribute 

tag = 'date'

__eq__ 

__eq__(other)

__repr__ 

__repr__() -> str

_constructor_validation 

_constructor_validation(key: str, value: Any) -> FieldValidation

Creates a "FieldValidation" object for ValidatorService to run over, which specifies the key, value, and validators for a given field.

Its children should be populated by its nested fields' FieldValidations.

collect_validation 

collect_validation(key: str, value: Any, schema: Dict) -> FieldValidation

Gather validators on a value.

Email 

Email(children: Dict[str, Any], format_attr: FormatAttr, optional: bool, name: Optional[str], description: Optional[str])

Bases: ScalarType

Element tag: <email>

_children instance-attribute 

_children = children

children property 

children: SimpleNamespace

Return a SimpleNamespace of the children of this DataType.

description instance-attribute 

description = description

format_attr instance-attribute 

format_attr = format_attr

name instance-attribute 

name = name

optional instance-attribute 

optional = optional

rail_alias instance-attribute 

rail_alias: str

tag class-attribute instance-attribute 

tag = 'email'

__eq__ 

__eq__(other)

__repr__ 

__repr__() -> str

_constructor_validation 

_constructor_validation(key: str, value: Any) -> FieldValidation

Creates a "FieldValidation" object for ValidatorService to run over, which specifies the key, value, and validators for a given field.

Its children should be populated by its nested fields' FieldValidations.

collect_validation 

collect_validation(key: str, value: Any, schema: Dict) -> FieldValidation

Gather validators on a value.

FieldValidation dataclass

children instance-attribute 

children: TypedList[FieldValidation]

key instance-attribute 

key: Any

value instance-attribute 

value: Any

Float 

Float(children: Dict[str, Any], format_attr: FormatAttr, optional: bool, name: Optional[str], description: Optional[str])

Bases: ScalarType

Element tag: <float>

_children instance-attribute 

_children = children

children property 

children: SimpleNamespace

Return a SimpleNamespace of the children of this DataType.

description instance-attribute 

description = description

format_attr instance-attribute 

format_attr = format_attr

name instance-attribute 

name = name

optional instance-attribute 

optional = optional

rail_alias instance-attribute 

rail_alias: str

tag class-attribute instance-attribute 

tag = 'float'

__eq__ 

__eq__(other)

__repr__ 

__repr__() -> str

_constructor_validation 

_constructor_validation(key: str, value: Any) -> FieldValidation

Creates a "FieldValidation" object for ValidatorService to run over, which specifies the key, value, and validators for a given field.

Its children should be populated by its nested fields' FieldValidations.

collect_validation 

collect_validation(key: str, value: Any, schema: Dict) -> FieldValidation

Gather validators on a value.

Integer 

Integer(children: Dict[str, Any], format_attr: FormatAttr, optional: bool, name: Optional[str], description: Optional[str])

Bases: ScalarType

Element tag: <integer>

_children instance-attribute 

_children = children

children property 

children: SimpleNamespace

Return a SimpleNamespace of the children of this DataType.

description instance-attribute 

description = description

format_attr instance-attribute 

format_attr = format_attr

name instance-attribute 

name = name

optional instance-attribute 

optional = optional

rail_alias instance-attribute 

rail_alias: str

tag class-attribute instance-attribute 

tag = 'integer'

__eq__ 

__eq__(other)

__repr__ 

__repr__() -> str

_constructor_validation 

_constructor_validation(key: str, value: Any) -> FieldValidation

Creates a "FieldValidation" object for ValidatorService to run over, which specifies the key, value, and validators for a given field.

Its children should be populated by its nested fields' FieldValidations.

collect_validation 

collect_validation(key: str, value: Any, schema: Dict) -> FieldValidation

Gather validators on a value.

List 

List(children: Dict[str, Any], format_attr: FormatAttr, optional: bool, name: Optional[str], description: Optional[str])

Bases: NonScalarType

Element tag: <list>

_children instance-attribute 

_children = children

children property 

children: SimpleNamespace

Return a SimpleNamespace of the children of this DataType.

description instance-attribute 

description = description

format_attr instance-attribute 

format_attr = format_attr

name instance-attribute 

name = name

optional instance-attribute 

optional = optional

rail_alias instance-attribute 

rail_alias: str

tag class-attribute instance-attribute 

tag = 'list'

__eq__ 

__eq__(other)

__repr__ 

__repr__() -> str

_constructor_validation 

_constructor_validation(key: str, value: Any) -> FieldValidation

Creates a "FieldValidation" object for ValidatorService to run over, which specifies the key, value, and validators for a given field.

Its children should be populated by its nested fields' FieldValidations.

collect_validation 

collect_validation(key: str, value: Any, schema: Dict) -> FieldValidation

Object 

Object(children: Dict[str, Any], format_attr: FormatAttr, optional: bool, name: Optional[str], description: Optional[str])

Bases: NonScalarType

Element tag: <object>

_children instance-attribute 

_children = children

children property 

children: SimpleNamespace

Return a SimpleNamespace of the children of this DataType.

description instance-attribute 

description = description

format_attr instance-attribute 

format_attr = format_attr

name instance-attribute 

name = name

optional instance-attribute 

optional = optional

rail_alias instance-attribute 

rail_alias: str

tag class-attribute instance-attribute 

tag = 'object'

__eq__ 

__eq__(other)

__repr__ 

__repr__() -> str

_constructor_validation 

_constructor_validation(key: str, value: Any) -> FieldValidation

Creates a "FieldValidation" object for ValidatorService to run over, which specifies the key, value, and validators for a given field.

Its children should be populated by its nested fields' FieldValidations.

collect_validation 

collect_validation(key: str, value: Any, schema: Dict) -> FieldValidation

Percentage 

Percentage(children: Dict[str, Any], format_attr: FormatAttr, optional: bool, name: Optional[str], description: Optional[str])

Bases: ScalarType

Element tag: <percentage>

_children instance-attribute 

_children = children

children property 

children: SimpleNamespace

Return a SimpleNamespace of the children of this DataType.

description instance-attribute 

description = description

format_attr instance-attribute 

format_attr = format_attr

name instance-attribute 

name = name

optional instance-attribute 

optional = optional

rail_alias instance-attribute 

rail_alias: str

tag class-attribute instance-attribute 

tag = 'percentage'

__eq__ 

__eq__(other)

__repr__ 

__repr__() -> str

_constructor_validation 

_constructor_validation(key: str, value: Any) -> FieldValidation

Creates a "FieldValidation" object for ValidatorService to run over, which specifies the key, value, and validators for a given field.

Its children should be populated by its nested fields' FieldValidations.

collect_validation 

collect_validation(key: str, value: Any, schema: Dict) -> FieldValidation

Gather validators on a value.

PythonCode 

PythonCode(children: Dict[str, Any], format_attr: FormatAttr, optional: bool, name: Optional[str], description: Optional[str])

Bases: ScalarType

Element tag: <pythoncode>

_children instance-attribute 

_children = children

children property 

children: SimpleNamespace

Return a SimpleNamespace of the children of this DataType.

description instance-attribute 

description = description

format_attr instance-attribute 

format_attr = format_attr

name instance-attribute 

name = name

optional instance-attribute 

optional = optional

rail_alias instance-attribute 

rail_alias: str

tag class-attribute instance-attribute 

tag = 'pythoncode'

__eq__ 

__eq__(other)

__repr__ 

__repr__() -> str

_constructor_validation 

_constructor_validation(key: str, value: Any) -> FieldValidation

Creates a "FieldValidation" object for ValidatorService to run over, which specifies the key, value, and validators for a given field.

Its children should be populated by its nested fields' FieldValidations.

collect_validation 

collect_validation(key: str, value: Any, schema: Dict) -> FieldValidation

Gather validators on a value.

SQLCode 

SQLCode(children: Dict[str, Any], format_attr: FormatAttr, optional: bool, name: Optional[str], description: Optional[str])

Bases: ScalarType

Element tag: <sql>

_children instance-attribute 

_children = children

children property 

children: SimpleNamespace

Return a SimpleNamespace of the children of this DataType.

description instance-attribute 

description = description

format_attr instance-attribute 

format_attr = format_attr

name instance-attribute 

name = name

optional instance-attribute 

optional = optional

rail_alias instance-attribute 

rail_alias: str

tag class-attribute instance-attribute 

tag = 'sql'

__eq__ 

__eq__(other)

__repr__ 

__repr__() -> str

_constructor_validation 

_constructor_validation(key: str, value: Any) -> FieldValidation

Creates a "FieldValidation" object for ValidatorService to run over, which specifies the key, value, and validators for a given field.

Its children should be populated by its nested fields' FieldValidations.

collect_validation 

collect_validation(key: str, value: Any, schema: Dict) -> FieldValidation

Gather validators on a value.

String 

String(children: Dict[str, Any], format_attr: FormatAttr, optional: bool, name: Optional[str], description: Optional[str])

Bases: ScalarType

Element tag: <string>

_children instance-attribute 

_children = children

children property 

children: SimpleNamespace

Return a SimpleNamespace of the children of this DataType.

description instance-attribute 

description = description

format_attr instance-attribute 

format_attr = format_attr

name instance-attribute 

name = name

optional instance-attribute 

optional = optional

rail_alias instance-attribute 

rail_alias: str

tag class-attribute instance-attribute 

tag = 'string'

__eq__ 

__eq__(other)

__repr__ 

__repr__() -> str

_constructor_validation 

_constructor_validation(key: str, value: Any) -> FieldValidation

Creates a "FieldValidation" object for ValidatorService to run over, which specifies the key, value, and validators for a given field.

Its children should be populated by its nested fields' FieldValidations.

collect_validation 

collect_validation(key: str, value: Any, schema: Dict) -> FieldValidation

Gather validators on a value.

Time 

Time(children: Dict[str, Any], format_attr: FormatAttr, optional: bool, name: Optional[str], description: Optional[str])

Bases: ScalarType

Element tag: <time>

To configure the date format, create a date-format attribute on the element. E.g. <time name="..." ... time-format="%H:%M:%S" />

_children instance-attribute 

_children = children

children property 

children: SimpleNamespace

Return a SimpleNamespace of the children of this DataType.

description instance-attribute 

description = description

format_attr instance-attribute 

format_attr = format_attr

name instance-attribute 

name = name

optional instance-attribute 

optional = optional

rail_alias instance-attribute 

rail_alias: str

tag class-attribute instance-attribute 

tag = 'time'

time_format instance-attribute 

time_format = '%H:%M:%S'

__eq__ 

__eq__(other)

__repr__ 

__repr__() -> str

_constructor_validation 

_constructor_validation(key: str, value: Any) -> FieldValidation

Creates a "FieldValidation" object for ValidatorService to run over, which specifies the key, value, and validators for a given field.

Its children should be populated by its nested fields' FieldValidations.

collect_validation 

collect_validation(key: str, value: Any, schema: Dict) -> FieldValidation

Gather validators on a value.

URL 

URL(children: Dict[str, Any], format_attr: FormatAttr, optional: bool, name: Optional[str], description: Optional[str])

Bases: ScalarType

Element tag: <url>

_children instance-attribute 

_children = children

children property 

children: SimpleNamespace

Return a SimpleNamespace of the children of this DataType.

description instance-attribute 

description = description

format_attr instance-attribute 

format_attr = format_attr

name instance-attribute 

name = name

optional instance-attribute 

optional = optional

rail_alias instance-attribute 

rail_alias: str

tag class-attribute instance-attribute 

tag = 'url'

__eq__ 

__eq__(other)

__repr__ 

__repr__() -> str

_constructor_validation 

_constructor_validation(key: str, value: Any) -> FieldValidation

Creates a "FieldValidation" object for ValidatorService to run over, which specifies the key, value, and validators for a given field.

Its children should be populated by its nested fields' FieldValidations.

collect_validation 

collect_validation(key: str, value: Any, schema: Dict) -> FieldValidation

Gather validators on a value.

deprecate_type 

deprecate_type(cls: type)

update_deprecated_type_to_string 

update_deprecated_type_to_string(type)

verify_metadata_requirements 

verify_metadata_requirements(metadata: dict, datatypes: Union[DataType, Iterable[DataType]]) -> TypedList[str]