1

我正在使用 Sphinx 来记录我用 Python 编写的一些代码。我在我的项目中使用了 Stuart Gathman 的 pymilter 库，所以我的很多函数都被装饰了。我在 SO 上看到了关于装饰函数和 Sphinx 的问题，但它们不适用于我，因为我无法修改 milter 库代码。

关于如何在不必重新编写我的 Sphinx 文档的情况下解决这个问题的想法会很棒。

谢谢

@Milter.noreply
def header( self, name, hval ):
    """
    Processes headers from the incoming message and writes them to a new variable for database storage.
    """
    rgxSubject = re.compile( '^(subject)', re.IGNORECASE | re.DOTALL )
    rgxMessageID = re.compile( '^(message-id)', re.IGNORECASE | re.DOTALL )


    self.fp.write( "%s: %s\n" % ( name, hval ) )
    self.headers.append( "%s: %s\n" % ( name, hval ) )

    if ( rgxSubject.search( name ) ) or ( rgxMessageID.search( name ) ):
        self.log.info( "%s: %s" % ( name, hval ) )
        self.subjMsgId[name] = hval
        if ( rgxSubject.search( name ) ): self.Subject = hval

    return Milter.CONTINUE
4

1 回答 1

0

你可以使用这个：

import functools

def header( self, name, hval ):
   pass
   # ...

header = functools.wraps(header)(Milter.noreply(header))

举个例子说明这是做什么的，考虑这个装饰器和函数：

>>> def dec(f):
...    def wrap():
...       return f()
...    return wrap
... 
>>> 
>>> def f():
...    """docstring"""
...    print 'hey'

装饰器只是一个返回函数的可调用对象，因此您可以将函数作为参数调用装饰器，然后调用结果：

>>> dec(f)
<function wrap at 0x10909e758>
>>> dec(f)()
hey

但是正如您所指出的，问题在于__doc__and__name__变量没有被保留，因为装饰器没有使用functools.wraps：

>>> f.__doc__
'docstring'
>>> dec(f).__doc__
>>>

所以，既然你不能修改原来的装饰器定义，就自己把它包起来：

>>> functools.wraps(f)(dec(f))()
hey
>>> functools.wraps(f)(dec(f)).__doc__
'docstring'

您还可以定义自己的装饰器，将装饰器作为参数并正确包装函数。

于 2012-08-28T19:28:23.440 回答