snakia.field

Classes

`AutoField`() ))
`BoolField`()
`Field`()
`FloatField`()
`IntField`()
`ListField`(field, *[, length_size, ...])
`OptionalField`(field, *[, none_value])
`StrField`(default_value, *[, encoding])

class snakia.field.AutoField(default_value: T, *, target_type: type[T] | Unset = Unset())[source]

class snakia.field.AutoField(*, default_factory: Callable[[Self], T], target_type: type[T] | Unset = Unset())

Bases: Field[T], Generic[T]

__init__(default_value=<class 'snakia.types.unique.Unset'>, *, default_factory=<class 'snakia.types.unique.Unset'>, target_type=<class 'snakia.types.unique.Unset'>)[source]

classmethod custom(serialize, deserialize)

Return type:: type[Field[TypeVar(R)]]

deserialize(serialized, /)[source]

Deserialize a value

Parameters:: serialized (bytes) – serialized value
Returns:: deserialized value
Return type:: T

static get_fields(class_, /)

Return type:: dict[str, Field[Any]]

property name: str: Return the name of the variable associated with the property.

serialize(value, /)[source]

Serialize a value

Parameters:: value (T) – value to serialize
Returns:: serialized value
Return type:: bytes

class snakia.field.BoolField[source]

class snakia.field.BoolField(default_value: T)

class snakia.field.BoolField(*, default_factory: Callable[[Self], T])

Bases: Field[bool]

__init__(default_value=<class 'snakia.types.unique.Unset'>, default_factory=<class 'snakia.types.unique.Unset'>)

classmethod custom(serialize, deserialize)

Return type:: type[Field[TypeVar(R)]]

deserialize(serialized, /)[source]

Deserialize a value

Parameters:: serialized (bytes) – serialized value
Returns:: deserialized value
Return type:: T

static get_fields(class_, /)

Return type:: dict[str, Field[Any]]

property name: str: Return the name of the variable associated with the property.

serialize(value, /)[source]

Serialize a value

Parameters:: value (T) – value to serialize
Returns:: serialized value
Return type:: bytes

class snakia.field.Field[source]

class snakia.field.Field(default_value: T)

class snakia.field.Field(*, default_factory: Callable[[Self], T])

Bases: ABC, PrivProperty[T], Generic[T]

__init__(default_value=<class 'snakia.types.unique.Unset'>, default_factory=<class 'snakia.types.unique.Unset'>)

final classmethod custom(serialize, deserialize)[source]

Return type:: type[Field[TypeVar(R)]]

abstract deserialize(serialized, /)[source]

Deserialize a value

Parameters:: serialized (bytes) – serialized value
Returns:: deserialized value
Return type:: T

final static get_fields(class_, /)[source]

Return type:: dict[str, Field[Any]]

property name: str: Return the name of the variable associated with the property.

abstract serialize(value, /)[source]

Serialize a value

Parameters:: value (T) – value to serialize
Returns:: serialized value
Return type:: bytes

class snakia.field.FloatField[source]

class snakia.field.FloatField(default_value: T)

class snakia.field.FloatField(*, default_factory: Callable[[Self], T])

Bases: Field[float]

__init__(default_value=<class 'snakia.types.unique.Unset'>, default_factory=<class 'snakia.types.unique.Unset'>)

classmethod custom(serialize, deserialize)

Return type:: type[Field[TypeVar(R)]]

deserialize(serialized, /)[source]

Deserialize a value

Parameters:: serialized (bytes) – serialized value
Returns:: deserialized value
Return type:: T

static get_fields(class_, /)

Return type:: dict[str, Field[Any]]

property name: str: Return the name of the variable associated with the property.

serialize(value, /)[source]

Serialize a value

Parameters:: value (T) – value to serialize
Returns:: serialized value
Return type:: bytes

class snakia.field.IntField[source]

class snakia.field.IntField(default_value: T)

class snakia.field.IntField(*, default_factory: Callable[[Self], T])

Bases: Field[int]

__init__(default_value=<class 'snakia.types.unique.Unset'>, default_factory=<class 'snakia.types.unique.Unset'>)

classmethod custom(serialize, deserialize)

Return type:: type[Field[TypeVar(R)]]

deserialize(serialized, /)[source]

Deserialize a value

Parameters:: serialized (bytes) – serialized value
Returns:: deserialized value
Return type:: T

static get_fields(class_, /)

Return type:: dict[str, Field[Any]]

property name: str: Return the name of the variable associated with the property.

serialize(value, /)[source]

Serialize a value

Parameters:: value (T) – value to serialize
Returns:: serialized value
Return type:: bytes

class snakia.field.ListField(field, *, length_size=1, default_factory=<function ListField.<lambda>>)[source]

Bases: Field[list[T]]

__init__(field, *, length_size=1, default_factory=<function ListField.<lambda>>)[source]

classmethod custom(serialize, deserialize)

Return type:: type[Field[TypeVar(R)]]

deserialize(serialized, /)[source]

Deserialize a value

Parameters:: serialized (bytes) – serialized value
Returns:: deserialized value
Return type:: T

static get_fields(class_, /)

Return type:: dict[str, Field[Any]]

property name: str: Return the name of the variable associated with the property.

serialize(items, /)[source]

Serialize a value

Parameters:: value (T) – value to serialize
Returns:: serialized value
Return type:: bytes

class snakia.field.OptionalField(field, *, none_value=b'')[source]

Bases: Field[T | None]

__init__(field, *, none_value=b'')[source]

classmethod custom(serialize, deserialize)

Return type:: type[Field[TypeVar(R)]]

deserialize(serialized, /)[source]

Deserialize a value

Parameters:: serialized (bytes) – serialized value
Returns:: deserialized value
Return type:: T

static get_fields(class_, /)

Return type:: dict[str, Field[Any]]

property name: str: Return the name of the variable associated with the property.

serialize(value, /)[source]

Serialize a value

Parameters:: value (T) – value to serialize
Returns:: serialized value
Return type:: bytes

class snakia.field.StrField(default_value, *, encoding='utf-8')[source]

Bases: Field[str]

__init__(default_value, *, encoding='utf-8')[source]

classmethod custom(serialize, deserialize)

Return type:: type[Field[TypeVar(R)]]

deserialize(serialized, /)[source]

Deserialize a value

Parameters:: serialized (bytes) – serialized value
Returns:: deserialized value
Return type:: T

static get_fields(class_, /)

Return type:: dict[str, Field[Any]]

property name: str: Return the name of the variable associated with the property.

serialize(value, /)[source]

Serialize a value

Parameters:: value (T) – value to serialize
Returns:: serialized value
Return type:: bytes

Modules

`auto`
`bool`
`field`
`float`
`int`
`list`
`optional`
`str`
`t`