pythonの記法 中級編

Tweet

未定義のはずのメンバ変数がなぜか使える

たまにディクショナリっぽい変数なのに、クラスのメンバ変数にアクセスしているかのようなコードを見ることがあります。
これの正体は一体何なのか気になったので調べました。

dictのキーをオブジェクトの属性のようにアクセスする方法はいくつかあります。代表的な方法として、namedtupleやSimpleNamespace、そしてカスタムクラスを使ったアプローチがあります。以下に、それぞれの方法を紹介します。

1. collections.namedtupleを使用する方法

namedtupleは、ディクショナリのキーに対して、オブジェクトの属性のようにアクセスできるようにする便利な方法です。

from collections import namedtuple

# 辞書データ
data = {"key1": "value1", "key2": "value2"}

# namedtupleを作成
Data = namedtuple('Data', data.keys())

# namedtupleを辞書から初期化
data_namedtuple = Data(**data)

# 属性のようにアクセス
print(data_namedtuple.key1)  # "value1"
print(data_namedtuple.key2)  # "value2"

2. types.SimpleNamespaceを使用する方法

Pythonの標準ライブラリであるtypes.SimpleNamespaceを使えば、簡単に辞書のキーをオブジェクトの属性のようにアクセスできるようにできます。

from types import SimpleNamespace

# 辞書データ
data = {"key1": "value1", "key2": "value2"}

# SimpleNamespaceに変換
data_namespace = SimpleNamespace(**data)

# 属性のようにアクセス
print(data_namespace.key1)  # "value1"
print(data_namespace.key2)  # "value2"

3. カスタムクラスを使用する方法

カスタムクラスを使って、_getattrやsetattr_メソッドをオーバーライドすることで、ディクショナリに似た動作を持つクラスを作成できます。

class DictToObj:
    def __init__(self, dictionary):
        self.__dict__.update(dictionary)

# 辞書データ
data = {"key1": "value1", "key2": "value2"}

# カスタムクラスを使用してオブジェクトを作成
data_obj = DictToObj(data)

# 属性のようにアクセス
print(data_obj.key1)  # "value1"
print(data_obj.key2)  # "value2"

4. 辞書のようにアクセス可能かつ、属性アクセスも可能なクラス

辞書のようなアクセス方法と、属性のようなアクセス方法の両方を持つカスタムクラスも作成可能です。

class AttrDict(dict):
    def __getattr__(self, key):
        try:
            return self[key]
        except KeyError:
            raise AttributeError(f"Attribute '{key}' not found")

    def __setattr__(self, key, value):
        self[key] = value

# 辞書データ
data = {"key1": "value1", "key2": "value2"}

# カスタムクラスを使用
data_obj = AttrDict(data)

# 属性のようにアクセス
print(data_obj.key1)  # "value1"

# 辞書のようにアクセス
print(data_obj["key1"])  # "value1"

# 新しい属性の設定
data_obj.key3 = "value3"
print(data_obj.key3)  # "value3"

結論

このように、辞書のキーにオブジェクトの属性のようにアクセスする方法は色々ありますが、Python標準ライブラリのSimpleNamespaceがシンプルで最も使いやすいです。DjangoのORMは、内部的にこれと同様の仕組みを利用していると考えられますが、より高度なメタクラスやカスタムフィールド処理を追加している部分もあります。

**dataって何？

「**data」はPythonのキーワードで、辞書などのデータを関数やクラスに渡す際に、可変個のキーワード引数（named arguments）を辞書として受け取るためのシンタックスです。これにより、複数の引数を一度に渡すことができます。

具体的には、**dataのように二重アスタリスク（**）を使うことで、辞書型のデータを展開して、関数やメソッドにキーワード引数として渡すことができます。

例：**dataの使い方

def example_function(**kwargs):
    for key, value in kwargs.items():
        print(f"{key}: {value}")

# 辞書データ
data = {"key1": "value1", "key2": "value2"}

# **を使って辞書を展開して関数に渡す
example_function(**data)

この場合、dataという辞書を**dataとして渡すことで、key1とkey2がキーワード引数として展開され、関数のkwargs**という辞書に渡されます。

出力:

key1: value1
key2: value2

具体的な意味：

• * は位置引数のタプルを受け取るために使います（*args）。
• ** はキーワード引数を辞書として受け取るために使います（**kwargs）。
• 逆に、関数を呼び出すときに**辞書の形式で渡すと、辞書のキーがキーワード引数に、値がその引数の値に展開されます。

これにより、柔軟に辞書データを関数やクラスの引数として渡すことができます。

namedtupleは、Pythonの標準ライブラリcollectionsに含まれているデータ構造で、通常のタプルのように扱いながら、より直感的なアクセスを可能にする方法です。具体的には、インデックスだけでなく名前を使って要素にアクセスできる点が特徴です。これにより、コードの可読性が向上します。

namedtupleの使いどころ

1. 軽量で不変のデータ構造が必要なとき

namedtupleは、タプルのように不変でありながら、名前付きフィールドを持つ軽量なデータ構造として使われます。通常のクラスを定義するのは少し重たいけれど、辞書のようにオーバーヘッドがあるデータ構造は避けたいという場合に適しています。

例えば、座標や点、ログデータのように、あらかじめ決まった数の要素を持つデータを扱う場合に便利です。

from collections import namedtuple

# Pointというnamedtupleを定義
Point = namedtuple('Point', ['x', 'y'])

# Pointオブジェクトの生成
p = Point(10, 20)

# フィールドに名前でアクセスできる
print(p.x)  # 10
print(p.y)  # 20

2. データを明確に表現したいとき

通常のタプルはインデックス番号を使って要素にアクセスしますが、namedtupleを使えば、名前を使ってアクセスできるため、データが何を表しているのかが明確になります。例えば、タプル (10, 20) だけでは、これが何を表しているのか不明ですが、Point(x=10, y=20) という形式にするとすぐに理解できます。

# 通常のタプル
data = (10, 20)

# インデックスでアクセス
print(data[0])  # 10

# namedtupleを使うと明確に
print(p.x)  # 10

3. 読み取り専用のデータ構造を扱うとき

namedtupleは不変のデータ構造（イミュータブル）です。データの変更が不要で、データの安全性を確保したいときに使えます。namedtupleを使えば、意図せずデータが変更されることを防ぐことができます。

p = Point(10, 20)
# p.x = 15  # エラー: namedtupleは変更不可

4. 辞書の代わりに使うとき

辞書もキーで値にアクセスできるデータ構造ですが、namedtupleはそれよりもメモリ効率が良く、データが固定されている場合にはパフォーマンスも優れています。フィールドの数が少ない場合や、データを変更する必要がない場合には、namedtupleは辞書よりも適しています。

from collections import namedtuple

# 辞書とnamedtupleの違い
person_dict = {"name": "John", "age": 30}
Person = namedtuple('Person', ['name', 'age'])
person_namedtuple = Person(name="John", age=30)

# 辞書でのアクセス
print(person_dict["name"])  # John

# namedtupleでのアクセス
print(person_namedtuple.name)  # John

5. 関数の戻り値として使う

複数の値を関数から返すとき、通常のタプルやリストを使うと戻り値の意味が不明瞭になります。namedtupleを使えば、戻り値に名前を付けて返すことができ、より可読性が高くなります。

from collections import namedtuple

# namedtupleを定義
Rectangle = namedtuple('Rectangle', ['width', 'height'])

# 関数でnamedtupleを返す
def get_rectangle():
    return Rectangle(100, 200)

# 戻り値に名前でアクセスできる
rect = get_rectangle()
print(rect.width)  # 100
print(rect.height)  # 200

6. 大規模なデータセットの効率的な管理

大量のデータを効率的に扱いたい場合にも、namedtupleは非常に有用です。通常のクラスよりも少ないメモリで済むため、大規模なデータ処理が必要な場合にパフォーマンスの改善が期待できます。

7. 複雑なクラス定義を避けたいとき

クラスを定義して使用するほどではないが、データに名前を付けてアクセスしたい場合にnamedtupleを使うことができます。これにより、クラス定義のオーバーヘッドを避けつつ、データ構造の明確さを保つことができます。

まとめ

namedtupleは、軽量なクラスや不変のデータ構造が必要なときに役立ちます。クラスほどの複雑さは不要だが、タプルや辞書では不便、あるいは非効率な場面で使うと、コードの可読性やメモリ効率が向上します。