Pythonでのメタプログラミングの探求

多くの人々は「メタプログラミング」という概念に馴染みがなく、その定義も明確ではありません。この記事では、Pythonにおけるメタプログラミングに焦点を当てています。ただし、ここで議論されている内容は、「メタプログラミング」の厳密な定義に完全には準拠していないかもしれません。ただ、この記事のテーマを表すのに、より適切な用語が見つからなかったため、この言葉を借用しました。

サブタイトルは「制御したいものをすべて制御する」です。本質的に、この記事は一つのことに焦点を当てています。それは、Pythonが提供する機能を活用して、コードを可能な限りエレガントで簡潔にすることです。具体的には、プログラミング技術を通じて、より高いレベルの抽象化における抽象化の特性を修正します。

まず第一に、Pythonではすべてがオブジェクトであるというのは周知の事実です。さらに、Pythonは、特殊メソッドやメタクラスなど、多数の「メタプログラミング」メカニズムを提供しています。オブジェクトへの属性やメソッドの動的な追加のような操作は、Pythonではまったく「メタプログラミング」とは見なされません。しかし、一部の静的言語では、これを実現するには特定のスキルが必要です。Pythonプログラマーを簡単に困惑させる可能性のあるいくつかの側面について説明しましょう。

オブジェクトを異なるレベルに分類することから始めましょう。一般的に、オブジェクトには型があり、Pythonは以前から型をオブジェクトとして実装しています。したがって、インスタンスオブジェクトとクラスオブジェクトがあります。これらは2つのレベルです。基本的な理解のある読者であれば、メタクラスの存在に気づいているでしょう。簡単に言うと、メタクラスは「クラス」の「クラス」であり、クラスよりも高いレベルにあります。これにより、別のレベルが追加されます。さらにありますか？

ImportTime vs RunTime

異なる視点から見て、前の3つのレベルと同じ基準を適用する必要がない場合は、ImportTimeとRunTimeの2つの概念を区別できます。それらの境界は明確ではありません。名前が示すように、インポート時と実行時の2つの瞬間を指します。

モジュールがインポートされると何が起こるのでしょうか？グローバルスコープのステートメント（定義ステートメント以外）が実行されます。関数定義はどうでしょうか？関数オブジェクトが作成されますが、その中のコードは実行されません。クラス定義の場合、クラスオブジェクトが作成され、クラス定義スコープ内のコードが実行され、クラスメソッド内のコードは当然実行されません。

実行中はどうでしょうか？関数とメソッド内のコードが実行されます。もちろん、最初にそれらを呼び出す必要があります。

メタクラス

したがって、メタクラスとクラスはImportTimeに属すると言えます。モジュールがインポートされた後、それらは作成されます。インスタンスオブジェクトはRunTimeに属します。モジュールをインポートするだけでは、インスタンスオブジェクトは作成されません。ただし、モジュールスコープ内でクラスをインスタンス化すると、インスタンスオブジェクトも作成されるため、あまり独断的になることはできません。通常、インスタンス化を関数内に記述するため、この分類になります。

作成されたインスタンスオブジェクトの特性を制御したい場合は、どうすればよいでしょうか？それは非常に簡単です。クラス定義の__init__メソッドをオーバーライドします。次に、クラスのいくつかのプロパティを制御したい場合はどうでしょうか？そのような必要性はありますか？間違いなくあります！

古典的なシングルトンパターンに関して、誰もがそれを実装する複数の方法があることを知っています。要件は、クラスが1つのインスタンスしか持てないことです。

最も簡単な実装は次のとおりです。

class _Spam:
 def __init__(self):
 print("Spam!!！")

_spam_singleton = None

def Spam():
 global _spam_singleton
 if _spam_singleton is not None:
 return _spam_singleton
 else:
 _spam_singleton = _Spam()
 return _spam_singleton

このファクトリのようなパターンは、あまりエレガントではありません。もう一度要件を確認しましょう。クラスが1つのインスタンスしか持たないことが望ましいです。クラスで定義するメソッドは、インスタンスオブジェクトの動作です。したがって、クラスの動作を変更したい場合は、より高いレベルのものが必要です。ここでメタクラスが登場します。前述のように、メタクラスはクラスのクラスです。つまり、メタクラスの__init__メソッドは、クラスの初期化メソッドです。__call__メソッドもあることを知っています。これにより、インスタンスを関数のように呼び出すことができます。次に、メタクラスのこのメソッドは、クラスがインスタンス化されるときに呼び出されるメソッドです。

コードは次のように記述できます。

class Singleton(type):
 def __init__(self, *args, **kwargs):
 self._instance = None
 super().__init__(*args, **kwargs)

 def __call__(self, *args, **kwargs):
 if self._instance is None:
 self._instance = super().__call__(*args, **kwargs)
 return self._instance
 else:
 return self._instance


class Spam(metaclass = Singleton):
 def __init__(self):
 print("Spam!!!")

一般的なクラス定義と比較して、2つの主な違いがあります。1つは、Singletonのベースクラスがtypeであること、もう1つは、Spamの定義にmetaclass = Singletonがあることです。typeとは何ですか？これはobjectのサブクラスであり、objectはそのインスタンスです。つまり、typeはすべてのクラスのクラスであり、最も基本的なメタクラスです。これは、すべてのクラスが作成時に必要とするいくつかの操作を規定しています。したがって、カスタムメタクラスはtypeをサブクラス化する必要があります。同時に、typeもオブジェクトであるため、objectのサブクラスです。少し把握しにくいですが、一般的な考えをつかむだけです。

デコレータ

デコレータについて話しましょう。ほとんどの人は、デコレータをPythonで理解するのが最も難しい概念の1つと考えています。実際、これは単なるシンタックスシュガーです。関数もオブジェクトであることを理解すれば、独自のデコレータを簡単に作成できます。

from functools import wraps


def print_result(func):
 @wraps(func)
 def wrapper(*args, **kwargs):
 result = func(*args, **kwargs)
 print(result)
 return result

 return wrapper


@print_result
def add(x, y):
 return x + y


# Equivalent to:
# add = print_result(add)

add(1, 3)

ここでは、デコレータ@wrapsも使用しています。これは、返される内部関数wrapperが元の関数と同じ関数シグネチャを持つようにするために使用されます。基本的には、デコレータを記述するときに追加する必要があります。

コメントに書いたように、@decoratorの形式はfunc = decorator(func)と同じです。この点を理解することで、より多くの種類のデコレータを作成できます。たとえば、クラスデコレータ、およびクラスとしてのデコレータの作成。

def attr_upper(cls):
 for attrname, value in cls.__dict__.items():
 if isinstance(value, str):
 if not value.startswith('__'):
 setattr(cls, attrname, bytes.decode(str.encode(value).upper()))
 return cls


@attr_upper
class Person:
 sex ='man'


print(Person.sex) # MAN

通常のデコレータとクラスデコレータの実装の違いに注意してください。

データ抽象化 - ディスクリプタ

一部のクラスが特定の共通の特性を持ち、クラス定義内でそれらを制御できるようにしたい場合は、メタクラスをカスタマイズして、これらのクラスのメタクラスにすることができます。一部の関数に特定の共通の機能を持たせ、コードの重複を回避したい場合は、デコレータを定義できます。次に、インスタンスの属性にいくつかの共通の特性を持たせたい場合はどうでしょうか？ propertyを使用できると言う人もいるかもしれませんが、実際に使用できます。ただし、このロジックはクラス定義ごとに記述する必要があります。これらのクラスのインスタンスのいくつかの属性に同じ特性を持たせたい場合は、ディスクリプタクラスをカスタマイズできます。

ディスクリプタに関しては、この記事https://docs.python.org/3/howto/descriptor.html で非常に詳しく説明されています。同時に、関数とメソッドの統一と違いを実現するために、ディスクリプタが関数の背後にどのように隠されているかについても詳しく説明しています。次にいくつかの例を示します。

class TypedField:
 def __init__(self, _type):
 self._type = _type

 def __get__(self, instance, cls):
 if instance is None:
 return self
 else:
 return getattr(instance, self.name)

 def __set_name__(self, cls, name):
 self.name = name

 def __set__(self, instance, value):
 if not isinstance(value, self._type):
 raise TypeError('Expected' + str(self._type))
 instance.__dict__[self.name] = value


class Person:
 age = TypedField(int)
 name = TypedField(str)

 def __init__(self, age, name):
 self.age = age
 self.name = name


jack = Person(15, 'Jack')
jack.age = '15' # Will raise an error

ここにはいくつかの役割があります。 TypedFieldはディスクリプタクラスであり、Personの属性はディスクリプタクラスのインスタンスです。ディスクリプタはPersonの属性、つまりインスタンス属性ではなくクラス属性として存在するように見えます。ただし、実際には、Personのインスタンスが同じ名前の属性にアクセスすると、ディスクリプタが有効になります。 Python 3.5以前のバージョンでは、__set_name__特殊メソッドがないことに注意してください。これは、クラス定義でディスクリプタにどのような名前が付けられているかを知りたい場合は、インスタンス化するときに明示的にディスクリプタに渡す必要があることを意味します。つまり、もう1つのパラメータが必要です。ただし、Python 3.6では、この問題は解決されています。ディスクリプタクラス定義で__set_name__メソッドをオーバーライドするだけです。また、__get__の書き方にも注意してください。基本的に、instanceの判断は必要です。そうしないと、エラーが発生します。理由は理解するのが難しくないため、詳細は省略します。

サブクラスの作成の制御 - メタクラスの代替

Python 3.6では、__init_subclass__特殊メソッドを実装することにより、サブクラスの作成をカスタマイズできます。このようにして、場合によっては、やや面倒なメタクラスの使用を回避できます。

class PluginBase:
 subclasses = []

 def __init_subclass__(cls, **kwargs):
 super().__init_subclass__(**kwargs)
 cls.subclasses.append(cls)


class Plugin1(PluginBase):
 pass


class Plugin2(PluginBase):
 pass

まとめ

メタクラスなどのメタプログラミング手法は、ほとんどの人にとっていくぶん難解で理解しにくく、ほとんどの場合、それらを使用する必要はありません。ただし、ほとんどのフレームワークの実装では、これらの手法を使用して、ユーザーが記述したコードを簡潔で理解しやすいものにすることが可能です。これらのテクニックについてより深く理解したい場合は、Fluent PythonやPython Cookbookなどの書籍を参照するか（この記事の内容の一部はそれらから参照されています）、上記のディスクリプタHow-Toやデータモデルセクションなどの公式ドキュメントのいくつかの章を読むことができます。または、Pythonで記述されたソースコードやCPythonソースコードなど、Pythonソースコードを直接調べます。

これらのテクニックを完全に理解した上で使用し、どこでも使用しようとしないでください。