2012-06-09 13 views
8

Mi chiedo se esiste una CLI come "man.py" dedicata a Python?Esiste un 'uomo' per Python?

ex,

man.py os.system 
> system(command) -> exit_status 
> 
> Execute the command (a string) in a subshell. 

risposta

10

Il modo più semplice è usare pydoc function sul guscio, con function essendo o il nome di un incorporata o il nome qualificato (module.function) di una funzione in un modulo:

> PAGER=cat pydoc urllib.urlencode 
[[email protected]:~]> PAGER=cat pydoc urllib.urlencode 
Help on function urlencode in urllib: 

urllib.urlencode = urlencode(query, doseq=0) 
    Encode a sequence of two-element tuples or dictionary into a URL query string. 
... 

(PAGER=cat è stato utilizzato solo per rendere più copiare & pastable qui)

Quando si utilizza IPython, è possibile utilizzare function? per visualizzare la docstring di function o function?? per una vista più dettagliata che include il codice sorgente completo per le funzioni scritte in python.

Nella normale shell python è possibile utilizzare help(function) per questo. Tuttavia, a mio parere, il modo IPython è più comodo.

+0

+1 Per menzionare IPython – Levon

+1

o 'function' che è uguale a' 'funzione – Vidul

14

Il modulo pydoc lo fornisce:?

$ python -m pydoc os.system 
Help on built-in function system in os: 

os.system = system(...) 
    system(command) -> exit_status 

    Execute the command (a string) in a subshell. 
$ 
+0

pydoc è in/usr/bin. –

Problemi correlati