Lien vers la méthode de classe dans docstring python

Je souhaite ajouter un lien vers une méthode de ma classe à partir de la docstring d'une autre méthode de la même classe. Je veux que le lien fonctionne dans sphinx et de préférence aussi dans Spyder et d'autres IDE Python.

J'ai essayé plusieurs options et n'en ai trouvé qu'une qui fonctionne, mais c'est encombrant.

Supposons la structure suivante dans mymodule.py

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

J'ai essayé les options suivantes pour <link to foo>:

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

Le seul qui produit effectivement un lien est: func: `mymodule.MyClass.foo`, mais le lien est affiché comme mymodule.MyClass.foo()et je veux un lien qui est affiché comme foo()ou foo.
Aucune des options ci-dessus ne produit de lien dans Spyder.

Merci de votre aide.

La solution qui fonctionne pour Sphinx est de préfixer la référence avec ~.

Selon la documentation Sphinx sur la syntaxe des références croisées ,

Si vous préfixez le contenu avec ~, le texte du lien ne sera que le dernier composant de la cible. Par exemple ~Queue.Queue.get,: py: meth: fera référence à Queue.Queue.get mais n'affichera que get comme texte du lien.

La réponse est donc:

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

Il en résulte un html ressemblant à ceci:, This method does the same as foo()et foo()est un lien.

Cependant, notez que cela peut ne pas s'afficher dans Spyder sous forme de lien.

Si vous souhaitez spécifier manuellement le texte du lien, vous pouvez utiliser:

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

Pour plus d'informations, consultez la rubrique Références croisées d'objets Python .

Il me semble que vous n'avez qu'à ajouter __name__ou __doc__à votre expression pour obtenir ce que vous voulez.
Je ne suis toujours pas sûr d'avoir bien compris l'objectif

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__

résultat

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

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