在 Python 中使用类属性通过装饰器修改文档字符串

Question

我正在尝试创建一个在类中调用的装饰器，它会从该类中提取属性，并使用这些类属性来编辑函数的文档字符串。

我的问题是我找到了编辑函数文档字符串的装饰器示例（将函数的 __doc__ 属性设置为新字符串），并且我还找到了从父类中提取属性的装饰器示例（通过将self 传递给装饰器），但我还没有找到能够同时实现这两种功能的装饰器示例。

我尝试将这两个示例结合起来，但它不起作用：

def my_decorator(func):
    def wrapper(self, *args, **kwargs):
        name = func.__name__  # pull function name
        cls = self.__class__.__name__ # pull class name
        func.__doc__ = "{} is new for the function {} in class {}".format(
            str(func.__doc__), name, cls) # set them to docstring
        return func(self, *args, **kwargs)
    return wrapper

class Test():
    @my_decorator
    def example(self, examplearg=1):
        """Docstring"""
        pass

有了这个，我希望下面会返回“Docstring is now new for the function: example”：

Test().example.__doc__

相反，它返回None。

编辑：请注意，我对如何具体访问类的名称不感兴趣，而是对如何访问一般的类属性感兴趣（这里使用self.__class__.__name__ 作为示例）。

Answer 1

example 替换为wrapper；装饰相当于

def example(self, examplearg=1):
    """Docstring"""
    pass

 example = my_decorator(example)

所以你需要设置wrapper.__doc__，而不是func.__doc__。

def my_decorator(func):
    def wrapper(self, *args, **kwargs):
        return func(self, *args, **kwargs)
    wrapper.__doc__ = "{} is new for the function {}".format(
        str(func.__doc__),
        func.__name__) 
    return wrapper

请注意，在您调用my_decorator 时，您没有任何关于装饰函数/方法属于哪个类的信息。你必须明确地传递它的名字：

def my_decorator(cls_name):
    def _decorator(func):
        def wrapper(self, *args, **kwargs):
            return func(self, *args, **kwargs)
        wrapper.__doc__ = "{} is new for function {} in class {}".format(
            func.__doc__, 
            func.__name__,
            cls_name)
       return wrapper
    return _decorator

class Test():
    @my_decorator("Test")
    def example(self, examplearg=1):
        """Docstring"""

    # or
    # def example(self, examplearg=1):
    #     """Docstring"""
    #
    # example = my_decorator("Test")(example)

Answer 2

您可以在调用装饰器时简单地修改__doc__属性，并使用函数的点分隔__qualname__属性的第一个标记来获取类名：

def my_decorator(func):
    func.__doc__ = "{} is new for the function {} in class {}".format(
            str(func.__doc__), func.__name__, func.__qualname__.split('.')[0])
    return func

这样：

class Test():
    @my_decorator
    def example(self, examplearg=1):
        """Docstring"""
        pass
print(Test().example.__doc__)

会输出：

Docstring is new for the function example in class Test

Answer 3

事实证明，从类中访问类属性是不可能的，因为调用装饰器时该类尚未执行。所以最初的目标——在类中使用装饰器来访问类属性——似乎是不可能的。

但是，感谢 jdehesa 为我指出了一种允许使用类装饰器访问类属性的解决方法，这里是：Can a Python decorator of an instance method access the class?。

我能够使用类装饰器来使用类属性来更改特定方法的文档字符串，如下所示：

def class_decorator(cls):
    for name, method in cls.__dict__.items():
        if name == 'example':
            # do something with the method
            method.__doc__ = "{} is new for function {} in class {}".format(method.__doc__, name, cls.__name__)
            # Note that other class attributes such as cls.__base__ 
            # can also be accessed in this way
    return cls

@class_decorator
class Test():
    def example(self, examplearg=1):
        """Docstring"""

print(Test().example.__doc__)
# Returns "Docstring is new for function example in class Test"