python "help": print docstrings

Question

Esiste un'opzione per stampare l'output della guida ('myfun'). Il comportamento che sto vedendo è che l'output è stampato su std.out e lo script attende l'input dell'utente (ad esempio, digita "q" per continuare).

Ci deve essere un'impostazione per impostare questa opzione per scaricare solo le didascalie.

In alternativa, se potessi semplicemente scaricare la doctring PLUS la "def f (args):" linea che andrebbe bene anche.

La ricerca di "python help function" è comica. :) Forse mi manca qualche bella pagina pydoc da qualche parte là fuori che spiega tutto?

Answer 1

per ottenere esattamente l'aiuto che viene stampato dal help(str) nella variabile strhelp:

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

Naturalmente si può quindi facilmente stampare senza paginazione, ecc

Answer 2

>>> 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.' 

È quello che ti serviva?

modifica - è possibile print(x.__doc__) e per quanto riguarda la firma della funzione, è possibile creare utilizzando il modulo inspect.

>>> 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 

Answer 3

Proprio

print obj.__doc__ 

o

myvar = obj.__doc__ 

La funzione di aiuto esiste per visualizzare la guida in modo interattivo, può essere recuperato abbastanza facilmente senza di essa.

Answer 4

Avete già visto riferimento alla docstring, la magia __doc__ variabile che contiene il corpo della guida:

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

print foo.__doc__ # DOES NOTHING!!!! 

per ottenere il nome di una funzione, è sufficiente utilizzare __name__:

def foo(a,b,c): pass 

print foo.__name__ # foo 

il modo per ottenere la firma di una funzione che non è costruito in è possibile utilizzare la proprietà func_code e da che si può leggere i suoi co_varnames:

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

Non ho trovato il modo di fare lo stesso per le funzioni incorporate.