ExportDataJsonKwargs

Keyword arguments forwarded to json.dump by the JSON export.

Mirrors the keyword arguments of json.dump, so consult its documentation for their exact meaning.

Hierarchy

• ExportDataJsonKwargs
  • ExportDataKwargs

Index

Properties

• allow_nan
• check_circular
• cls
• default
• ensure_ascii
• indent
• separators
• skipkeys
• sort_keys

Properties

keyword-onlyoptionalallow_nan

allow_nan: NotRequired[bool]

If False (default: True), raises a ValueError for out-of-range float values (nan, inf, -inf) to strictly comply with the JSON specification. If True, uses their JavaScript equivalents (NaN, Infinity, -Infinity).

keyword-onlyoptionalcheck_circular

check_circular: NotRequired[bool]

If False (default: True), skips the circular reference check for container types. A circular reference will result in a RecursionError or worse if unchecked.

keyword-onlyoptionalcls

cls: NotRequired[type[json.JSONEncoder]]

Allows specifying a custom JSON encoder.

keyword-onlyoptionaldefault

default: NotRequired[Callable]

A function called for objects that can't be serialized otherwise. It should return a JSON-encodable version of the object or raise a TypeError.

keyword-onlyoptionalensure_ascii

ensure_ascii: NotRequired[bool]

Determines if non-ASCII characters should be escaped in the output JSON string.

keyword-onlyoptionalindent

indent: NotRequired[int]

Specifies the number of spaces for indentation in the pretty-printed JSON output.

keyword-onlyoptionalseparators

separators: NotRequired[tuple[str, str]]

A tuple of (item_separator, key_separator). The default is (', ', ': ') if indent is None and (',', ': ') otherwise.

keyword-onlyoptionalskipkeys

skipkeys: NotRequired[bool]

If True (default: False), dict keys that are not of a basic type (str, int, float, bool, None) will be skipped instead of raising a TypeError.

keyword-onlyoptionalsort_keys

sort_keys: NotRequired[bool]

Specifies whether the output JSON object should have keys sorted alphabetically.