¿Hay un 'hombre' para pitón?

Question

¿Me pregunto si hay una CLI como 'man.py' dedicada a Python?

ex,

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

Answer 1

La forma más sencilla es utilizar pydoc function en la cáscara, con function ser ya sea el nombre de una orden interna o el nombre calificado (module.function) de una función en un módulo:

> PAGER=cat pydoc urllib.urlencode 
[adrian@hades:~]> 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 fue utilizado solamente para que sea copia & pastable aquí)

Al usar IPython, puede usar function? para ver la cadena de documentación de function o function?? para obtener una vista más detallada que incluya el código fuente completo para las funciones escritas en python.

En el shell python normal puede usar help(function) para esto. Sin embargo, en mi opinión, el modo IPython es más cómodo.

Answer 2

El módulo pydoc proporciona que:??

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