Python Attrs:高度なデータクラスとサンプルコード

パッケージ Python Attrs を使用すると、単純な注釈を使用して高度なデータクラスを作成できます。もちろん、python にも独自のネイティブデータクラスモジュールがありますが、Python attrs パッケージには、お好みの追加機能がいくつか用意されています!

属性をインストール

attrs パッケージはベースライブラリの一部ではないため、pip install コマンドまたは Pipenv などの同様のものを使用してインストールする必要があります。他のプロジェクトに干渉しないように、仮想環境も作成する必要があるでしょう。このパッケージは attrs という名前なので、インストールは次のようになります:

$ pip install attrs

# or with pipenv:
$ pipenv install attrs

属性とデータクラス

attrs の作者実際、Python にデータクラスを導入した PEP に取り組んでいます。 Python のネイティブデータクラスは意図的に単純化され、理解しやすくなっていますが、属性は必要な機能をすべて提供しています!

Python attrs を選択するいくつかの理由組み込みのデータクラスは次のとおりです。

3.7 より前のバージョンの Python を使用しています。 Attrs は、CPython 2.7 や PyPy を含むすべての主流の Python バージョンをサポートしているため、あなたをカバーしています。
より多くの機能が必要:attrs はバリデーターとコンバーターを提供します
attrs スロットクラスを使用して、最適なパフォーマンスと最小限のメモリ使用量が必要

基本的な Python 属性の例

最初に非常に基本的な例を見てみましょう:

import attr

@attr.s
class Person(object):
    name = attr.ib(default='John')
    surname = attr.ib(default='Doe')
    age = attr.ib(init=False)
    
p = Person()
print(p)
p = Person('Bill', 'Gates')
p.age = 60
print(p)

# Output: 
#   Person(name='John', surname='Doe', age=NOTHING)
#   Person(name='Bill', surname='Gates', age=60)

いくつかの観察:

構文はデータクラスの構文よりも洗練されておらず、冗長ですが、代わりに追加の機能を利用できます。
データクラスと同様に、データを印刷すると適切にフォーマットされた表現が得られます。
attrs パッケージは、attr.ib のようなスマートに選択された名前を使用しますであるため、attr をインポートするだけで済みます。または、氏名をインポートすることもできます。たとえば from attr import attrib, attrs の場合、代わりにそれらの名前を使用します。機能は同じです。

次に、通常のデータクラスよりもこのパッケージが提供する最も重要な機能であるバリデーターとコンバーターを見てみましょう。

Python 属性バリデーターの例

次の 2 つの方法で、属性データクラスにバリデータを追加できます。

<オール>

デコレータの使用

呼び出し可能な関数を提供する

ここではまず、呼び出し可能な関数メソッドを示します。 Attrs はすぐに使用できるいくつかのバリデーターを提供します。そのうちの instance_of を使用します次の例のバリデータ:

>>> @attr.s
... class C(object):
...     x = attr.ib(validator=attr.validators.instance_of(int))
>>> C(42)
C(x=42)
>>> C("a string")

Traceback (most recent call last):
   ...
TypeError: ("'x' must be <type 'int'> (got 'a string' that is a <type 'str'>).", ...

x の文字列値でオブジェクト C を作成しようとしたため、文字列ではなく int 型が必要なため、instance_of バリデーターはエラーをスローします。

独自のバリデータを定義しましょう:

import attr

@attr.s
class DividableByTwo(object):
    x = attr.ib()

    @x.validator
    def check(self, attribute, value):
        if value % 2 != 0:
            raise ValueError(f'{value} is not dividable by 2')

print (DividableByTwo(60))
print (DividableByTwo(11))

# Output will be something like:
# DividableByTwo(x=60)
# ...
# ValueError: 11 is not dividable by 2

Python 属性コンバーターの例

コンバーターは、設定された値を取得して自動的に変換します。これはあらゆる種類の目的に使用できます。 1 つの例は、値を int に自動的に変換することです。繰り返しますが、呼び出し可能な関数の使用から始めましょう。この場合、単純に Python の int() 関数を使用します:

import attr

@attr.s
class C(object):
    x = attr.ib(converter=int)

c = C("1")
print(c)
# Output:
# C(x=1)

入力 (文字列「1」) は自動的に整数に変換されました。コンバーターはバリデーターの前に実行されるため、変換後に最終的な値を検証できます。たとえば、上記の 2 つの例では、最初に入力を int に変換してから、値が 2 で割り切れるかどうかを確認できます。

Python 属性でスロットを使用する

最後に、attrs にスロットクラスを使用するように指示できます。スロットクラスには、通常のクラスよりもいくつかの利点があります:

メモリ使用量が少ない
速い

要するに、スロット化されたクラスを使用して、オブジェクトインスタンスが持つと予想されるインスタンス属性を明示的に指定します。このようにして、Python はいくつかのチェックなどを省略できるため、メモリ使用量が少なくなり、速度がわずかに向上します。詳細については、こちらの attrs ドキュメントを参照してください。

ただし、スロット化されたクラスには、特に手動で作成する場合に注意が必要です。幸いなことに、attrs はこの機能を有効にする簡単な方法を提供してくれます:

import attr

@attr.s(slots=True)
class YourClassName:
    ...

学び続ける

Python データクラスに関する記事
Python のクラスとオブジェクトに関するチュートリアル
その他の例については、属性の例のページをご覧ください

Python クラススロット REPL でアンダースコアを使用する

Python