snakia.field

Classes

`AutoField`(default_value, *[, target_type])
`BoolField`(default_value)
`Field`(default_value)
`FloatField`(default_value)
`IntField`(default_value)
`StrField`(default_value, *[, encoding])

class snakia.field.AutoField(default_value, *, target_type=None)[source]

Bases: Field[T], Generic[T]

__init__(default_value, *, target_type=None)[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(default_value)[source]

Bases: Field[bool]

__init__(default_value)

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(default_value)[source]

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

__init__(default_value)[source]

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(default_value)[source]

Bases: Field[float]

__init__(default_value)

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(default_value)[source]

Bases: Field[int]

__init__(default_value)

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`
`str`
`t`