Một số sử dụng phổ biến cho trang trí Python là gì? [đóng cửa]

Trong khi tôi muốn nghĩ về bản thân mình như một lập trình viên Python có năng lực hợp lý, một khía cạnh của ngôn ngữ mà tôi chưa bao giờ có thể mò mẫm là trang trí.

Tôi biết chúng là gì (bề ngoài), tôi đã đọc hướng dẫn, ví dụ, câu hỏi về Stack Overflow và tôi hiểu cú pháp, có thể tự viết, thỉnh thoảng sử dụng @ classmethod và @staticmethod, nhưng tôi không bao giờ sử dụng trang trí để giải quyết một vấn đề trong mã Python của riêng tôi. Tôi không bao giờ gặp phải một vấn đề mà tôi nghĩ, "Hmm ... đây có vẻ như là một công việc cho một người trang trí!"

Vì vậy, tôi tự hỏi nếu các bạn có thể đưa ra một số ví dụ về nơi bạn đã sử dụng trang trí trong các chương trình của riêng mình và hy vọng tôi sẽ có một "A-ha!" Khoảnh khắc và có được chúng.

Tôi sử dụng trang trí chủ yếu cho mục đích thời gian

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):
    ...

Tôi đã sử dụng chúng để đồng bộ hóa.

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

Như đã chỉ ra trong các nhận xét, vì Python 2.5, bạn có thể sử dụng một withcâu lệnh kết hợp với một đối tượng threading.Lock(hoặc multiprocessing.Lockkể từ phiên bản 2.6) để đơn giản hóa việc triển khai của trình trang trí thành:

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

Bất kể, sau đó bạn sử dụng nó như thế này:

import threading
lock = threading.Lock()

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

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

Về cơ bản, nó chỉ đặt lock.acquire()/ lock.release()ở hai bên của lệnh gọi hàm.

Tôi sử dụng các trình trang trí để kiểm tra các tham số kiểu được truyền cho các phương thức Python của tôi thông qua một số RMI. Vì vậy, thay vì lặp đi lặp lại việc đếm tham số tương tự, ngoại lệ - tăng mumbo-jumbo nhiều lần.

Ví dụ: thay vì:

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

Tôi chỉ tuyên bố:

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

và accepts()làm tất cả công việc cho tôi.

Trang trí được sử dụng cho bất cứ điều gì bạn muốn trong suốt "bọc" với chức năng bổ sung.

Django sử dụng chúng để gói chức năng "yêu cầu đăng nhập" trên các chức năng xem , cũng như để đăng ký các chức năng lọc .

Bạn có thể sử dụng trang trí lớp để thêm nhật ký được đặt tên vào các lớp .

Bất kỳ chức năng đủ chung chung nào mà bạn có thể "giải quyết" đối với một lớp hoặc hành vi của chức năng hiện có là trò chơi công bằng để trang trí.

Ngoài ra còn có một cuộc thảo luận về các trường hợp sử dụng trên nhóm tin Python-Dev được chỉ ra bởi PEP 318 - Trình trang trí cho các hàm và phương thức .

Đối với nosetests, bạn có thể viết một trình trang trí cung cấp một hàm hoặc phương thức kiểm tra đơn vị với một vài bộ tham số:

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

Thư viện Twisted sử dụng các bộ trang trí kết hợp với các bộ tạo để tạo ảo giác rằng một hàm không đồng bộ là đồng bộ. Ví dụ:

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

Sử dụng điều này, mã sẽ được chia thành một tấn các hàm gọi lại nhỏ có thể được viết khá tự nhiên dưới dạng một khối, làm cho nó dễ hiểu và dễ bảo trì hơn rất nhiều.

Tất nhiên, một cách sử dụng rõ ràng là ghi nhật ký:

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()

Tôi sử dụng chúng chủ yếu để gỡ lỗi (trình bao quanh một chức năng in các đối số và kết quả của nó) và xác minh (ví dụ: để kiểm tra xem một đối số có đúng loại hay không, trong trường hợp ứng dụng web, nếu người dùng có đủ đặc quyền để gọi một cụ thể phương pháp).

Tôi đang sử dụng trang trí sau đây để làm cho một chủ đề chức năng an toàn. Nó làm cho mã dễ đọc hơn. Nó gần giống với cái được đề xuất bởi John Fouhy nhưng điểm khác biệt là một cái hoạt động trên một chức năng duy nhất và không cần phải tạo một đối tượng khóa rõ ràng.

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

Các công cụ trang trí được sử dụng hoặc để xác định các thuộc tính của hàm hoặc dưới dạng nồi hơi làm thay đổi nó; điều đó là có thể nhưng phản trực giác để chúng trả về các chức năng hoàn toàn khác nhau. Nhìn vào các phản hồi khác ở đây, có vẻ như một trong những cách sử dụng phổ biến nhất là giới hạn phạm vi của một số quy trình khác - có thể là ghi nhật ký, định hình, kiểm tra bảo mật, v.v.

CherryPy sử dụng việc gửi đối tượng để khớp URL với các đối tượng và cuối cùng là các phương thức. Các nhà trang trí trên các phương thức đó báo hiệu cho dù CherryPy có được phép sử dụng các phương thức đó hay không. Ví dụ, điều chỉnh từ hướng dẫn :

class HelloWorld:

    ...

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

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

cherrypy.quickstart(HelloWorld())

Tôi đã sử dụng chúng gần đây, trong khi làm việc trên ứng dụng web mạng xã hội. Đối với Cộng đồng / Nhóm, tôi được cho là ủy quyền thành viên để tạo cuộc thảo luận mới và trả lời tin nhắn mà bạn phải là thành viên của nhóm cụ thể đó. Vì vậy, tôi đã viết một trang trí @membership_requiredvà đặt nơi mà tôi yêu cầu trong quan điểm của tôi.

Tôi sử dụng trang trí này để sửa tham số

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']

điều này được viết khi tôi cấu trúc lại một số hàm cần truyền đối số "wanN" nhưng trong các mã cũ của tôi, tôi chỉ truyền N hoặc 'N'

Trang trí có thể được sử dụng để dễ dàng tạo các biến phương thức hàm.

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