Função Help do Python

23 04 2008

Acredito que a maioria do pessoal que está desenvolvendo com Python esteja familiarizado
com o help do python
mas para aqueles que ainda não o conhecem vai ai algumas dicas:
A função help ativa a PyDoc para gerar um relatório em texto simples parecido com as manpages do linux
para usa-lo é simples:

>>> # invoco o modulo os
>>> import os
>>> # tudo bem, mas e ai o que ele faz?
>>>help(os)
NAME
os – OS routines for Mac, DOS, NT, or Posix depending on what system we’re on.

FILE
/usr/lib/python2.4/os.py

MODULE DOCS

http://www.python.org/doc/current/lib/module-os.html

DESCRIPTION
This exports:
– all functions from posix, nt, os2, mac, or ce, e.g. unlink, stat, etc.
– os.path is one of the modules posixpath, ntpath, or macpath
– os.name is ‘posix’, ‘nt’, ‘os2′, ‘mac’, ‘ce’ or ‘riscos’
– os.curdir is a string representing the current directory (‘.’ or ‘:’)
– os.pardir is a string representing the parent directory (‘..’ or ‘::’)
– os.sep is the (or a most common) pathname separator (‘/’ or ‘:’ or ‘\\’)
– os.extsep is the extension separator (‘.’ or ‘/’)
– os.altsep is the alternate pathname separator (None or ‘/’)
– os.pathsep is the component separator used in $PATH etc
– os.linesep is the line separator in text files (‘\r’ or ‘\n’ or ‘\r\n’)
– os.defpath is the default search path for executables
– os.devnull is the file path of the null device (‘/dev/null’, etc.)

Programs that import and use ‘os’ stand a better chance of being
portable between different platforms. Of course, they must then
only use functions that are defined by all platforms (e.g., unlink
and opendir), and leave all pathname manipulation to os.path
(e.g., split and join).
[...]

Outro exemplo do uso do help
>>>help([])
[...]
|
| append(…)
| L.append(object) — append object to end
|
| count(…)
| L.count(value) -> integer — return number of occurrences of value
|
| extend(…)
| L.extend(iterable) — extend list by appending elements from the iterable
|
| index(…)
| L.index(value, [start, [stop]]) -> integer — return first index of value
|
| insert(…)
| L.insert(index, object) — insert object before index
|
| pop(…)
| L.pop([index]) -> item — remove and return item at index (default last)
|
| remove(…)
| L.remove(value) — remove first occurrence of value
|
| reverse(…)
| L.reverse() — reverse *IN PLACE*
|
| sort(…)
| L.sort(cmp=None, key=None, reverse=False) — stable sort *IN PLACE*;
| cmp(x, y) -> -1, 0, 1
[...]

note que é diferente e mais esclarecedor do que o dir, veja a saída do dir para o mesmo exemplo acima
>>> dir([])
['__add__', '__class__', '__contains__', '__delattr__', '__delitem__', '__delslice__', '__doc__', '__eq__', '__ge__', '__getattribute__', '__getitem__', '__getslice__', '__gt__', '__hash__', '__iadd__', '__imul__', '__init__', '__iter__', '__le__', '__len__', '__lt__', '__mul__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__reversed__', '__rmul__', '__setattr__', '__setitem__', '__setslice__', '__str__', 'append', 'count', 'extend', 'index', 'insert', 'pop', 'remove', 'reverse', 'sort']

NOTA
uma maneira mais interativa de usar o help é da seguinte maneira:
>>>help()
Welcome to Python 2.4! This is the online help utility. If this is your first time using Python, you should definitely check out the tutorial on the Internet at http://www.python.org/doc/tut/.
Enter the name of any module, keyword, or topic to get help on writing
Python programs and using Python modules. To quit this help utility and
return to the interpreter, just type “quit”.

To get a list of available modules, keywords, or topics, type “modules”,
“keywords”, or “topics”. Each module also comes with a one-line summary
of what it does; to list the modules whose summaries contain a given word
such as “spam”, type “modules spam”.

Digamos que agora você precisa saber mais sobre o modulo sys:
help>sys
Help on built-in module sys:

NAME
sys

FILE
(built-in)

MODULE DOCS

http://www.python.org/doc/current/lib/module-sys.html

DESCRIPTION
This module provides access to some objects used or maintained by the
interpreter and to functions that interact strongly with the interpreter.

Dynamic objects:

argv — command line arguments; argv[0] is the script pathname if known
path — module search path; path[0] is the script directory, else ”
modules — dictionary of loaded modules

displayhook — called to show results in an interactive session
excepthook — called to handle any uncaught exception other than SystemExit
To customize printing in an interactive session or to install a custom
top-level exception handler, assign other functions to replace these.

exitfunc — if sys.exitfunc exists, this routine is called when Python exits
Assigning to sys.exitfunc is deprecated; use the atexit module instead.

stdin — standard input file object; used by raw_input() and input()
stdout — standard output file object; used by the print statement
stderr — standard error object; used for error messages
By assigning other file objects (or objects that behave like files)
to these, it is possible to redirect all of the interpreter’s I/O.
[...]

Bom gente como vocês podem ver com o python é muito simples consultar a documentação, então agora
não tem conversa né, precisou já sabem pra onde recorrer né :)

About these ads

Ações

Informação

Deixe uma resposta

Preencha os seus dados abaixo ou clique em um ícone para log in:

Logotipo do WordPress.com

Você está comentando utilizando sua conta WordPress.com. Sair / Alterar )

Imagem do Twitter

Você está comentando utilizando sua conta Twitter. Sair / Alterar )

Foto do Facebook

Você está comentando utilizando sua conta Facebook. Sair / Alterar )

Foto do Google+

Você está comentando utilizando sua conta Google+. Sair / Alterar )

Conectando a %s




Seguir

Obtenha todo post novo entregue na sua caixa de entrada.

%d blogueiros gostam disto: