コンテンツにスキップ
CodeMDD.io | Coding Tutorials

namedtupleの使い方とは何ですか？

[

Pythonicでクリーンなコードをnamedtupleで書く

Pythonのcollectionsモジュールは、namedtuple()と呼ばれるファクトリ関数を提供しています。これはタプルを扱う際によりPythonらしいコードを作成するために特別に設計されています。namedtuple()を使用すると、値を説明的なフィールド名とドット記法を使用してアクセスすることができるイミュータブルなシーケンス型を作成することができます。

Pythonを使用した経験がある場合、Pythonらしいコードを書くことはPython開発者にとっての基本的なスキルであることを知っているでしょう。このチュートリアルでは、namedtupleを使用してそのスキルを向上させます。

このチュートリアルでは、次のことを学ぶことができます:

  • namedtuple()を使用してnamedtupleクラスを作成する
  • namedtupleの便利な機能を見つけて活用する方法
  • namedtupleインスタンスを使用してPythonらしいコードを書く方法
  • namedtupleまたは類似のデータ構造のどちらを使用するかを決定する方法
  • 新しい機能を提供するためにnamedtupleをサブクラス化する方法

もし、このチュートリアルを始める前に必要な知識をすべて持っていない場合は、心配しないでください。必要に応じて上記のリソースを確認することができます。

namedtupleを使用してPythonicなコードを書く

Pythonのnamedtupleを使用すると、タプルをよりPythonらしい方法で使用することができます。namedtupleを使うと、タプルの各要素に固有の名前を付けることができます。これにより、コードがわかりやすくなり、可読性が向上します。以下はnamedtupleを使用してPythonicなコードを書く方法の例です:

from collections import namedtuple


# namedtupleクラスを作成する
Person = namedtuple("Person", ["name", "age", "country"])


# インスタンスを作成する
person1 = Person("Alice", 25, "USA")
person2 = Person("Bob", 30, "Canada")


# フィールド名を使用して値にアクセスする
print(person1.name)  # 出力: Alice
print(person2.country)  # 出力: Canada

以上の例では、namedtupleを使用してPersonという名前のクラスを作成し、name、age、countryのフィールド名を持つインスタンスを作成しています。その後、person1とperson2のインスタンスを作成し、フィールド名を使用してそれぞれの値にアクセスしています。このように、namedtupleを使用するとわかりやすいコードを書くことができます。

namedtupleでTuple-Likeクラスを作成する

namedtupleを使用すると、タプルと同様のクラスを作成できます。namedtupleクラスを作成する方法とオプションの引数を使用する方法について説明します。

namedtuple()に必須の引数を指定する

namedtuple()の最初の引数は、作成するクラスの名前です。2番目の引数は、クラスのフィールド名をリストまたは文字列として指定します。以下は、必須の引数を指定してnamedtupleクラスを作成する例です:

from collections import namedtuple


# namedtupleを作成する
Point = namedtuple("Point", ["x", "y"])


# インスタンスを作成する
point = Point(1, 2)


# フィールド名を使用して値にアクセスする
print(point.x)  # 出力: 1
print(point.y)  # 出力: 2

namedtuple()の最初の引数としてPointを指定し、2番目の引数として["x", "y"]を指定してnamedtupleクラスを作成しています。その後、pointのインスタンスを作成し、フィールド名を使用してxとyの値にアクセスしています。

namedtuple()でオプションの引数を使用する

namedtuple()では、オプションの引数を使用してさまざまな設定を行うこともできます。以下は、オプションの引数を使用してnamedtupleクラスを作成する例です:

from collections import namedtuple


# namedtupleを作成する
Car = namedtuple("Car", ["brand", "model"], defaults=[None])


# インスタンスを作成する
car1 = Car("Toyota", "Camry")
car2 = Car("Honda")


# フィールド名を使用して値にアクセスする
print(car1.brand)  # 出力: Toyota
print(car2.model)  # 出力: None

namedtuple()の第3引数であるdefaultsを使用することで、フィールドのデフォルト値を指定することができます。上記の例では、Carクラスのフィールドとしてbrandとmodelを指定し、defaultsを[None]として設定しています。その後、car1とcar2のインスタンスを作成し、フィールド名を使用して値にアクセスしています。car1のbrandには”Toyota”が、car2のmodelにはデフォルト値としてNoneが設定されています。

namedtupleクラスの追加機能の探索

namedtupleクラスにはさまざまな追加機能があります。以下では、namedtupleインスタンスを作成する方法、namedtupleインスタンスを辞書に変換する方法、既存のnamedtupleインスタンスのフィールドを置換する方法、さらにnamedtupleの追加の属性について説明します。

イテラブルからnamedtupleインスタンスを作成する

イテラブル（リストやタプルなど）からnamedtupleインスタンスを作成することもできます。以下はその例です:

from collections import namedtuple


# namedtupleを作成する
Person = namedtuple("Person", ["name", "age", "country"])


# イテラブルからインスタンスを作成する
person_data = ["Alice", 25, "USA"]
person = Person._make(person_data)


# フィールド名を使用して値にアクセスする
print(person.name)  # 出力: Alice
print(person.age)  # 出力: 25
print(person.country)  # 出力: USA

Person._make()メソッドを使用して、イテラブルからPersonのインスタンスを作成しています。person_dataはリストであり、[“Alice”, 25, “USA”]の値を持っています。その後、personのインスタンスを作成し、フィールド名を使用して値にアクセスしています。

namedtupleインスタンスを辞書に変換する

namedtupleインスタンスを辞書に変換することもできます。以下はその例です:

from collections import namedtuple


# namedtupleを作成する
Person = namedtuple("Person", ["name", "age", "country"])


# インスタンスを作成する
person = Person("Alice", 25, "USA")


# 辞書に変換する
person_dict = person._asdict()


# 辞書のキーと値を表示する
for key, value in person_dict.items():
    print(key, ":", value)

Person._asdict()メソッドを使用して、personのインスタンスを辞書に変換しています。その後、辞書のキーと値を表示しています。この方法を使用すると、namedtupleインスタンスのフィールド名と値を簡単に取得できます。

既存のnamedtupleインスタンスのフィールドを置換する

namedtupleのインスタンスはイミュータブルであるため、フィールドを直接変更することはできません。ただし、既存のインスタンスのフィールドを変更したい場合は、_replace()メソッドを使用することができます。以下はその例です:

from collections import namedtuple


# namedtupleを作成する
Person = namedtuple("Person", ["name", "age", "country"])


# インスタンスを作成する
person1 = Person("Alice", 25, "USA")


# フィールドを置換する
person2 = person1._replace(age=30)


# フィールド名を使用して値にアクセスする
print(person1.age)  # 出力: 25
print(person2.age)  # 出力: 30

person1のインスタンスを作成し、person1._replace(age=30)でageの値を置換してperson2のインスタンスを作成しています。その後、フィールド名を使用してperson1とperson2のageの値にアクセスしています。_replace()メソッドを使用すると、フィールドの一部を変更することができます。

追加のnamedtuple属性を探索する

namedtupleクラスにはさまざまな属性があります。以下はその一部です:

  • __doc__: ドキュメントの文字列を提供します。
  • _fields: フィールド名のタプルを提供します。
  • _fields_defaults: フィールド名とデフォルト値の辞書を提供します。
  • _field_types: フィールド名と型の辞書を提供します。

これらの属性にアクセスすることで、namedtupleクラスの詳細な情報を取得できます。

namedtupleを使用してPythonicなコードを書く

namedtupleを使用すると、タプルと同じようにフィールド名と値を関連付けて処理することができます。以下は、フィールド名をインデックスの代わりに使用し、複数の名前付き値を関数から返す方法、関数への引数の数を減らす方法、ファイルやデータベースから表形式のデータを読み取る方法についての例です。

インデックスの代わりにフィールド名を使用する

通常、タプルを使用するときには、インデックスを使用してタプルの値にアクセスします。しかし、namedtupleを使用すると、フィールド名を使用して値にアクセスすることができます。以下はその例です:

from collections import namedtuple


# namedtupleを作成する
Person = namedtuple("Person", ["name", "age"])


# インスタンスを作成する
person = Person("Alice", 25)


# インデックスの代わりにフィールド名を使用して値にアクセスする
print(person.name)  # 出力: Alice
print(person.age)  # 出力: 25

Personという名前のnamedtupleクラスを作成し、nameとageのフィールド名を持つインスタンスを作成しています。その後、フィールド名を使用してpersonの値にアクセスしています。これにより、コードがわかりやすくなり、可読性が向上します。

関数から複数の名前付き値を返す

通常、関数は1つの値を返しますが、namedtupleを使用すると複数の名前付き値（複数のフィールド）を返すことができます。以下はその例です:

from collections import namedtuple


# namedtupleを作成する
Person = namedtuple("Person", ["name", "age"])


def get_person():
    return Person("Alice", 25)


# 複数の名前付き値を返す関数を呼び出す
person = get_person()


# フィールド名を使用して値にアクセスする
print(person.name)  # 出力: Alice
print(person.age)  # 出力: 25

get_person()関数はPersonのインスタンスを返します。person変数には関数の返り値が代入されています。その後、フィールド名を使用してpersonの値にアクセスしています。このように、複数の値を1つの変数にまとめる代わりに、namedtupleを使用して複数の名前付き値を返すことができます。

関数の引数の数を減らす

通常、関数には複数の引数がありますが、namedtupleを使用すると関数の引数の数を減らすことができます。以下はその例です:

from collections import namedtuple


# namedtupleを作成する
Rect = namedtuple("Rect", ["x1", "y1", "x2", "y2"])


def calculate_area(rect):
    return (rect.x2 - rect.x1) * (rect.y2 - rect.y1)


# インスタンスを作成する
rectangle = Rect(0, 0, 10, 10)


# 関数にインスタンスを渡す
area = calculate_area(rectangle)


# 面積を表示する
print(area)  # 出力: 100

Rectという名前のnamedtupleクラスを作成し、x1、y1、x2、y2のフィールド名を持つインスタンスを作成しています。その後、calculate_area()関数にrectangleのインスタンスを渡し、引数として使用して面積を計算しています。この方法を使用すると、関数の引数の数を減らし、コードをよりスッキリと読みやすくすることができます。

ファイルやデータベースから表形式のデータを読み取る

namedtupleを使用すると、ファイルやデータベースから行単位の表形式のデータを簡単に読み取ることができます。以下はその例です:

from collections import namedtuple


# namedtupleを作成する
Person = namedtuple("Person", ["name", "age", "country"])


# データをリストとして持つ
data = [
    ("Alice", 25, "USA"),
    ("Bob", 30, "Canada"),
    ("Charlie", 35, "UK")
]


# データをnamedtupleのリストに変換する
people = [Person(*row) for row in data]


# データを表示する
for person in people:
    print(person.name, person.age, person.country)

data変数には、タプルのリストが含まれています。各タプルは1つの行を表し、各要素は列の値を表します。その後、リスト内包表記を使用して、Personのインスタンスを作成し、peopleリストに追加しています。最後に、peopleの各要素を反復処理して表示しています。この方法を使用すると、ファイルやデータベースから読み取った表形式のデータを簡単に扱うことができます。

namedtupleと他のデータ構造の比較

namedtupleはPythonの標準ライブラリに含まれている便利なデータ構造ですが、他のデータ構造と比較してメリットや適用範囲があります。以下では、namedtupleを辞書やデータクラス、typing.NamedTupleと比較して説明します。

辞書との比較

namedtupleと辞書はどちらもキーと値のペアを持つデータ構造ですが、いくつかの重要な違いがあります。辞書は順序を持たず、キーを使用して値にアクセスします。一方、namedtupleは順序を持ち、フィールド名を使用して値にアクセスします。以下は例です:

from collections import namedtuple


# namedtupleを作成する
Person = namedtuple("Person", ["name", "age"])


# インスタンスを作成する
person = Person("Alice", 25)


# フィールド名を使用して値にアクセスする
print(person.name)  # 出力: Alice
print(person.age)  # 出力: 25


# 辞書としてもアクセスできる
person_dict = person._asdict()
print(person_dict["name"])  # 出力: Alice
print(person_dict["age"])  # 出力: 25

person_dict = person._asdict()のようにnamedtupleインスタンスを辞書に変換することもできますが、辞書として元の順序情報が失われることに注意してください。

データクラスとの比較

dataclassesモジュールを使用してデータクラスを作成すると、namedtupleと似たデータ構造を作成することもできます。データクラスはフィールドとメソッドを持つイミュータブルなクラスです。以下はnamedtupleとデータクラスを比較した例です:

from collections import namedtuple
from dataclasses import dataclass


# namedtupleを作成する
PersonTuple = namedtuple("PersonTuple", ["name", "age"])


# データクラスを作成する
@dataclass(frozen=True)
class PersonDataClass:
    name: str
    age: int


# インスタンスを作成する
person_tuple = PersonTuple("Alice", 25)
person_dataclass = PersonDataClass("Alice", 25)


# フィールド名を使用して値にアクセスする
print(person_tuple.name)  # 出力: Alice
print(person_dataclass.name)  # 出力: Alice

PersonTupleはnamedtupleを作成し、PersonDataClassはデータクラスを作成しています。両方のインスタンスを使用して値にアクセスするには、フィールド名を使用します。

typing.NamedTupleとの比較

typingモジュールのNamedTupleクラスを使用すると、型ヒントを持つnamedtupleクラスを作成することができます。以下はその例です:

from typing import NamedTuple


# NamedTupleを作成する
class Person(NamedTuple):
    name: str
    age: int


# インスタンスを作成する
person = Person("Alice", 25)


# フィールド名を使用して値にアクセスする
print(person.name)  # 出力: Alice
print(person.age)  # 出力: 25

NamedTupleを使用してPersonクラスを作成し、フィールド名と型を指定しています。その後、personのインスタンスを作成し、フィールド名を使用して値にアクセスしています。

namedtupleクラスのサブクラス化

namedtupleクラスをサブクラス化することもできます。サブクラス化により、新しいフィールドやメソッドを追加することができます。以下はその例です:

from collections import namedtuple


# namedtupleを作成する
Person = namedtuple("Person", ["name", "age"])


# サブクラスを作成する
class VIPPerson(Person):
    def __str__(self):
        return f"VIP: {self.name}"


# インスタンスを作成する
person = VIPPerson("Alice", 25)


# オーバーライドしたメソッドを呼び出す
print(person)  # 出力: VIP: Alice

Personのnamedtupleクラスを作成し、VIPPersonのサブクラスを作成しています。VIPPersonクラスでは、__str__()メソッドをオーバーライドして、インスタンスを表す文字列を返すようにしています。その後、VIPPersonのインスタンスを作成し、__str__()メソッドを呼び出して文字列を表示しています。

tupleとnamedtupleの作成時間の計測

turpleとnamedtupleの作成時間を比較するために、以下のコードを実行してみましょう:

import timeit
from collections import namedtuple


# namedtupleを作成する
Person = namedtuple("Person", ["name", "age"])


# turpleを作成する
def create_tuple():
    return ("Alice", 25)


# namedtupleの作成時間を計測する
nt_time = timeit.timeit("create_namedtuple()", setup="from __main__ import create_namedtuple", number=1000000)


# turpleの作成時間を計測する
t_time = timeit.timeit("create_tuple()", setup="from __main__ import create_tuple", number=1000000)


# 結果を表示する
print(f"namedtupleの作成時間: {nt_time}秒")
print(f"turpleの作成時間: {t_time}秒")

timeitモジュールを使用して、namedtupleとturpleの作成時間を計測します。namedtupleとturpleの作成関数を定義し、timeit.timeit()関数を使用してそれぞれの作成時間を計測しています。実行結果では、namedtupleとturpleの作成時間を比較しています。

まとめ

namedtupleを使用すると、タプルをよりPythonらしい方法で使用することができます。以下は、このチュートリアルで学んだ主なポイントです:

  • namedtupleを使用すると、フィールド名を使用してタプルの値にアクセスすることができます。
  • namedtupleインスタンスの作成、エンコードとデコード、フィールドの置換など、さまざまな操作が可能です。
  • namedtupleを使用することで、Pythonicなコードを書くことができます。
  • namedtupleは辞書やデータクラス、typing.NamedTupleと比較して、メリットや適用範囲があります。

namedtupleはPythonの開発者にとって非常に便利なデータ構造であり、Pythonらしいコードを書くための重要なツールです。ぜひnamedtupleを使ってみて、Pythonのコーディング経験を向上させてください。