stouputils.io.json module#

json_dump(
data: Any,
file: IO[Any] | str | None = None,
max_level: int | None = 2,
indent: str | int = '\t',
suffix: str = '\n',
ensure_ascii: bool = False,
) → str[source]#

Writes the provided data to a JSON file with a specified indentation depth. For instance, setting max_level to 2 will limit the indentation to 2 levels.

Parameters:

  • data (Any) – The data to dump (usually a dict or a list)

  • file (IO[Any] | str) – The file object or path to dump the data to

  • max_level (int | None) – The depth of indentation to stop at (-1 for infinite), None will default to 2

  • indent (str | int) – The indentation character (default: ‘t’)

  • suffix (str) – The suffix to add at the end of the string (default: ‘n’)

  • ensure_ascii (bool) – Whether to escape non-ASCII characters (default: False)

Returns:

The content of the file in every case

Return type:

str

>>> json_dump({"a": [[1,2,3]], "b": 2}, max_level = 0)
'{"a": [[1,2,3]],"b": 2}\n'
>>> json_dump({"a": [[1,2,3]], "b": 2}, max_level = 1)
'{\n\t"a": [[1,2,3]],\n\t"b": 2\n}\n'
>>> json_dump({"a": [[1,2,3]], "b": 2}, max_level = 2)
'{\n\t"a": [\n\t\t[1,2,3]\n\t],\n\t"b": 2\n}\n'
>>> json_dump({"a": [[1,2,3]], "b": 2}, max_level = 3)
'{\n\t"a": [\n\t\t[\n\t\t\t1,\n\t\t\t2,\n\t\t\t3\n\t\t]\n\t],\n\t"b": 2\n}\n'
>>> json_dump({"éà": "üñ"}, ensure_ascii = True, max_level = 0)
'{"\\u00e9\\u00e0": "\\u00fc\\u00f1"}\n'
>>> json_dump({"éà": "üñ"}, ensure_ascii = False, max_level = 0)
'{"éà": "üñ"}\n'
json_load(file_path: str) → Any[source]#

Load a JSON file from the given path

Parameters:

file_path (str) – The path to the JSON file

Returns:

The content of the JSON file

Return type:

Any