Чтение документации Python для сторонних модулей - PullRequest
4 голосов
/ 13 марта 2010

Я недавно скачал модуль IMDbpy .. Когда я это сделаю,

import imdb
help(imdb)

я не получаю полную документацию .. Я должен сделать

im = imdb.IMDb()
help(im)

чтобы увидеть доступные методы. Мне не нравится этот интерфейс консоли. Есть ли лучший способ чтения документа? Я имею в виду все документы, связанные с модулем imdb на одной странице. .

Ответы [ 2 ]

10 голосов
/ 13 марта 2010

Использование pydoc

pydoc -w imdb

Это сгенерирует imdb.html в том же каталоге.


pydoc -p 9090 запустит HTTP-сервер на порту 9090, и вы сможете просмотреть всю документацию на http://localhost:9090/

1 голос
/ 13 марта 2010

в IPython вы могли бы сделать

[1]: import os
[2]: os?

< get the full documentation here >

# or you could do it on specific functions 
[3]: os.uname
<built-in function>



[4]: os.uname?

< get the full documentation here >


# Incase of modules written in python, you could inspect source code by doing
[5]: import string
[6]: string??

< hows the source code of the module >

[7]: string.upper??

< shows the source code of the function >
...