帶參數的全類型 Python 裝飾器

2022-09-27 11:01:08

在這篇文章中，將展示一個可選接收參數的全類型 Python 裝飾器的藍圖。

這篇短文中顯示的代碼取自我的小型開源項目按合同設計，它提供了一個類型化的裝飾器。裝飾器是一個非常有用的概念，你肯定會在網上找到很多關于它們的介紹。簡單說，它們允許在每次調用裝飾函數時（之前和之后）執行代碼。通過這種方式，你可以修改函數參數或返回值、測量執行時間、添加日志記錄、執行執行時類型檢查等等。請注意，裝飾器也可以為類編寫，提供另一種元編程方法（例如在 attrs 包中完成）

在最簡單的形式中，裝飾器的定義類似于以下代碼：

def my_first_decorator(func):
   def wrapped(*args, **kwargs):
       # do something before
       result = func(*args, **kwargs)
       # do something after
       return result
   return wrapped
@my_first_decorator
def func(a):
   return a

如上代碼，因為當定義了被包裝的嵌套函數時，它的周圍變量可以在函數內訪問并保存在內存中，只要該函數在某處使用（這在函數式編程語言中稱為閉包）。

很簡單，但是這有一些缺點。最大的問題是修飾函數會丟失它的之前的函數名字（你可以用inspect.signature看到這個），它的文檔字符串，甚至它的名字，這些是源代碼文檔工具（例如 sphinx）的問題，但可以使用標準庫中的 functools.wraps 裝飾器輕松解決：

from functools import wraps
from typing import Any, Callable, TypeVar, ParamSpec
P = ParamSpec("P") # 需要python >= 3.10
R = TypeVar("R")
def my_second_decorator(func: Callable[P, R]) -> Callable[P, R]:
   @wraps(func)
   def wrapped(*args: Any, **kwargs: Any) -> R:
       # do something before
       result = func(*args, **kwargs)
       # do something after
       return result
   return wrapped
@my_second_decorator
def func2(a: int) -> int:
   """Does nothing"""
   return a
print(func2.__name__)
# 'func2'
print(func2.__doc__)
# 'Does nothing'

在這個例子中，我已經添加了類型注釋，注釋和類型提示是對 Python 所做的最重要的補充。更好的可讀性、IDE 中的代碼完成以及更大代碼庫的可維護性只是其中的幾個例子。上面的代碼應該已經涵蓋了大多數用例，但無法參數化裝飾器。考慮編寫一個裝飾器來記錄函數的執行時間，但前提是它超過了一定的秒數。這個數量應該可以為每個裝飾函數單獨配置。如果沒有指定，則應使用默認值，并且應使用不帶括號的裝飾器，以便更易于使用：

@time(threshold=2)
def func1(a):
  ...
# No paranthesis when using default threshold
@time
def func2(b):
  ...

如果你可以在第二種情況下使用括號，或者根本不提供參數的默認值，那么這個秘訣就足夠了：

from functools import wraps
from typing import Any, Callable, TypeVar, ParamSpec
P = ParamSpec("P") # 需要python >= 3.10
R = TypeVar("R")
def my_third_decorator(threshold: int = 1) -> Callable[[Callable[P, R]], Callable[P, R]]:
   def decorator(func: Callable[P, R]) -> Callable[P, R]:
       @wraps(func)
       def wrapper(*args: Any, **kwargs: Any) -> R:
           # do something before you can use `threshold`
           result = func(*args, **kwargs)
           # do something after
           return result
       return wrapper
   return decorator
@my_third_decorator(threshold=2)
def func3a(a: int) -> None:
  ...
# works
@my_third_decorator()
def func3b(a: int) -> None:
  ...
# Does not work!
@my_third_decorator
def func3c(a: int) -> None:
  ...

為了涵蓋第三種情況，有一些包，即 wraps 和 decorator，它們實際上可以做的不僅僅是添加可選參數。雖然質量非常高，但它們引入了相當多的額外復雜性。使用 wrapt-decorated 函數，在遠程集群上運行函數時，我進一步遇到了序列化問題。據我所知，兩者都沒有完全鍵入，因此靜態類型檢查器/ linter（例如 mypy）在嚴格模式下失敗。

當我在自己的包上工作并決定編寫自己的解決方案時，必須解決這些問題。它變成了一種可以輕松重用但很難轉換為庫的模式。

它使用標準庫的重載裝飾器。這樣，可以指定相同的裝飾器與我們的無參數一起使用。除此之外，它是上面兩個片段的組合。這種方法的一個缺點是所有參數都需要作為關鍵字參數給出（這畢竟增加了可讀性）

from typing import Callable, TypeVar, ParamSpec
from functools import partial, wraps
P = ParamSpec("P") # requires python >= 3.10
R = TypeVar("R
@overload
def typed_decorator(func: Callable[P, R]) -> Callable[P, R]:
  ...
@overload
def typed_decorator(*, first: str = "x", second: bool = True) -> Callable[[Callable[P, R]], Callable[P, R]]:
  ...
def typed_decorator(
   func: Optional[Callable[P, R]] = None, *, first: str = "x", second: bool = True
) -> Union[Callable[[Callable[P, R]], Callable[P, R]], Callable[P, R]]:
   """
  Describe what the decorator is supposed to do!
  Parameters
  ----------
  first : str, optional
      First argument, by default "x".
      This is a keyword-only argument!
  second : bool, optional
      Second argument, by default True.
      This is a keyword-only argument!
  """
   def wrapper(func: Callable[P, R], *args: Any, **kw: Any) -> R:
       """The actual logic"""
       # Do something with first and second and produce a `result` of type `R`
       return result
   # Without arguments `func` is passed directly to the decorator
   if func is not None:
       if not callable(func):
           raise TypeError("Not a callable. Did you use a non-keyword argument?")
       return wraps(func)(partial(wrapper, func))
   # With arguments, we need to return a function that accepts the function
   def decorator(func: Callable[P, R]) -> Callable[P, R]:
       return wraps(func)(partial(wrapper, func))
   return decorator

稍后，我們可以分別使用我們的不帶參數的裝飾器

@typed_decorator
def spam(a: int) -> int:
   return a
@typed_decorator(first = "y
def eggs(a: int) -> int:
   return a

這種模式肯定有一些開銷，但收益大于成本。

原文：??https://lemonfold.io/posts/2022/dbc/typed_decorator/??

責任編輯：龐桂玉來源： python運維技術

Python 裝飾器