Pythonのデコレータとメタクラスの高度な使用法

概要

Pythonのメタクラスを紹介しているうちに、Pythonの最も強力な機能の大きな問題は、プログラマがそれらがどのように彼らの通常のタスクを簡素化することができるかを認識していないことであることに気づきました。そのため、メタクラスのような機能は、本当のゲームチェンジャーではなく、標準的なOOP言語に追加された、派手だけどどちらかというと使い勝手の悪いものと考えられています。

この記事では、メタクラスとデコレータを使って、継承したり、デコレーションされたメソッドを簡単に追加してカスタマイズできる強力なクラスを作成する方法を紹介します。

メタクラスとデコレータ: 天が作りし組み合わせ

メタクラスは複雑なテーマであり、高度なプログラマーであっても、メタクラスの幅広い実用的な使い方を理解していないことがほとんどです。Python（あるいはSmalltalkやRubyのようにメタクラスをサポートする他の言語）は、C++やJavaに見られる「標準的な」オブジェクト指向のパターンやソリューションに最も適合しない部分である可能性があります。

実際、メタクラスが活躍するのは、多くの自動化を必要とする高度なライブラリやフレームワークをプログラミングするときです。例えば、 Django のフォームシステムは、その魔法を提供するためにメタクラスに大きく依存しています。

しかし、私たちは通常、馴染みのない技術を「マジック」や「トリック」と呼ぶことに注意しなければなりません。その結果、Pythonでは他の言語に比べて実装が特殊なため、多くのものがこのように呼ばれます。

あなたのプログラミングにスパイスを加える時が来ました：Pythonのマジックを練習して、この言語の力を利用しましょう。

今回の記事では、デコレータとメタクラスの面白い共同利用を紹介します。デコレータを使ってメソッドをマークし、与えられた操作を行う際にクラスが自動的に使用できるようにする方法を紹介します。

具体的には、文字列を「処理」するために呼び出されるクラスを実装し、単純なデコレーションされたメソッドを使ってさまざまな「フィルタ」を実装する方法を紹介します。私が得たいのは次のようなものです。

code: python

class MyStringProcessor(StringProcessor):

@stringfilter

def capitalize(self, str):

@stringfilter

def remove_double_spaces(self, str):

msp = MyStringProcessor()

"A test string" == msp("a test string")

メタクラスへのヒッチハイク・ガイド

この目標を達成するために、メタクラスはどのように役立つのでしょうか？

クラスには名前空間があり、それはクラス内で定義されたものの辞書であることはご存知でしょう。そのため、標準の型メタクラスを使用してクラスを作成すると、クラス本体が解析され、名前空間を収集するためにdict()オブジェクトが使用されます。

code: python

class FilterClass(type):

def __prepare__(name, bases, **kwds):

return collections.OrderedDict()

完全なメタクラスは次のようになります。

code: python

class FilterClass(type):

@classmethod

def __prepare__(name, bases, **kwds):

return collections.OrderedDict()

def __new__(metacls, name, bases, namespace, **kwds):

result = type.__new__(metacls, name, bases, dict(namespace))

result._filters = [

value for value in namespace.values() if hasattr(value, '_filter')]

return result

今度は、すべてのフィルター・メソッドを _filter 属性でマークする方法を見つけなければなりません。

華麗なデコレータの解体新書

デコレーターは、その名が示すように、関数やメソッドを補強するための最良の方法です。デコレーターは基本的に、別の呼び出し可能なものを受け入れて処理し、それを返す呼び出し可能なものであることを覚えておいてください。

デコレータは、メタクラスと組み合わせて使用することで、コードに高度な動作を実装するための非常に強力で表現力豊かな手段となります。今回の例では、デコレータの最も基本的な作業である、デコレートされたメソッドへの属性の追加を簡単に行うことができます。

デコレーターはとてもシンプルです。

code: python

def stringfilter(func):

func._filter = True

return func

ご覧のように、デコレーターは _filter という属性を関数に作成するだけです (関数はオブジェクトであることを忘れないでください)。この属性の実際の値は、このケースでは重要ではありません。 なぜなら、この属性を含むクラス・メンバーを見分けることに興味があるだけだからです。

呼び出し可能オブジェクトの力学

code: python

class StringProcessor(metaclass=FilterClass):

def __call__(self, string):

_string = string

for _filter in self._filters:

_string = _filter(self, _string)

return _string

このシンプルな関数を簡単に見てみると、文字列を引数として受け取り、それをローカル変数に格納し、フィルタをループさせて、ローカルの文字列、つまり前のフィルタの結果に対してそれぞれのフィルタを実行していることがわかります。

デコレータとメタクラスのおかげで、検討中のデコレータで装飾されていない限り、文字列処理に干渉しない他のメソッドをクラス内に持つことができることに注意してください。

派生クラスの例は次のようになります。

code: python

class MyStringProcessor(StringProcessor):

@stringfilter

def capitalize(self, string):

return string.capitalize()

@stringfilter

def remove_double_spaces(self, string):

return string.replace(' ', ' ')

capitalize()とremove_double_spaces()の2つのメソッドは装飾されているので、クラスを呼び出すときに渡された文字列に順番に適用されます。この最後のクラスの簡単な例がこれです。

code: python

>> import strproc

>> msp = strproc.MyStringProcessor()

>> input_string = "a test string"

>> output_string = msp(input_string)

>> print("INPUT STRING:", input_string)

INPUT STRING: a test string

>> print("OUTPUT STRING:", output_string)

OUTPUT STRING: A test string

>>

最後に

この記事では、メタクラスが何の役に立つか、そしてなぜPythonプログラマの武器の一部になるべきだと思うかについて、実践的な例を示すことを目的としています。

特に、開発者の中には、メタクラスの使用は、クラスの構造や基礎となる機構の多くを隠してしまうため、リスクの伴うと考える人がいることは興味深いことです。その通りなので、（他の技術でもそうですが）メタクラスを使う理由をよく考えて、それをよく理解した上で使うようにしてください。

トリビア

原文のセクションのタイトルは以下の本から来ています。

A Match Made in Space - George McFly

Metaclasses and decorators: a match made in space　/ メタクラスとデコレータ: 天が作りし組み合わせ

映画「Back to the Futures] の1985年に戻ったラストシーンで、歴史が変わりセレブ小説家となった父ジョージの元に届けられた処女作が「A MATCH MADE IN SPACE」となっています。

The Hitchhiker's Guide To the Galaxy - Various Authors

The Hitchhiker's Guide To Metaclasses / メタクラスへのヒッチハイク・ガイド

The Anatomy of Purple Dragons - Unknown

The Anatomy of Purple Decorators / 華麗なデコレータの解体新書

Purple Dragone は 『ダンジョンズ＆ドラゴンズ』の世界に登場するドラゴンの一種。

The Dynamics of an Asteroid - James Moriarty」

The Dynamics of a Callable Object / 呼び出し可能オブジェクトの力学

訳注：意訳しようとも考えましたが、著者のウィットに飛んだ遊び心を残したかったので、できるだけ原文よりに訳してみました。

ソースコード

オンライン・リソース

以下のリソースが役に立つかもしれません。

メタクラス

デコレータ

呼び出し可能オブジェクト