Pythonデコレータの一般的な用途は何ですか？[閉まっている]

私は自分を適度に有能なPythonコーダーと考えるのが好きですが、私が理解できなかった言語の1つの側面はデコレーターです。

私はそれらが（表面的に）何であるかを知っており、スタックオーバーフローに関するチュートリアル、例、質問を読みました、そして私は構文を理解し、自分で書くことができ、時々@classmethodと@staticmethodを使用しますが、私自身のPythonコードの問題を解決するデコレータ。「うーん...これはデコレータの仕事のように見える！」という問題に遭遇したことはありません。

それで、皆さんが自分のプログラムでデコレーターを使用した例をいくつか提供できるかどうか疑問に思っています。うまくいけば、「A-ha！」瞬間とそれらを取得します。

主にタイミングの目的でデコレータを使用します

def time_dec(func):

  def wrapper(*arg):
      t = time.clock()
      res = func(*arg)
      print func.func_name, time.clock()-t
      return res

  return wrapper


@time_dec
def myFunction(n):
    ...

同期に使用しました。

import functools

def synchronized(lock):
    """ Synchronization decorator """
    def wrap(f):
        @functools.wraps(f)
        def newFunction(*args, **kw):
            lock.acquire()
            try:
                return f(*args, **kw)
            finally:
                lock.release()
        return newFunction
    return wrap

コメントで指摘したように、Python 2.5以降では、withステートメントをthreading.Lock（またはmultiprocessing.Lockバージョン2.6以降）オブジェクトと組み合わせて 使用して、デコレータの実装を次のように単純化できます。

import functools

def synchronized(lock):
    """ Synchronization decorator """
    def wrap(f):
        @functools.wraps(f)
        def newFunction(*args, **kw):
            with lock:
                return f(*args, **kw)
        return newFunction
    return wrap

とにかく、あなたはそれをこのように使います：

import threading
lock = threading.Lock()

@synchronized(lock)
def do_something():
  # etc

@synchronzied(lock)
def do_something_else():
  # etc

基本的に、関数呼び出しの両側にlock.acquire()/ lock.release()を置くだけです。

いくつかのRMIを介してPythonメソッドに渡される型チェックパラメータにデコレータを使用しています。したがって、同じパラメーターのカウントを繰り返す代わりに、何度も例外を発生させるmumbo-jumboを発生させます。

たとえば、次の代わりに：

def myMethod(ID, name):
    if not (myIsType(ID, 'uint') and myIsType(name, 'utf8string')):
        raise BlaBlaException() ...

私は宣言します：

@accepts(uint, utf8string)
def myMethod(ID, name):
    ...

そしてaccepts()私のためにすべての仕事をします。

デコレータは、追加の機能を使用して透過的に「ラップ」したいものに使用されます。

Djangoはこれらを使用して、ビュー関数の「ログインが必要な」機能をラップしたり、フィルタ関数を登録したりします。

クラスデコレータを使用して、名前付きログをクラスに追加できます。

既存のクラスまたは関数の動作に「タック」できる十分に汎用的な機能は、装飾のための公正なゲームです。

また、Python-Devニュースグループには、PEP 318（関数とメソッドのデコレータ）によって指摘されたユースケースに関する議論もあります。

nosetestsの場合、単体テスト関数またはメソッドにいくつかのパラメーターセットを提供するデコレーターを作成できます。

@parameters(
   (2, 4, 6),
   (5, 6, 11),
)
def test_add(a, b, expected):
    assert a + b == expected

Twistedライブラリは、ジェネレーターと組み合わせたデコレーターを使用して、非同期関数が同期しているように見せます。例えば：

@inlineCallbacks
def asyncf():
    doStuff()
    yield someAsynchronousCall()
    doStuff()
    yield someAsynchronousCall()
    doStuff()

これを使用すると、大量の小さなコールバック関数に分割されたコードを1つのブロックとして非常に自然に記述できるため、理解と保守が非常に簡単になります。

もちろん、1つの明らかな使用法はロギングです。

import functools

def log(logger, level='info'):
    def log_decorator(fn):
        @functools.wraps(fn)
        def wrapper(*a, **kwa):
            getattr(logger, level)(fn.__name__)
            return fn(*a, **kwa)
        return wrapper
    return log_decorator

# later that day ...
@log(logging.getLogger('main'), level='warning')
def potentially_dangerous_function(times):
    for _ in xrange(times): rockets.get_rocket(NUCLEAR=True).fire()

私は主にデバッグ（引数と結果を出力する関数のラッパー）と検証（たとえば、引数が正しいタイプかどうかを確認するため、またはWebアプリケーションの場合、ユーザーが特定の方法）。

関数をスレッドセーフにするために次のデコレータを使用しています。コードが読みやすくなります。これはJohn Fouhyによって提案されたものとほとんど同じですが、違いは、1つの関数で作業することと、明示的にロックオブジェクトを作成する必要がないことです。

def threadsafe_function(fn):
    """decorator making sure that the decorated function is thread safe"""
    lock = threading.Lock()
    def new(*args, **kwargs):
        lock.acquire()
        try:
            r = fn(*args, **kwargs)
        except Exception as e:
            raise e
        finally:
            lock.release()
        return r
    return new

class X:
    var = 0

    @threadsafe_function     
    def inc_var(self):
        X.var += 1    
        return X.var

デコレータは、関数のプロパティを定義するため、または関数を変更するボイラープレートとして使用されます。完全に異なる関数を返すことは可能ですが直感に反します。ここで他の応答を見ると、最も一般的な用途の1つは、ロギング、プロファイリング、セキュリティチェックなど、他のプロセスの範囲を制限することです。

CherryPyは、オブジェクトディスパッチを使用して、URLをオブジェクト、最終的にはメソッドと照合します。これらのメソッドのデコレーターは、CherryPyがそれらのメソッドの使用を許可されているかどうかを通知します。たとえば、チュートリアルからの変更：

class HelloWorld:

    ...

    def secret(self):
        return "You shouldn't be here."

    @cherrypy.expose
    def index(self):
        return "Hello world!"

cherrypy.quickstart(HelloWorld())

私は最近、ソーシャルネットワーキングWebアプリケーションに取り組んでいるときにそれらを使用しました。コミュニティ/グループの場合、新しいディスカッションを作成し、その特定のグループのメンバーである必要があるメッセージに返信する権限をメンバーシップに与えることになっていた。そこで、デコレータ@membership_requiredを作成し、必要な場所に配置しました。

このデコレータを使用してパラメータを修正します

def fill_it(arg):
    if isinstance(arg, int):
        return "wan" + str(arg)
    else:
        try:
            # number present as string
            if str(int(arg)) == arg:
                return "wan" + arg
            else:
                # This should never happened
                raise Exception("I dont know this " + arg)
                print "What arg?"
        except ValueError, e:
            return arg

def fill_wanname(func):
    def wrapper(arg):
        filled = fill_it(arg)
        return func(filled)
    return wrapper

@fill_wanname
def get_iface_of(wanname):
    global __iface_config__
    return __iface_config__[wanname]['iface']

これは、いくつかの関数をリファクタリングするときに書かれ、引数「wanN」を渡す必要がありますが、私の古いコードでは、Nまたは 'N'のみを渡しました

デコレーターを使用すると、関数メソッド変数を簡単に作成できます。

def static_var(varname, value):
    '''
    Decorator to create a static variable for the specified function
    @param varname: static variable name
    @param value: initial value for the variable
    '''
    def decorate(func):
        setattr(func, varname, value)
        return func
    return decorate

@static_var("count", 0)
def mainCallCount():
    mainCallCount.count += 1