csb43.formats

Conversion from AEB43 to dict and tabular formats.

exception csb43.formats.FormatWarning

A warning related to conversion formats.

class csb43.formats.CsbJsonEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)

A JSON encoder ready for currency and dates.

Constructor for JSONEncoder, with sensible defaults.

If skipkeys is false, then it is a TypeError to attempt encoding of keys that are not str, int, float, bool or None. If skipkeys is True, such items are simply skipped.

If ensure_ascii is true, the output is guaranteed to be str objects with all incoming non-ASCII characters escaped. If ensure_ascii is false, the output can contain non-ASCII characters.

If check_circular is true, then lists, dicts, and custom encoded objects will be checked for circular references during encoding to prevent an infinite recursion (which would cause an RecursionError). Otherwise, no such check takes place.

If allow_nan is true, then NaN, Infinity, and -Infinity will be encoded as such. This behavior is not JSON specification compliant, but is consistent with most JavaScript based encoders and decoders. Otherwise, it will be a ValueError to encode such floats.

If sort_keys is true, then the output of dictionaries will be sorted by key; this is useful for regression tests to ensure that JSON serializations can be compared on a day-to-day basis.

If indent is a non-negative integer, then JSON array elements and object members will be pretty-printed with that indent level. An indent level of 0 will only insert newlines. None is the most compact representation.

If specified, separators should be an (item_separator, key_separator) tuple. The default is (’, ‘, ‘: ‘) if indent is None and (‘,’, ‘: ‘) otherwise. To get the most compact JSON representation, you should specify (‘,’, ‘:’) to eliminate whitespace.

If specified, default is a function that gets called for objects that can’t otherwise be serialized. It should return a JSON encodable version of the object or raise a TypeError.

default(o)

Add conversion for dates and currencies.

Parameters:

o (Any)

Return type:

Any

csb43.formats.convert_aeb43_to_dict(batch, expected_format='json', decimal_fallback=None)

Convert from CSB43 to a dictionary format.

Parameters:

• batch (Batch) – an AEB43 Batch

• expected_format (str) – destination format

• decimal_fallback (Literal['str', 'float'] | None)

Return type:

_TablibSurrogate

csb43.formats.convert_aeb43_to_tabular(batch, expected_format='ods', decimal_fallback=None)

Convert an AEB43 batch into a tablib data object.

Parameters:

• batch (Batch) – an AEB43 batch

• expected_format (str) – output format

• decimal_fallback (_Fallback | None) – fall-back representation for decimal objects

Return type:

a tablib.Databook or tablib.Dataset

csb43.formats.convert_from_aeb43(batch, expected_format, decimal_fallback=None)

Convert a batch file into a tablib data object or a dictionary-like object.

Parameters:

• batch (Batch) – an AEB43 batch

• decimal_fallback (_Fallback | None) –

  decimal number fallback representation:

  • ’float’: use type float

  • ’str’: represent decimal as a string

  • None: use default fallback (‘str’)

• expected_format (str)

Returns:

• tablib.Databook, tablib.Dataset or an object

• with an attribute named as expected_format

Return type:

_TablibSurrogate | tablib.Dataset

formats.FORMATS = ['json']

formats.TABLIB_FORMATS = []

formats.DICT_FORMATS = ['json']