pytilpack.dataclasses¶

`pytilpack.dataclasses` ¶

dataclasses関連のユーティリティ。

`asdict(obj)` ¶

dataclasses.asdict()のシャローコピーバージョン。

dataclasses.asdict()はネストされたdataclassを再帰的に処理してしまうが、その挙動が要らない場合に使う。公式マニュアルに書いてある回避策そのままのコード。 https://docs.python.org/ja/3/library/dataclasses.html#dataclasses.asdict

ソースコード位置： pytilpack/dataclasses.py

def asdict(obj: typing.Any) -> dict[str, typing.Any]:
    """dataclasses.asdict()のシャローコピーバージョン。

    dataclasses.asdict()はネストされたdataclassを再帰的に処理してしまうが、
    その挙動が要らない場合に使う。
    公式マニュアルに書いてある回避策そのままのコード。
    <https://docs.python.org/ja/3/library/dataclasses.html#dataclasses.asdict>

    """
    return {field.name: getattr(obj, field.name) for field in dataclasses.fields(obj)}

`fromdict(cls, data)` ¶

dictからdataclassを生成する。

pytilpack.dataclasses_.asdict()ではなく、 dataclasses.asdict()の逆変換(ネストにも対応)。

引数：

名前	タイプ	デスクリプション	デフォルト
`cls`	`type[TDataClass]`	dataclassの型	必須
`data`	`dict[str, Any]`	dict	必須

戻り値：

タイプ	デスクリプション
`TDataClass`	dataclassのインスタンス

ソースコード位置： pytilpack/dataclasses.py

def fromdict(cls: "type[TDataClass]", data: dict[str, typing.Any]) -> "TDataClass":
    """dictからdataclassを生成する。

    pytilpack.dataclasses_.asdict()ではなく、
    dataclasses.asdict()の逆変換(ネストにも対応)。

    Args:
        cls: dataclassの型
        data: dict

    Returns:
        dataclassのインスタンス

    """
    # dataclassのフィールドを取得
    field_types = {f.name: f.type for f in dataclasses.fields(cls)}
    # dataclassのフィールドに対応する値を取得
    values: dict[str, typing.Any] = {}
    for k, v in data.items():
        if v is None:
            # 値がNoneの場合はスキップ
            continue
        if k in field_types:
            # フィールドの型がdataclassの場合
            if dataclasses.is_dataclass(field_types[k]):
                # 再帰的にfromdictを呼び出す
                values[k] = fromdict(field_types[k], v)  # type: ignore[arg-type]
            else:
                values[k] = v
    # dataclassのインスタンスを生成
    return cls(**values)

`fromjson(cls, json_path)` ¶

jsonからdataclassを生成する。

引数：

名前	タイプ	デスクリプション	デフォルト
`cls`	`type[TDataClass]`	dataclassの型	必須
`json_path`	`str \| Path`	jsonファイルのパス	必須

戻り値：

タイプ	デスクリプション
`TDataClass`	dataclassのインスタンス

ソースコード位置： pytilpack/dataclasses.py

def fromjson(cls: "type[TDataClass]", json_path: str | pathlib.Path) -> "TDataClass":
    """jsonからdataclassを生成する。

    Args:
        cls: dataclassの型
        json_path: jsonファイルのパス

    Returns:
        dataclassのインスタンス

    """
    return fromdict(cls, pytilpack.json.load(json_path))

`tojson(obj, json_path, ensure_ascii=False, indent=None, separators=None, sort_keys=False)` ¶

dataclassをjsonに変換して保存する。

引数：

名前	タイプ	デスクリプション	デフォルト
`obj`	`Any`	dataclassのインスタンス	必須
`json_path`	`str \| Path`	保存先のパス	必須
`ensure_ascii`	`bool`	json.dumpの引数	`False`
`indent`	`Any \| None`	json.dumpの引数	`None`
`separators`	`Any \| None`	json.dumpの引数	`None`
`sort_keys`	`bool`	json.dumpの引数	`False`

ソースコード位置： pytilpack/dataclasses.py

def tojson(
    obj: typing.Any,
    json_path: str | pathlib.Path,
    ensure_ascii: bool = False,
    indent: typing.Any | None = None,
    separators: typing.Any | None = None,
    sort_keys: bool = False,
) -> None:
    """dataclassをjsonに変換して保存する。

    Args:
        obj: dataclassのインスタンス
        json_path: 保存先のパス
        ensure_ascii: json.dumpの引数
        indent: json.dumpの引数
        separators: json.dumpの引数
        sort_keys: json.dumpの引数

    """
    pytilpack.json.save(
        json_path,
        dataclasses.asdict(obj),
        ensure_ascii=ensure_ascii,
        indent=indent,
        separators=separators,
        sort_keys=sort_keys,
    )

`validate(instance)` ¶

dataclassインスタンスのフィールド型を詳細チェックする。

発生：

タイプ	デスクリプション
`TypeError`	型不一致、またはdataclassでない場合。詳細なエラー位置を含む。

ソースコード位置： pytilpack/dataclasses.py

def validate(instance: "DataclassInstance") -> None:
    """dataclassインスタンスのフィールド型を詳細チェックする。

    Raises:
        TypeError: 型不一致、またはdataclassでない場合。詳細なエラー位置を含む。
    """
    if not dataclasses.is_dataclass(instance):
        raise TypeError(f"{instance!r} is not a dataclass instance")

    pytilpack.typing.is_instance(instance, instance.__class__)

pytilpack.dataclasses¶