`antimatter.handlers.scalar`#

Module Contents#

Classes#

ScalarHandler

The Scalar DataHandler supports a scalar value.

Attributes#

COLUMN_NAME

antimatter.handlers.scalar.COLUMN_NAME = 'content'#

class antimatter.handlers.scalar.ScalarHandler#

Bases: antimatter.handlers.base.DataHandler

The Scalar DataHandler supports a scalar value.

from_generic(cols: List[str], generic_data: List[List[bytes]], extra: Dict[str, Any]) → Any#

from_generic expects a single value in a list of lists and extracts this value if it can be found.

Parameters:

cols – ignored when converting from generic as the column is a static name.
generic_data – the generic data holder wrapping a single value.
extra – extra data for the DataHandler. Ignored when converting.

Returns:

the value held in the generic data format

to_generic(data: Any) → Tuple[list, List[List[bytes]], Dict[str, Any]]#

to_generic converts a scalar value into the generic data format.

Parameters:: data – the scalar value to wrap into a generic format
Returns:: the data in its generic form

field_converter_from_generic(ft: antimatter.fieldtype.fieldtypes.FieldType) → Callable[[bytes], Any]#

field_converter_from_generic gets a field converter function for the given field type that can be used to convert fields from their generic string type to their specific type.

Note that these statement should be true for all implementations, given FieldType ft.

from_gen = field_converter_from_generic(ft) to_gen = field_converter_to_generic(ft)

generic_value == to_gen(from_gen(generic_value)) field_value == from_gen(to_gen(field_value))

Parameters:: ft – the FieldType to get the converter function for
Returns:: a function that can convert field values from generic form

field_converter_to_generic(ft: antimatter.fieldtype.fieldtypes.FieldType) → Callable[[Any], bytes]#

field_converter_to_generic gets a field converter function for the given field type that can be used to convert fields from their specific type to their generic type.