namedtuple（collectionsモジュール）

Python の代表的な型であるタプル (tuple) では、[] で位置を指定して値を取得したり、アンパック代入で変数に代入したりして使うことができます。

しかし、要素数が多くなると、どの位置に何の情報が入っているかが分かりにくくなります。このような時、各値に名前付きでアクセスできると便利です。このような場合には、collections モジュールの namedtuple が使用できます。

この記事では、collections モジュールの namedtuple について基本的な使い方を紹介します。また、使いどころや特徴についても説明します。

namedtuple の定義と使い方

namedtuple の定義と使い方を、以下の例で見ていきましょう。

import collections

# named tupleの定義
Point = collections.namedtuple("Point", ["x", "y"])

# インスタンス化
p1 = Point(10, 20)
p2 = Point(x=30, y=40)
print(f"p1 = {p1}")
print(f"p2 = {p2}")

# フィールド名で値へアクセス
print(f"p1.x = {p1.x}, p1.y = {p1.y}")
print(f"p2.x = {p2.x}, p1.y = {p2.y}")

# アンパック代入
x1, y1 = p1
x2, y2 = p2
print(f"x1 = {x1}, y1 = {y1}")
print(f"x2 = {x2}, y2 = {y2}")

【実行結果】
p1 = Point(x=10, y=20)
p2 = Point(x=30, y=40)
p1.x = 10, p1.y = 20
p2.x = 30, p1.y = 40
x1 = 10, y1 = 20
x2 = 30, y2 = 40

上記のサンプルプログラムについてポイントを説明していきます。

import collections

まず、namedtuple を使うには collections モジュールのインポートが必要です。

# named tupleの定義
Point = collections.namedtuple("Point", ["x", "y"])

namedtuple の定義では、タイプの名前とフィールドの名前を定義します。例では、"Point" という名前のタイプを定義し、フィールドとして "x"、"y" という名前のフィールドを定義しています。

# インスタンス化
p1 = Point(10, 20)
p2 = Point(x=30, y=40)
print(f"p1 = {p1}")
print(f"p2 = {p2}")

定義した namedtuple をインスタンス化するためには上記のようにします。"x"、"y" に該当する値を順に引数に渡してもよいですし、「x=」「y=」のように設定したフィールド名のキーワード引数として指定も可能です。

# フィールド名で値へアクセス
print(f"p1.x = {p1.x}, p1.y = {p1.y}")
print(f"p2.x = {p2.x}, p1.y = {p2.y}")

値にアクセスする場合には、インスタンス化した変数に対して「.」(ドット) で各フィールド名を指定してアクセスができます。

# アンパック代入
x1, y1 = p1
x2, y2 = p2
print(f"x1 = {x1}, y1 = {y1}")
print(f"x2 = {x2}, y2 = {y2}")

また、namedtuple は名前付きのタプルですので通常のタプルと同様にアンパック代入によって値を取り出してデータを扱うことも可能です。

以上が、namedtuple の基本的な使い方です。以降では、namedtuple で使用できる便利な各種メソッドについて紹介します。

namedtuple の各種メソッド

namedtuple では便利な各種メソッドが用意されています。namedtuple のメソッド名は、フィールド名との衝突を避けるために「_　(アンダースコア)」で始まる名前となっています。

一般的には _(アンダースコア) がついた変数やメソッドは、慣例としてクラス内のみで参照・使用される変数やメソッドというプライベートの意味があります（ただし、外部からのアクセスは可能です）。namedtuple は外部から使うメソッドとして定義されていることを覚えておいてください。

_make で新しい namedtuple を作成する

既存リストから namedtuple を作成する場合には、_make メソッドを使用します。

import collections

Point = collections.namedtuple("Point", ["x", "y"])

data = [10, 20]
p_data = Point._make(data)
print(f"p_data = {p_data}")
print(p_data.x, p_data.y)

【実行結果】
p_data = Point(x=10, y=20)
10 20

Point という定義を作る点は基本的な使い方で紹介した通りですが、例では data というリストの値をもとに namedtuple のインスタンス p_data を作成しています。

_asdict で namedtuple を辞書に変換する

namedtuple を辞書に変換して使用したい場合は、_asdict メソッドを使用します。

import collections

Point = collections.namedtuple("Point", ["x", "y"])

p1 = Point(10, 20)
p_dict = p1._asdict()

print(type(p_dict))
print(p_dict)
print(p_dict["x"])
print(p_dict["y"])

【実行結果】
<class 'dict'>
{'x': 10, 'y': 20}
10
20

_asdict() の返却値を type で確認すると dict となっていることが分かります。このように dict へ簡単に変換して扱うことができます。

_replace で一部の値を変更した新しい namedtuple を作成する

作成した namedtuple をもとに一部の値を変更した新しい namedtuple のインスタンスを作成する場合には、_replace メソッドを使用します。

import collections

Point = collections.namedtuple("Point", ["x", "y"])

p1 = Point(10, 20)

# p1のxの値を置き換える
print(p1._replace(x=50))
# p1の値が書き換わるわけではないので注意
print(p1, "\n")

# 値を書き換えた場合は別のインスタンスに代入する
p2 = p1._replace(x=50)
print(f"p1 = {p1}")
print(f"p2 = {p2}")

【実行結果】
Point(x=50, y=20)
Point(x=10, y=20)

p1 = Point(x=10, y=20)
p2 = Point(x=50, y=20)

タプルはイミュータブルで変更不可なものなので、_replace メソッドは既存の namedtuple そのものの値を置き換えるわけではなく、値を置き換えた namedtuple のインスタンスの変数を返却することに注意してください。

_fields によりフィールド名を取得する

namedtuple のフィールド名を取得するには、_fields メソッドを使用します。

import collections

Point = collections.namedtuple("Point", ["x", "y"])

p1 = Point(10, 20)
print(p1._fields)

【実行結果】
('x', 'y')

上記のように返却値は、フィールド名が列挙されたタプルで返却されます。

namedtuple の使いどころ

CSV ファイルの読み込みに使用する

namedtuple の使いどころとしてよく紹介される CSV ファイルの読み込みについて例を使って紹介します。

import collections
import csv

# CSVファイルを作成して保存する
with open("temp.csv", "w", newline="", encoding="UTF-8") as csv_write:
    fields = ["index", "value1", "value2", "value3"]
    writer = csv.DictWriter(csv_write, fieldnames=fields)

    writer.writeheader()
    for i in range(1, 6):
        writer.writerow(
            {
                "index": i,
                "value1": f"val1-{i}",
                "value2": f"val2-{i}",
                "value3": f"val3-{i}",
            }
        )

# CSVファイルをnamedtupleに読み込む
with open("temp.csv", "r", encoding="UTF-8") as csv_read:
    csv_reader = csv.reader(csv_read)

    # namedtupleを定義する（CSVの1行目を列名として定義）
    record = collections.namedtuple("record", next(csv_reader))
    # CSVのレコードを順次読み込む (namedtupleで1行を読み込む)
    data = [record._make(row) for row in csv_reader]

print(data)
# 1行目のデータに列名でアクセスする
print(data[0].index)
print(data[0].value1)
print(data[0].value2)
print(data[0].value3)

【実行結果】
[record(index='1', value1='val1-1', value2='val2-1', value3='val3-1'), record(index='2', value1='val1-2', value2='val2-2', value3='val3-2'), record(index='3', value1='val1-3', value2='val2-3', value3='val3-3'), record(index='4', value1='val1-4', value2='val2-4', value3='val3-4'), record(index='5', value1='val1-5', value2='val2-5', value3='val3-5')]
1
val1-1
val2-1
val3-1

この例では、まずサンプルの CSV を作成して temp.csv で書き込み、作ったデータを namedtuple に読み込んでいます。

CSV ファイルを読み込む際には、CSV ファイルの列名を namedtuple で定義しておき、データを読み込む際に namedtuple に設定することで、その後データに列名で参照することができます。

next(csv_reader) の部分で、CSV のヘッダーの列名情報を取得できるため、その値を使って "record" という namedtuple を定義しています。その後、データを読み込む際には、リスト内包表記を使って _make メソッドで namedtuple にして data というリストを作成しています。

データへのアクセスは、列名である「index」「value1」「value2」「value3」を用いて直接それぞれにアクセスできていることが分かると思います。このようにしておくことで読み込んだデータ列を指定してデータを扱うことが容易になります。

関数の戻り値で使用する

関数の戻り値として複数の戻り値を返却する場合は、返却値が編集されてしまわないようにイミュータブルなタプルに返却値に設定するのが基本です。その際に、どれが何の値なのかを明示するために namedtuple を使うと便利です。

以下の例の calculate_stat 関数は、入力された数値リストの最小値、最大値、平均、分散、標準偏差を計算して返却する関数です。

※ 本来このままだど data に数値以外が入ってくるとエラーになるため問題がありますが、namedtuple の返却例ということで細かなチェック等を割愛しています。

import collections
import statistics


def calculate_stat(data):
    min_v = min(data)
    max_v = max(data)
    mean_v = statistics.mean(data)
    var_v = statistics.variance(data)
    std_v = statistics.stdev(data)

    # 返却値をnamedtupleで定義
    Stat = collections.namedtuple("Stat", ["min", "max", "mean", "var", "std"])
    stats = Stat(min_v, max_v, mean_v, var_v, std_v)
    return stats


def main():
    values = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]
    result = calculate_stat(values)
    print(
        f"min:{result.min}, "
        f"max:{result.max}, "
        f"mean:{result.mean}, "
        f"var:{result.var}, "
        f"std:{result.std}"
    )


if __name__ == "__main__":
    main()

【実行結果】
min:1, max:15, mean:8, var:20, std:4.47213595499958

例では、返却値を "Stat" というタイプの namedtuple にまとめて返却しています。

通常のタプルで返却すると、何番目に最小値が入ってくるかといったことを覚えていないといけませんが、namedtuple を使用することで、呼び出した側は最小値なら min、最大値なら max といったように直感的に返却値を扱うことができます。

このように関数の戻り値として namedtuple を使用することがあります。

namedtuple の特徴

namedtuple の定義や使い方について見てきました。ここでは namedtuple の特徴について紹介します。

namedtuple と辞書（dict）の違い

これまでの使用例で、namedtuple が Python 標準のタプル（tuple）よりも理解しやすく、扱いやすいということはご理解いただけたかと思います。しかし、同じことはPython 標準の辞書（dict）でも可能です。

namedtuple と辞書（dict）で異なる点は以下のような点です。

• namedtuple はタプルの一種のため、変更不可（イミュータブル）であり、内部の長さは必要サイズに固定されている。一方で、辞書（dict）は必要な領域を余分に確保しているためメモリ使用効率は namedtuple の方が良い。
• namedtuple は、添え字でもアクセス可能でこの操作は高速に実行できる。辞書（dict）は内部構造としてハッシュテーブルの探索が必要となり最悪のケースでは遅くなる可能性がる。

パフォーマンスが要求されるようなコードの部分では添え字のインデックスを使ってアクセスすることで応答性を確保し、その他の場面では属性名でアクセスできる利便性を享受するといったことができる点が namedtuple の特徴です。

まとめ

名前付きでタプルにアクセスできる collections モジュールの namedtuple について解説しました。

名前付きタプルは、タプルの各要素に名前でアクセスできるため、CSV ファイルの読み込みに使用したり、関数の戻り値で使用したりする際に便利です。各種メソッドも用意されており、この記事で代表的なメソッドを紹介しています。

namedtupleは、辞書でキーにアクセスすることと似ていますが、namedtuple はタプルの 1 種のためイミュータブルで内部のメモリ使用効率が良くなります。また、namedtuple は添え字によるアクセスも可能で、この操作はアクセスが高速なため状況によって使い分けるといったこともできます。

名前付きでアクセスできる namedtuple は便利な面が多いため、状況によって使用を検討してみてください。

あわせて読みたい

【Python Tech】プログラミングガイド

タプルの特徴と基本的な使い方

Pythonのタプル（tuple）とは、リストと同様で任意の要素を集めて列挙したシーケンスです。

この記事では、タプルの特徴や作成方法など基本的な点について説明していきます。

タプル（tuple）の特徴

タプルは、リストに非常に似ていますがイミュータブル（immutable）であるという点が異なっています。

イミュータブル（immutable）は、変更不可を意味します。一方で、リスト等のように値の変更が可能であることをミュータブル（mutable）と言います。

この特徴のため、タプルは一度生成したら要素追加や値の変更といった変更操作ができません。一方で、リストであれば値を変更したり、appendメソッドで要素を追加したりできます。

タプル（tuple）の基本的な使い方

タプル作成と要素へのアクセス

タプル（tuple）の基本的な使い方を見ていきましょう。タプルを作成するには以下のように()で要素を順番に列挙します。

# タプルの作成方法
tpl = ('A', 'B', 'C')
print(type(tpl))
print(f'tpl: {tpl}')
print(tpl[0], tpl[1], tpl[2])

【実行結果】
<class 'tuple'>
tpl: ('A', 'B', 'C')
A B C

タプルの各要素にアクセスするにはリストと同様に[]でアクセスできます。（位置は0から始まりますので注意しましょう）

括弧なしでタプルを作成する

タプルは、以下のように括弧「()」なしで、「,」(カンマ)で要素を列挙するだけでも作成できます。

# ()がなくてもタプルとして作成される
tpl = 'A', 'B', 'C'
print(type(tpl))
print(f'tpl: {tpl}')

【実行結果】
<class 'tuple'>
tpl: ('A', 'B', 'C')

上記結果を見ると分かるようにタプルで作成されていることが分かると思います。括弧なしでもタプルと認識されますが、明示的に括弧を使用することが推奨されます。ここでは、()を用いなくてもタプルとして扱われるということを覚えておいてください。

タプルのアンパック

アンパックの基本的な考え方

タプルの要素は、以下例のように異なる変数に簡単に代入することができます。このような方法をタプルのアンパック（またはアンパック代入）と言います。

# タプルのアンパック
tpl = ('A', 'B', 'C')
a, b, c = tpl
print(f'a = {a}, b = {b}, c = {c}')

【実行結果】
a = A, b = B, c = C

変数を列挙した定義はタプルのアンパック

Pythonを勉強を始めると、以下のように変数を列挙して値を代入できることを知ります。実は、これはタプルのアンパックをしています。

a, b, c = 'A', 'B', 'C'
print(f'a = {a}, b = {b}, c = {c}')

【実行結果】
a = A, b = B, c = C

上記例において「a, b, c = 'A', 'B', 'C'」の右側はタプルとなっています。上記で()がなくてもタプルとして生成されるということを紹介したことを思い出してください。つまり、このコードの実態としては、タプルが生成されて、アンパックされたうえで各変数に代入されているという動きとなっています。

アンパックを利用した値の交換

タプルのアンパックを使うと、以下のように要素の交換を簡単に実施できます。

data1 = "A"
data2 = "B"
print(
    f"data1: {data1}, id(data1): {id(data1)}, "
    f"data2: {data2}, id(data2): {id(data2)}"
)

# 要素の交換
data1, data2 = data2, data1
print(
    f"data1: {data1}, id(data1): {id(data1)}, "
    f"data2: {data2}, id(data2): {id(data2)}"
)

【実行結果】
data1: A, id(data1): 1234656225968, data2: B, id(data2): 1234655913072
data1: B, id(data1): 1234655913072, data2: A, id(data2): 1234656225968

※ 上記例のid値の部分は実行ごとに変わりますのでご注意ください。

上記結果では、値とidを表示していますが、data1とdata2の内容がしっかりと交換できていることが分かります。

タプルの使いどころ

値が変更されたくないときに利用する

タプルがリストと違って特徴的なところは、イミュータブル（immutable）であることです。

この特徴から、プログラム上で変更されたくない項目を管理する場合にタプルを使用することがおすすめされます。例えば以下のようなケースが考えられます。

• 関数の戻り値：関数が複数の値を返却する際に、タプルでまとめるのは便利です。例えば、座標(x, y)のペアや複数の計算結果を返すときなどが該当します。
• 変更されるべきではない値の管理：日付や設定値のように変更する必要がないデータをタプルで保持することで誤った変更を防ぐことができます。
• キーとしての使用：タプルはハッシュ可能であるため、辞書のキーとして使用できます。例えば、座標(x, y)に対応する値を管理する辞書などが典型的な例です。

名前付きタプル（namedtuple）

上記で紹介したようにタプルは関数の戻り値で複数項目を返却する場合に便利です。しかし、どの要素に何が入っているのかが分かりにくいという欠点もあります。

そのような際には、collectionsモジュールの名前付きタプル（namedtuple）の使用を検討してみてください。namedtupleは、項目に名前を付けることでアクセスが容易になります。

namedtupleについては「namedtupleで名前付きタプルを使用する」を参考にしてください。

まとめ

Pythonのタプル（tuple）の基本と使いどころについて解説しました。

タプルは、イミュータブル（immutable）で変更不可能であるというのが特徴です。この記事では、タプルの基本的な作成方法やアンパックの考え方を紹介しました。

タプルは、変更不可であることが特徴です。この特徴からプログラム実行中に変更されたくないような設定値等に使うことが便利です。

タプルは、リストや辞書などと同様にPythonプログラミングにおける代表的なものですので、特徴をしっかりと理解して使いこなせるようになってもらいたいと思います。

あわせて読みたい

【Python Tech】プログラミングガイド