Para quem não sabe, quando desejamos informações de ajuda sobre algum módulo/método/builtin, podemos invocar o builtin help(). Por exemplo, quero saber detalhes sobre a função len():
>>> help(len) Help on built-in function len in module __builtin__: len(...) len(object) -> integer Return the number of items of a sequence or mapping. (END)
Isso irá ler o atributo __doc__ do objeto em questão. Mas, em minha opinião de preguiçoso, é um pouco chato sempre chamar a função help(), passando como argumento o objeto do qual desejamos mais informações. Se você concorda comigo, saiba que o ipython [1] fornece um “atalho” bem simples para acessarmos a documentação de determinado objeto. Basta adicionar um ponto de interrogração ao final do nome do objeto, que o ipython mostra o texto de ajuda. Veja a figura abaixo:
Além da interrogação simples (?), podemos utilizar também a interrogação dupla (??) para obter informações adicionais sobre o método/módulo, incluindo o seu código-fonte, quando disponível. Veja abaixo:
É claro que as vantagens do ipython vão muito além desse recurso. Mas, as outras ficam para outro post.
3 comentários sobre “Acesso fácil à documentação com ipython”
Deixe um comentário
Você precisa fazer o login para publicar um comentário.


acho que é esse o feature que vai fazer eu usar o ipython de vez… 🙂
Pois é. Essa feature me ganhou quando cansei de escrever help(blablabla). 😛