Skip to content

Base Models

model

Modified pydantic model.

Classes:

  • APIModel –

    Modified pydantic model.

  • Unique –

    A hashable model with an id.

Functions:

  • Aliased –

    Create an aliased field.

DateTime module-attribute

DateTime = datetime

EnumType module-attribute

EnumType = TypeVar('EnumType', bound=Enum)

InputValue module-attribute

InputValue = TypeVar('InputValue', str, int, Enum)

LevelField module-attribute

LevelField = int

TZDateTime module-attribute

TZDateTime = datetime

UnixDateTime module-attribute

UnixDateTime = datetime

logger module-attribute

logger: Logger = getLogger(__name__)

APIModel pydantic-model

Modified pydantic model.

Config:

  • arbitrary_types_allowed: True

model_config class-attribute instance-attribute

model_config: ConfigDict = ConfigDict(
    arbitrary_types_allowed=True
)

Unique

A hashable model with an id.

Attributes:

id instance-attribute

id: int

Aliased

Aliased(
    alias: Optional[str] = None,
    default: Any = ...,
    **kwargs: Any,
) -> Any

Create an aliased field.

add_timezone

add_timezone(value: datetime) -> datetime

convert_datetime

convert_datetime(
    value: Optional[Mapping[str, Any]],
) -> datetime

parse_timestamp

parse_timestamp(
    value: Optional[Union[str, int, Mapping[str, Any]]],
) -> datetime

Parse a timestamp into a datetime object.

prevent_enum_error

prevent_enum_error(
    value: InputValue, cls: Type[EnumType]
) -> Union[EnumType, InputValue]

Prevent enum error by returning the value as is.