Python関数の属性-使用と乱用[終了]

多くの人がこの機能を認識していませんが、Pythonの関数（およびメソッド）は属性を持つことができます。見よ：

>>> def foo(x):
...     pass
...     
>>> foo.score = 10
>>> dir(foo)
['__call__', '__class__', '__delattr__', '__dict__', '__doc__', '__get__', '__getattribute__', '__hash__', '__init__', '__module__', '__name__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__str__', 'func_closure', 'func_code', 'func_defaults', 'func_dict', 'func_doc', 'func_globals', 'func_name', 'score']
>>> foo.score
10
>>> foo.score += 1
>>> foo.score
11

Pythonでこの機能を使用および悪用する可能性は何ですか？私が知っている1つの良い使用法は、構文規則をメソッドに関連付けるためのPLYのdocstringの使用法です。しかし、カスタム属性はどうですか？それらを使用する正当な理由はありますか？

通常、アノテーションのストレージとして関数属性を使用します。C＃のスタイルで記述したいとします（特定のメソッドをWebサービスインターフェイスの一部にする必要があることを示します）

class Foo(WebService):
    @webmethod
    def bar(self, arg1, arg2):
         ...

その後、私は定義することができます

def webmethod(func):
    func.is_webmethod = True
    return func

次に、Webサービスの呼び出しが到着したら、メソッドを調べ、基になる関数にis_webmethod属性があるかどうかを確認し（実際の値は関係ありません）、メソッドが存在しないか、Web経由で呼び出される予定がない場合はサービスを拒否します。

関数の静的変数として使用しました。たとえば、次のCコードがあるとします。

int fn(int i)
{
    static f = 1;
    f += i;
    return f;
}

Pythonでも同様に関数を実装できます。

def fn(i):
    fn.f += i
    return fn.f
fn.f = 1

これは間違いなく、「虐待」の範疇に入るでしょう。

JavaScriptの方法でオブジェクトを実行できます...意味がありませんが、機能します;）

>>> def FakeObject():
...   def test():
...     print "foo"
...   FakeObject.test = test
...   return FakeObject
>>> x = FakeObject()
>>> x.test()
foo

私はそれらを控えめに使用しますが、それらはかなり便利です：

def log(msg):
   log.logfile.write(msg)

これlogで、モジュール全体で使用でき、を設定するだけで出力をリダイレクトできますlog.logfile。それを実現する方法は他にもたくさんありますが、これは軽量で汚れが簡単です。初めて匂いを嗅いだときは、グローバルlogfile変数よりも匂いが良いと思いました。

関数属性を使用して、コードと関連データを一緒にラップする軽量クロージャーを作成できます。

#!/usr/bin/env python

SW_DELTA = 0
SW_MARK  = 1
SW_BASE  = 2

def stopwatch():
   import time

   def _sw( action = SW_DELTA ):

      if action == SW_DELTA:
         return time.time() - _sw._time

      elif action == SW_MARK:
         _sw._time = time.time()
         return _sw._time

      elif action == SW_BASE:
         return _sw._time

      else:
         raise NotImplementedError

   _sw._time = time.time() # time of creation

   return _sw

# test code
sw=stopwatch()
sw2=stopwatch()
import os
os.system("sleep 1")
print sw() # defaults to "SW_DELTA"
sw( SW_MARK )
os.system("sleep 2")
print sw()
print sw2()

1.00934004784

2.00644397736

3.01593494415

関数の属性を簡単に設定できるように、このヘルパーデコレーターを作成しました。

def with_attrs(**func_attrs):
    """Set attributes in the decorated function, at definition time.
    Only accepts keyword arguments.
    E.g.:
        @with_attrs(counter=0, something='boing')
        def count_it():
            count_it.counter += 1
        print count_it.counter
        print count_it.something
        # Out:
        # >>> 0
        # >>> 'boing'
    """
    def attr_decorator(fn):
        @wraps(fn)
        def wrapper(*args, **kwargs):
            return fn(*args, **kwargs)

        for attr, value in func_attrs.iteritems():
            setattr(wrapper, attr, value)

        return wrapper

    return attr_decorator

ユースケースは、ファクトリーのコレクションを作成し、それらが関数メタレベルで作成できるデータ型をクエリすることです。
例（非常にばかげたもの）：

@with_attrs(datatype=list)
def factory1():
    return [1, 2, 3]

@with_attrs(datatype=SomeClass)
def factory2():
    return SomeClass()

factories = [factory1, factory2]

def create(datatype):
    for f in factories:
        if f.datatype == datatype:
            return f()
    return None

すでに計算された値をキャッシュするために、関数の属性を使用することがあります。このアプローチを一般化する汎用デコレーターを使用することもできます。同時実行の問題とそのような関数の副作用に注意してください！

これが可能である唯一の理由は、doc-stringまたは他のそのようなものを配置する論理的な場所があったためだと私は常に想定していました。私がそれをプロダクションコードに使用した場合、それを読んだほとんどのユーザーを混乱させることがわかります。