コンテンツにスキップ

pytilpack.yaml

必要なextra

pip install pytilpack[pyyaml]

pytilpack.yaml

YAML関連。

CustomDumper

Bases: SafeDumper

書式をカスタマイズしたDumper。

インデントのカスタマイズ:

PyYAMLのデフォルトでは

key:
- item1
- item2

となるが、これを

key:
  - item1
  - item2

とする。

文字列のカスタマイズ:

2行以上の文字列はブロックスカラーで出力する。

increase_indent(flow=False, indentless=False)

インデント増加時の処理。

ソースコード位置： pytilpack/yaml.py 
71
72
73
74
75
@typing.override
def increase_indent(self, flow=False, indentless=False):
    """インデント増加時の処理。"""
    del indentless
    return super().increase_indent(flow, False)

str_representer(dumper, value) staticmethod

改行を含む文字列を検出し、style='|' で出力する representer。

ソースコード位置： pytilpack/yaml.py 
77
78
79
80
81
82
83
84
@staticmethod
def str_representer(dumper, value):
    """改行を含む文字列を検出し、style='|' で出力する representer。"""
    if "\n" in value.rstrip():
        # 改行を含む場合はリテラルスタイル '|'
        return dumper.represent_scalar("tag:yaml.org,2002:str", value, style="|")
    # 改行を含まない場合は既定動作
    return dumper.represent_scalar("tag:yaml.org,2002:str", value)

load(source, encoding='utf-8', errors='replace', strict=False, Loader=yaml.SafeLoader)

YAMLファイルの読み込み。

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

load_all(source, encoding='utf-8', errors='replace', strict=False, Loader=yaml.SafeLoader)

YAMLファイルの読み込み。

ソースコード位置： pytilpack/yaml.py 
26
27
28
29
30
31
32
33
34
35
36
37
38
39
def load_all(
    source: pytilpack.io.PathOrIO,
    encoding: str = "utf-8",
    errors: str = "replace",
    strict: bool = False,
    Loader=yaml.SafeLoader,
) -> list[typing.Any]:
    """YAMLファイルの読み込み。"""
    try:
        return list(yaml.load_all(pytilpack.io.read_text(source, encoding=encoding, errors=errors), Loader=Loader))
    except FileNotFoundError:
        if strict:
            raise
        return []

save(dest, data, allow_unicode=True, width=99, default_style=None, default_flow_style=False, sort_keys=False, Dumper=CustomDumper, encoding='utf-8', **kwargs)

YAMLのファイル保存。

ソースコード位置： pytilpack/yaml.py 
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
def save(
    dest: pytilpack.io.PathOrIO,
    data: typing.Any,
    allow_unicode: bool | None = True,
    width: int = 99,
    default_style: str | None = None,
    default_flow_style: bool | None = False,
    sort_keys: bool = False,
    Dumper=CustomDumper,
    encoding: str = "utf-8",
    **kwargs,
) -> None:
    """YAMLのファイル保存。"""
    pytilpack.io.write_text(
        dest,
        dumps(
            data,
            allow_unicode=allow_unicode,
            width=width,
            default_style=default_style,
            default_flow_style=default_flow_style,
            sort_keys=sort_keys,
            Dumper=Dumper,
            **kwargs,
        ),
        encoding=encoding,
    )

save_all(dest, data, allow_unicode=True, width=99, default_style=None, default_flow_style=False, sort_keys=False, Dumper=CustomDumper, encoding='utf-8', **kwargs)

YAMLのファイル保存。

ソースコード位置： pytilpack/yaml.py 
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
def save_all(
    dest: pytilpack.io.PathOrIO,
    data: list[typing.Any],
    allow_unicode: bool | None = True,
    width: int = 99,
    default_style: str | None = None,
    default_flow_style: bool | None = False,
    sort_keys: bool = False,
    Dumper=CustomDumper,
    encoding: str = "utf-8",
    **kwargs,
) -> None:
    """YAMLのファイル保存。"""
    pytilpack.io.write_text(
        dest,
        dumps_all(
            data,
            allow_unicode=allow_unicode,
            width=width,
            default_style=default_style,
            default_flow_style=default_flow_style,
            sort_keys=sort_keys,
            Dumper=Dumper,
            **kwargs,
        ),
        encoding=encoding,
    )

dumps(data, allow_unicode=True, width=99, default_style=None, default_flow_style=False, sort_keys=False, Dumper=CustomDumper, **kwargs)

YAMLの文字列化。

ソースコード位置： pytilpack/yaml.py 
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
def dumps(
    data: typing.Any,
    allow_unicode: bool | None = True,
    width: int = 99,
    default_style: str | None = None,
    default_flow_style: bool | None = False,
    sort_keys: bool = False,
    Dumper=CustomDumper,
    **kwargs,
) -> str:
    """YAMLの文字列化。"""
    return yaml.dump(
        data,
        allow_unicode=allow_unicode,
        width=width,
        default_style=default_style,
        default_flow_style=default_flow_style,
        sort_keys=sort_keys,
        Dumper=Dumper,
        **kwargs,
    )

dumps_all(data, allow_unicode=True, width=99, default_style=None, default_flow_style=False, sort_keys=False, Dumper=CustomDumper, **kwargs)

YAMLの文字列化。

ソースコード位置： pytilpack/yaml.py 
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
def dumps_all(
    data: list[typing.Any],
    allow_unicode: bool | None = True,
    width: int = 99,
    default_style: str | None = None,
    default_flow_style: bool | None = False,
    sort_keys: bool = False,
    Dumper=CustomDumper,
    **kwargs,
) -> str:
    """YAMLの文字列化。"""
    return yaml.dump_all(
        data,
        allow_unicode=allow_unicode,
        width=width,
        default_style=default_style,
        default_flow_style=default_flow_style,
        sort_keys=sort_keys,
        Dumper=Dumper,
        **kwargs,
    )