从装饰器访问 self

Question

在unittest的setUp()方法中，我设置了一些self变量，这些变量稍后在实际测试中引用。我还创建了一个装饰器来进行一些日志记录。有没有办法可以从装饰器访问这些 self 变量？

为了简单起见，我发布了这段代码：

def decorator(func):
    def _decorator(*args, **kwargs):
        # access a from TestSample
        func(*args, **kwargs)
    return _decorator

class TestSample(unittest.TestCase):    
    def setUp(self):
        self.a = 10

    def tearDown(self):
        # tear down code

    @decorator
    def test_a(self):
        # testing code goes here

What would be the best way of accessing a (setUp()) fromdecorator?

Answer 1

由于您正在装饰一个方法，并且 self 是一个方法参数，因此您的装饰器可以在运行时访问 self 。显然不是在解析时，因为还没有对象，只是一个类。

所以你将你的装饰器更改为：

def decorator(func):
    def _decorator(self, *args, **kwargs):
        # access a from TestSample
        print 'self is %s' % self
        return func(self, *args, **kwargs)
    return _decorator

Answer 2

您实际上也可以使用 functools.wraps< /a> 保存help(obj.method)信息。除此之外，如果装饰器仅在类中使用，则可以将其包含在类主体中：

from functools import wraps


class MyClass:

    def decorator(func):
        @wraps(func)
        def _decorator(self, *args, **kwargs):
            print("In decorator. self: ", self)
            return func(self, *args, **kwargs)

        return _decorator

    @decorator
    def somemethod(self, a: int, b: int = 5):
        """This is somemethod.

        Parameters
        ----------
        a:
            This is a.
        b:
            The b is optional argument. (Default: 5)
        """
        print("in somemethod")

其工作原理如下

>>> obj = MyClass()
>>> obj.somemethod()
In decorator. self:  <__main__.MyClass object at 0x7f0378df6920>
in somemethod

，并且在调用 help() 时将打印原始文档字符串：

>>> help(obj.somemethod)

Help on method somemethod in module __main__:

somemethod(a: int, b: int = 5) method of __main__.MyClass instance
    This is somemethod.
    
    Parameters
    ----------
    a:
        This is a.
    b:
        The b is optional argument. (Default: 5)
:

而不是这样（当省略 @ 时）包裹(func)):

>>> help(obj.somemethod)

Help on method _decorator in module __main__:

_decorator(*args, **kwargs) method of __main__.MyClass instance
(END)

Answer 3

如果您使用基于类的装饰器实现，这里有一个示例。

import functools
from typing import Any, Callable


class UpdateBackupStatus:

    def __call__(self, f: Callable) -> Any:
        @functools.wraps(wrapped=f)
        def wrapper(calling_instance, *args, **kwargs):
            batch_id = calling_instance.batch_id
            if batch_id is None:
                raise ValueError(
                    "batch_id is required"
                )
            # pre-logic goes here
            response = f(calling_instance, *args, **kwargs)
            # post-logic goes here
            return response

我个人不喜欢在这种情况下使用 self 作为变量名来引用原始调用者。它可能会产生可读性问题。相反，使用不同的唯一名称来调用它（在本例中，我使用 - calling_instance ）

用法如下：

class SomeOtherClass:
    batch_id: str

    def __init__(
        self,
        batch_id: str,
    ):
        self.batch_id = batch_id

    @UpdateBackupStatus()
    def backup_table(self, table_name: str):
        # do something
        pass

SomeOtherClass 的 batch_id 属性是现在可以从装饰器访问。