Fonction "help" de python: impression de docstrings

Est-il une option pour imprimer la sortie de l'aide('myfun'). Le comportement que je vois est que la sortie est imprimé sur les mst.et le script attend une entrée de l'utilisateur (c'est à dire de type " q " pour continuer).

Il doit y avoir un paramètre à définir ce à juste dump docstrings.

Sinon, si je pouvais juste faire un dump de la docstring PLUS le "def f(args):" la ligne qui serait bien aussi.

De la recherche pour "python à l'aide de la fonction" est comique. 🙂 Peut-être que je suis absent quelques belles pydoc page quelque part là-bas qui explique tout?

source d'informationauteur mathtick

  1. 15

    Pour obtenir exactement l'aide imprimé par help(str) dans la variable strhelp:

    import pydoc
strhelp = pydoc.render_doc(str, "Help on %s")

    Bien sûr, vous pouvez ensuite l'imprimer facilement sans pagination, etc.

  2. 3

    Juste

    print obj.__doc__

    ou 

    myvar = obj.__doc__

    La fonction d'aide existe pour afficher l'aide, de manière interactive, il peut être récupéré assez facilement sans.

  3. 2

    Vous avez déjà vu de référence à la docstring, la magie __doc__ variable qui contient l'organe de l'aide:

    def foo(a,b,c): 
   ''' DOES NOTHING!!!! '''
   pass

print foo.__doc__ # DOES NOTHING!!!!

    Pour obtenir le nom d'une fonction, il suffit d'utiliser __name__:

    def foo(a,b,c): pass

print foo.__name__ # foo

    Le moyen d'obtenir la signature d'une fonction qui n'est pas intégré à vous pouvez utiliser le func_code bien et que vous pouvez lire sa co_varnames:

    def foo(a,b,c): pass
print foo.func_code.co_varnames # ('a', 'b', 'c')

    Je n'ai pas trouvé comment faire de même pour les fonctions intégrées.

  4. 1
    >>> x = 2
>>> x.__doc__
'int(x[, base]) -> integer\n\nConvert a string or number to an integer, if possi
ble.  A floating point\nargument will be truncated towards zero (this does not i
nclude a string\nrepresentation of a floating point number!)  When converting a
string, use\nthe optional base.  It is an error to supply a base when converting
 a\nnon-string. If the argument is outside the integer range a long object\nwill
 be returned instead.'

    Est que ce que vous avez besoin?

    edit - vous pouvez print(x.__doc__) et relative à la signature de la fonction, vous pouvez générer à l'aide de la inspect module.

    >>> inspect.formatargspec(inspect.getargspec(os.path.join))
'((a,), p, None, None)'
>>> help(os.path.join)
Help on function join in module ntpath:

join(a, *p)
    Join two or more pathname components, inserting "\" as needed