StringifyEnumJsonEncoder Class

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 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.

Inheritance

json.encoder.JSONEncoder

StringifyEnumJsonEncoder

Constructor

StringifyEnumJsonEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)

Keyword-Only Parameters

Name	Description
skipkeys Required
ensure_ascii	Default value: True
check_circular	Default value: True
allow_nan	Default value: True
sort_keys Required
indent Required
separators Required
default Required

Methods

default
encode	Return a JSON string representation of a Python data structure. >>> from json.encoder import JSONEncoder >>> JSONEncoder().encode({"foo": ["bar", "baz"]}) '{"foo": ["bar", "baz"]}'
iterencode	Encode the given object and yield each string representation as available. For example: for chunk in JSONEncoder().iterencode(bigobject): mysocket.write(chunk)

default

default(o)

Parameters

Name	Description
o Required

encode

Return a JSON string representation of a Python data structure.

>>> from json.encoder import JSONEncoder
>>> JSONEncoder().encode({"foo": ["bar", "baz"]})
'{"foo": ["bar", "baz"]}'

encode(o)

Parameters

Name	Description
o Required

iterencode

Encode the given object and yield each string representation as available.

For example:

   for chunk in JSONEncoder().iterencode(bigobject):
       mysocket.write(chunk)

iterencode(o, _one_shot=False)

Parameters

Name	Description
o Required
_one_shot Required	Default value: False

Attributes

item_separator

item_separator = ', '

key_separator

key_separator = ': '