Collegamento al metodo di classe in docstring python

Voglio aggiungere un collegamento a un metodo nella mia classe dall'interno della docstring di un altro metodo della stessa classe. Voglio che il collegamento funzioni in sphinx e preferenzialmente anche in Spyder e altri IDE di Python.

Ho provato diverse opzioni e ne ho trovata solo una che funziona, ma è ingombrante.

Supponiamo che la seguente struttura in mymodule.py

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

Ho provato le seguenti opzioni per <link to foo>:

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

L'unico che produce effettivamente un collegamento è: func: `mymodule.MyClass.foo`, ma il collegamento è mostrato come mymodule.MyClass.foo()e voglio un collegamento che sia mostrato come foo()o foo.
Nessuna delle opzioni precedenti produce un collegamento in Spyder.

Grazie per l'aiuto.

La soluzione che funziona per Sphinx è anteporre al riferimento ~.

Secondo la documentazione Sphinx sulla sintassi dei riferimenti incrociati ,

Se anteponi al contenuto ~, il testo del link sarà solo l'ultimo componente del target. Ad esempio ~Queue.Queue.get,: py: meth: farà riferimento a Queue.Queue.get ma visualizzerà solo get come testo del collegamento.

Quindi la risposta è:

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

Ciò si traduce in un html simile a questo:, This method does the same as foo()ed foo()è un collegamento.

Tuttavia, tieni presente che questo potrebbe non essere visualizzato in Spyder come collegamento.

Se vuoi specificare manualmente il testo del link puoi usare:

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

Per ulteriori informazioni, controlla Riferimenti incrociati a oggetti Python .

Mi sembra che devi solo aggiungere __name__o __doc__alla tua espressione per ottenere quello che vuoi.
Non sono ancora sicuro di aver compreso correttamente l'obiettivo

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__

risultato

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

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