Python – Pydoc

PyDOC_cleitonbueno.com

Pydoc é uma grande ferramenta do leque do Python, que pode ser utilizada para gerar documentação dos módulos baseado em docstrings[1] e também ter acesso a essa documentação, naquele famoso estilo man-pages.

Imagina você querendo saber informações ou ajuda sobre um modulo mais esta sem internet, então nosso amigo Google não poderá ajudar, vamos de pydoc[2] então.

O mais trivial e que sempre uso é pydoc e o nome do modulo, irei tomar como exemplo o serial (modulo de comunicação serial do Python [pyserial][3]).

Irei postar só uma parte do conteúdo, o mais legal e que mais gosto de usar é o acesso direto no que preciso. Como assim? Por exemplo, eu quero conhecer a classe Serial do modulo, então faço assim.

Muito legal, agora eu sei que quando crio um objeto com serial.Serial(), tenho todos estes métodos para usar, e se eu precisar de ajuda ou queira conhecer algum destes métodos.

No exemplo acima, estou acessando o conteúdo de flushInput e read da classe Serial.

E quando você quer pesquisar algo e não sabe o nome do modulo, vamos de pydoc[2] também.

Com o parâmetro -k estamos especificando uma palavra-chave para busca, e no caso usei serial.

Você acha que acabou? Imagina esse poder além dos terminais. E você tem, pois consegue subir um “webserver” para acessar tudo isso localmente pelo navegador.

pydoc_server_cleitonbueno.com

Procurando o modulo serial na pagina.

pydoc_server_serial_cleitonbueno.com

Acessando o modulo e visualizando o conteúdo.

pydoc_server_serial_info_cleitonbueno.com

E para fechar com chave de ouro, e se pudéssemos pesquisar sobre o que quiséssemos  e pudesse gerar uma pagina dessas para visualizar via web, vamos fazer.

E gerou uma pagina chamada serial.html no local que esta sendo executado o pydoc, com todo o conteúdo do modulo serial que pode ser visualizado via web e até impresso.

Isso porque eu não falei que dentro do Python você pode usar o help() ;)

Espero que tenham gostado, e até a próxima!

Referências

[1] – http://pt.wikibooks.org/wiki/Python/Conceitos_b%C3%A1sicos/Coment%C3%A1rios_e_docstrings

[2] – https://docs.python.org/2/library/pydoc.html

[3] – https://pypi.python.org/pypi/pyserial

Share Button

CC BY-NC-SA 4.0 Python – Pydoc by Cleiton Bueno is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.