链接到 python 文档字符串中的类方法

Question

我想从同一类的另一个方法的文档字符串中添加指向我的类中的方法的链接。我希望该链接可以在 sphinx 中使用，并且优先在 Spyder 和其他 Python IDE 中使用。

我尝试了几个选项，发现只有一个有效，但它很麻烦。

假设mymodule.py中的结构如下

def class MyClass():
    def foo(self):
        print 'foo'
    def bar(self):
        """This method does the same as <link to foo>"""
        print 'foo'

我为<link to foo> 尝试了以下选项：

• :func:`foo`
• :func:`self.foo`
• :func:`MyClass.foo`
• :func:`mymodule.MyClass.foo`

唯一能有效产生链接的是:func:`mymodule.MyClass.foo`，但链接显示为mymodule.MyClass.foo()，我想要一个显示为foo()或foo的链接。 以上选项都不会在 Spyder 中生成链接。

感谢您的帮助。

Answer 1

适用于 Sphinx 的解决方案是在引用前加上 ~。

根据Cross-referencing Syntax 上的 Sphinx 文档，

如果你在内容前面加上~，链接文本只会是最后一个 目标的组成部分。例如，:py:meth:~Queue.Queue.get 将 请参阅 Queue.Queue.get 但仅将 get 显示为链接文本。

所以答案是：

class MyClass():
    def foo(self):
        print 'foo'
    def bar(self):
        """This method does the same as :func:`~mymodule.MyClass.foo`"""
        print 'foo'

这会产生一个看起来像这样的 html：This method does the same as foo()，而foo() 是一个链接。

但是，请注意，这可能不会在 Spyder 中显示为链接。

Answer 2

如果您想手动指定可以使用的链接文本：

:func:`my text <mymodule.MyClass.foo>`

欲了解更多信息，请查看Cross-referencing Python objects。

Answer 3

在我看来，您只需在表达式中添加__name__ 或__doc__ 即可获得所需的内容。
我仍然不确定是否正确理解了目标

class MyClass():
    def foo(self):
        """I am the docstring of foo"""
        print 'foo'
    def bar(self):
        """This method does the same as <link to foo>"""
        print 'foo'

print
print MyClass.foo
print MyClass.foo.__name__
print MyClass.foo.__doc__
print
print MyClass.__dict__['foo']
print MyClass.__dict__['foo'].__name__
print MyClass.__dict__['foo'].__doc__

结果

<unbound method MyClass.foo>
foo
I am the docstring of foo

<function foo at 0x011C27B0>
foo
I am the docstring of foo