API Reference

tattl

tattl.unpack_dict(data: dict[str, Any], structure: type[S]) → S

Validates that the type of each Field in structure matches the type of the value it is given in data.

Parameters:

• data – A dict generated by tomllib.load or tomllib.loads.

• structure – A dataclass

Raises:

• ValidationException – Raised when a value in data has a type that differs from that of the Field with the same name in structure.

• MissingFieldException – Raised when a Field in structure without a default initialisation or factory is missing from data.

Returns:

An instance of structure, with attributes corresponding to the contents of data.

tattl.exceptions

exception tattl.exceptions.MissingFieldException

Indicates that the data is missing a required field in the dataclass.

exception tattl.exceptions.TATTLException

Raised when the data given does not conform to the dataclass.

This is the base exception for all TATTL exceptions.

exception tattl.exceptions.ValidationException

Indicates that the type of a field in the data differs from the type of the dataclass field with the same name.