Source code for torchoutil.serialization.json

#!/usr/bin/env python
# -*- coding: utf-8 -*-

from pathlib import Path
from typing import Any, Optional, Union

from torchoutil.pyoutil.json import dump_json as _dump_json_base
from torchoutil.pyoutil.json import load_json  # noqa: F401
from torchoutil.pyoutil.warnings import deprecated_alias

from .common import to_builtin


def dump_json(
    data: Any,
    fpath: Union[str, Path, None] = None,
    *,
    overwrite: bool = True,
    make_parents: bool = True,
    to_builtins: bool = False,
    # JSON dump kwargs
    indent: Optional[int] = 4,
    ensure_ascii: bool = False,
    **json_dump_kwds,
) -> str:
    """Dump content to JSON format into a string and/or file."""
    if to_builtins:
        data = to_builtin(data)

    return _dump_json_base(
        data,
        fpath,
        overwrite=overwrite,
        make_parents=make_parents,
        indent=indent,
        ensure_ascii=ensure_ascii,
        **json_dump_kwds,
    )


@deprecated_alias(dump_json)
def to_json(*args, **kwargs):
    ...