Python 3: Deep Dive (Part 1 - Functional): 変更、拡張、デフォルト (セクション8-3/11)
Named Tupleは不変だが、`_replace()`メソッドで新しいインスタンスを作成して値を変更可能。
`_fields`プロパティを使ってフィールドを拡張し、新しいNamed Tupleを効率的に作成できる。
デフォルト値の設定には、プロトタイプインスタンスや`defaults`プロパティの利用が効果的。
前回のPythonのnamed tupleに関するディープダイブでは、named tupleがいかに自己記述的で不変なデータ構造を作成するのに優れた方法を提供するかを探りました。named tupleは、クラスの可読性とタプルのパフォーマンスと不変性を維持することができます。
今回のブログでは、named tupleを変更・拡張するための高度なテクニックと、デフォルト値の設定やドキュメンテーション文字列（docstring）のカスタマイズを学びます。これらのテクニックを使用することで、複雑なデータ構造を扱う際のコードをよりクリーンでメンテナブルにすることができます。
Named Tupleの変更
不変性に関する課題
named tupleは通常のタプルと同様に不変です。これは、既存のnamed tupleをその場で変更することができないことを意味します。何らかの「変更」を行う場合、新しいnamed tupleインスタンスを作成する必要があります。
例えば、`Point2D`というnamed tupleがあるとしましょう。
from collections import namedtuple
Point2D = namedtuple('Point2D', 'x y')
point = Point2D(0, 0)`x`座標を変更しようとした場合
point.x = 10 # AttributeErrorが発生しますこれは`point`が不変であるため、`AttributeError`を引き起こします。
`_replace()` メソッド
named tupleを「変更」する最も効率的で読みやすい方法は、`_replace()`メソッドを使用することです。このメソッドは、指定されたフィールドを新しい値で置き換えて新しいnamed tupleインスタンスを作成します。
new_point = point._replace(x=10)
print(new_point) # 出力: Point2D(x=10, y=0)複数のフィールドを一度に置き換えることも可能です。
new_point = point._replace(x=10, y=20)
print(new_point) # 出力: Point2D(x=10, y=20)なぜスライシングやアンパッキングを使わないのか？
named tupleをスライシングやアンパッキングで変更しようとすることもできますが、多くのフィールドを持つタプルの場合は扱いにくくなります。
例えば、`Stock`というnamed tupleを考えてみましょう。
Stock = namedtuple('Stock', 'symbol year month day open high low close')
djia = Stock('DJIA', 2021, 12, 31, 36000, 36100, 35900, 36050)`close`の値を変更する場合、スライシングを使うと以下のようになります。
djia_list = list(djia)
djia_list[-1] = 36100 # close値を変更
new_djia = Stock(*djia_list)この方法はエラープローンで読みづらいですが、`_replace()`を使うとシンプルになります。
new_djia = djia._replace(close=36100)Named Tupleの拡張
`_fields`プロパティを使用
既存のnamed tupleにフィールドを追加して新しいnamed tupleクラスを作成したい場合があります。
例えば、`Point2D`を`Point3D`に拡張して`z`座標を追加したいとします。すべてのフィールドを再定義するのではなく、`_fields`プロパティを利用できます。
Point3D = namedtuple('Point3D', Point2D._fields + ('z',))これで、`Point3D`は`('x', 'y', 'z')`というフィールドを持つようになります。
追加フィールドを持つ新しいインスタンスの作成
既存のインスタンスをアンパックして新しい値を追加することで、拡張されたnamed tupleのインスタンスを作成できます。
point2d = Point2D(10, 20)
point3d = Point3D(*point2d, 30)
print(point3d) # 出力: Point3D(x=10, y=20, z=30)複雑なNamed Tupleの拡張
より複雑なnamed tuple、例えば`Stock`の場合、`_fields`を使用することでさらに便利です。
StockExt = namedtuple('StockExt', Stock._fields + ('previous_close',))これで`StockExt`は、`Stock`のすべてのフィールドに加えて`previous_close`を持つようになります。
新しいインスタンスの作成:
djia_ext = StockExt(*djia, 35950)
print(djia_ext)
# 出力: StockExt(symbol='DJIA', year=2021, month=12, day=31, open=36000, high=36100, low=35900, close=36050, previous_close=35950)デフォルト値の設定
Named tupleでは、フィールド定義時にデフォルト値を設定することはできません。しかし、デフォルト値を設定するための2つの主要なテクニックがあります。
プロトタイプインスタンスを使用する方法
`defaults`プロパティを使用する方法
プロトタイプインスタンスの使用
プロトタイプインスタンスとは、すべてのフィールドにデフォルト値を設定したnamed tupleのインスタンスです。新しいインスタンスを作成する際に、このプロトタイプインスタンスを使って`_replace()`で特定のフィールドを置き換えます。
例
Vector2D = namedtuple('Vector2D', 'x1 y1 x2 y2 origin_x origin_y')
# デフォルト値を持つプロトタイプを作成
vector_zero = Vector2D(0, 0, 0, 0, 0, 0)
# _replace()を使って新しいインスタンスを作成
vector = vector_zero._replace(x1=10, y1=10, x2=20, y2=20)
print(vector)
# 出力: Vector2D(x1=10, y1=10, x2=20, y2=20, origin_x=0, origin_y=0)メリットとデメリット
メリット
共通のデフォルト値を持つ場合に便利。
デメリット
すべてのフィールドにデフォルト値を設定する必要がある。
標準的なインスタンス化に比べて直感的ではない。
__defaults__プロパティを使用
__defaults__プロパティは`new`メソッドのデフォルト値を設定するためのものです。
例
# Named tupleを定義
Vector2D = namedtuple('Vector2D', 'x1 y1 x2 y2 origin_x origin_y')
# 最後の2つのパラメータにデフォルト値を設定
Vector2D.__new__.__defaults__ = (0, 0)
# origin_xとorigin_yを指定せずにインスタンス化できるようになる
vector = Vector2D(10, 10, 20, 20)
print(vector)
# 出力: Vector2D(x
1=10, y1=10, x2=20, y2=20, origin_x=0, origin_y=0)メリットとデメリット
メリット
直感的でクリーンなコードになる。
すべてのフィールドにデフォルト値を設定する必要がない。
デメリット
あまり知られていないテクニック。
クラスコンストラクタを直接変更する。
重要な注意点
デフォルト値は右側のパラメータに適用されます。
デフォルト値を持つパラメータの後に、デフォルト値を持たないパラメータを配置することはできません。
`defaults`プロパティはタプルで設定する必要があります。
ドキュメンテーション文字列のカスタマイズ
デフォルトでは、named tupleは一般的なdocstringを生成しますが、これをカスタマイズすることでコードの可読性と保守性を向上させることができます。
クラスDocstringのカスタマイズ
Point2D.__doc__ = '2Dデカルト座標を表します。'フィールドDocstringのカスタマイズ
Point2D.x.__doc__ = 'x座標。'
Point2D.y.__doc__ = 'y座標。'更新されたヘルプの確認
help(Point2D)これにより、カスタマイズされたdocstringがヘルプ出力に表示されます。
結論
Named tupleは、Pythonで非常に柔軟で強力な機能を提供し、不変性、可読性、効率性を兼ね備えています。変更、拡張、デフォルト値の設定のテクニックをマスターすることで、クリーンで保守性が高く自己記述的なコードを作成することが可能です。
シンプルなデータポイントから複雑なデータ構造まで、named tupleを使用することでコードのシンプルさとエラーの削減を実現できます。`_replace()`メソッドを変更に使用し、`_fields`プロパティを拡張に活用し、`defaults`プロパティでデフォルト値を設定することを忘れないでください。
Happy coding!
参考文献:
Python Documentation on collections.namedtuple
この記事が気に入ったらサポートをしてみませんか？