裝飾器如何將變量傳遞給函數而不更改其簽名？

Question

讓我先承認，我想要做的事情可能被認爲是愚蠢到邪惡，但我想知道我是否可以用Python來做到這一點。

比方說，我有一個函數裝飾器，它接受定義變量的關鍵字參數，並且我想在包裝函數中訪問這些變量。我可能會做這樣的事情：

def more_vars(**extras): 
    def wrapper(f): 
     @wraps(f) 
     def wrapped(*args, **kwargs): 
      return f(extras, *args, **kwargs) 
     return wrapped 
    return wrapper 

現在我可以這樣做：

@more_vars(a='hello', b='world') 
def test(deco_vars, x, y): 
    print(deco_vars['a'], deco_vars['b']) 
    print(x, y) 

test(1, 2) 
# Output: 
# hello world 
# 1 2 

我不喜歡這個的事情是，當你使用這個裝飾，你必須改變函數的調用簽名，除了修飾裝飾器外還增加額外的變量。另外，如果你看一下幫助功能，你看，你不希望在調用函數時使用一個額外的變量：

help(test) 
# Output: 
# Help on function test in module __main__: 
# 
# test(deco_vars, x, y) 

這使它看起來像預期用戶調用的函數有3個參數，但顯然這是行不通的。所以你還必須向docstring添加一條消息，指出第一個參數不是接口的一部分，它只是一個實現細節，應該被忽略。雖然這很糟糕。有沒有辦法做到這一點，而不必將這些變量掛在全局範圍內的某些東西上？理想情況下，我希望它看起來像下面這樣：

@more_vars(a='hello', b='world') 
def test(x, y): 
    print(a, b) 
    print(x, y) 

test(1, 2) 
# Output: 
# hello world 
# 1 2 
help(test) 
# Output: 
# Help on function test in module __main__: 
# 
# test(x, y) 

我滿足於僅存在Python 3解決方案。

Answer 1

我不喜歡將局部注入到命名空間的想法。雖然這可能是可能的，但處理新注入的本地人與已經存在於該函數中的名稱之間的衝突將是令人討厭的。

將它們作爲函數對象的attrs存儲是否可以接受？這樣他們是命名空間。

from functools import wraps 

def more_vars(**extras): 
    def wrapper(f): 
     @wraps(f) 
     def wrapped(*args, **kwargs): 
      return f(*args, **kwargs) 
     for k,v in extras.items(): 
      setattr(wrapped, k, v) 
     return wrapped 
    return wrapper 

@more_vars(a='hello', b='world') 
def test(x, y): 
    print(test.a, test.b) 
    print(x, y) 

Answer 2

你可以使用一些詭計是插入傳遞給裝飾變量到函數的局部變量做到這一點：

import sys 
from functools import wraps 
from types import FunctionType 


def is_python3(): 
    return sys.version_info >= (3, 0) 


def more_vars(**extras): 
    def wrapper(f): 
     @wraps(f) 
     def wrapped(*args, **kwargs): 
      fn_globals = {} 
      fn_globals.update(globals()) 
      fn_globals.update(extras) 
      if is_python3(): 
       func_code = '__code__' 
      else: 
       func_code = 'func_code' 
      call_fn = FunctionType(getattr(f, func_code), fn_globals) 
      return call_fn(*args, **kwargs) 
     return wrapped 
    return wrapper 


@more_vars(a="hello", b="world") 
def test(x, y): 
    print("locals: {}".format(locals())) 
    print("x: {}".format(x)) 
    print("y: {}".format(y)) 
    print("a: {}".format(a)) 
    print("b: {}".format(b)) 


if __name__ == "__main__": 
    test(1, 2) 

能你這樣做嗎？當然！ 應該你這樣做？可能不會！

（代碼可用here）

Answer 3

這聽起來像你唯一的問題是，help正顯示出原始test作爲包裝的函數的簽名的簽名，你不希望它。

發生這種情況的唯一原因是wraps（或者說，update_wrapper，其中wraps調用）明確地將其從wrappee複製到包裝。

你可以決定你做什麼，不想複製。如果你想做的不同是很簡單的，這只是一個過濾的東西出默認WRAPPER_ASSIGNMENTS和WRAPPER_UPDATES的問題。如果您想要更改其他內容，則可能需要分叉update_wrapper並使用您自己的版本 - 但functools是其中一個模塊，在文檔頂部有一個鏈接到the source，因爲它旨在用作可讀樣本碼。

在你的情況下，它可能只是wraps(f, updated=[])的問題，或者您可能需要做一些花哨，像使用inspect.signature得到的f簽名，並將其修改爲除去第一個參數，並明確構建一個包裝甚至愚弄inspect模塊。