コンテンツにスキップ

pytilpack.json

pytilpack.json

JSON関連。

loads = json.loads module-attribute

JSONの文字列解析。標準ライブラリと同じだけど一応エイリアスを用意しておく。

load(source, encoding='utf-8', errors='replace', strict=False, **kwargs)

JSONファイルの読み込み。

ソースコード位置： pytilpack/json.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
def load(
    source: pytilpack.io.PathOrIO,
    encoding: str = "utf-8",
    errors: str = "replace",
    strict: bool = False,
    **kwargs,
) -> typing.Any:
    """JSONファイルの読み込み。"""
    try:
        return loads(pytilpack.io.read_text(source, encoding=encoding, errors=errors), **kwargs)
    except FileNotFoundError:
        if strict:
            raise
        return {}

converter(o, _default=None)

JSONエンコード時の変換処理。

日付はJavaScriptで対応できるようにISO8601形式に変換する。 YYYY-MM-DDTHH:mm:ss.sssZ https://tc39.es/ecma262/#sec-date-time-string-format

bytesはBASE64エンコードする。

ソースコード位置： pytilpack/json.py 
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
def converter(
    o: typing.Any,
    _default: typing.Callable[[typing.Any], typing.Any] | None = None,
) -> typing.Any:
    """JSONエンコード時の変換処理。

    日付はJavaScriptで対応できるようにISO8601形式に変換する。
    YYYY-MM-DDTHH:mm:ss.sssZ
    <https://tc39.es/ecma262/#sec-date-time-string-format>

    bytesはBASE64エンコードする。

    """
    if isinstance(o, datetime.datetime):
        return o.isoformat(timespec="milliseconds")
    if isinstance(o, datetime.date):
        return o.isoformat()
    if isinstance(o, datetime.time):
        return o.isoformat(timespec="milliseconds")
    if isinstance(o, bytes):
        return base64.b64encode(o).decode("ascii")
    return o if _default is None else _default(o)

save(dest, data, ensure_ascii=False, indent=None, separators=None, sort_keys=False, default=converter, encoding='utf-8', **kwargs)

JSONのファイル保存。

標準ライブラリと異なりデフォルトでensure_ascii=False、UTF-8で保存する。

ソースコード位置： pytilpack/json.py 
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
def save(
    dest: pytilpack.io.PathOrIO,
    data: typing.Any,
    ensure_ascii: bool = False,
    indent: int | str | None = None,
    separators: tuple[str, str] | None = None,
    sort_keys: bool = False,
    default: typing.Callable[[typing.Any], typing.Any] = converter,
    encoding: str = "utf-8",
    **kwargs,
) -> None:
    """JSONのファイル保存。

    標準ライブラリと異なりデフォルトでensure_ascii=False、UTF-8で保存する。

    """
    pytilpack.io.write_text(
        dest,
        dumps(
            data,
            ensure_ascii=ensure_ascii,
            indent=indent,
            separators=separators,
            sort_keys=sort_keys,
            default=default,
            **kwargs,
        ),
        encoding=encoding,
    )

dumps(data, ensure_ascii=False, indent=None, separators=None, sort_keys=False, default=converter, **kwargs)

JSONの文字列化。

標準ライブラリと異なりデフォルトでensure_ascii=False、UTF-8で保存する。 また、日付やbytesを変換するためのconverter関数をdefault引数に指定している。

ソースコード位置： pytilpack/json.py 
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
def dumps(
    data: typing.Any,
    ensure_ascii: bool = False,
    indent: int | str | None = None,
    separators: tuple[str, str] | None = None,
    sort_keys: bool = False,
    default: typing.Callable[[typing.Any], typing.Any] = converter,
    **kwargs,
) -> str:
    """JSONの文字列化。

    標準ライブラリと異なりデフォルトでensure_ascii=False、UTF-8で保存する。
    また、日付やbytesを変換するためのconverter関数をdefault引数に指定している。

    """
    return (
        json.dumps(
            data,
            ensure_ascii=ensure_ascii,
            indent=indent,
            separators=separators,
            sort_keys=sort_keys,
            default=default,
            **kwargs,
        )
        + "\n"
    )