You also want an ePaper? Increase the reach of your titles
YUMPU automatically turns print PDFs into web optimized ePapers that Google loves.
Docstrings<br />
doCuMentaCión<br />
En capítulos anteriores ya comentamos en varias ocasiones que <strong>todos</strong><br />
los objetos cuentan con una variable especial __doc__ mediante la que<br />
indicar el propósito y uso del objeto. Estos son los llamados docstrings<br />
o cadenas de documentación.<br />
A estos atributos se les puede asociar el texto correspondiente explícitamente,<br />
asignándolo al literal cadena correspondiente, como con cualquier<br />
otra variable. Sin embargo, por conveniencia, <strong>Python</strong> ofrece un<br />
mecanismo mucho más sencillo y es que si el primer estamento de la<br />
definición del objeto es una cadena, esta se asocia a la variable __doc__<br />
automáticamente.<br />
def haz_algo(arg):<br />
“””Este es el docstring de la funcion.”””<br />
print arg<br />
print haz_algo.__doc__<br />
haz_algo.__doc__ = “””Este es un nuevo docstring.”””<br />
print haz_algo.__doc__<br />
Como vemos lo interesante de estas cadenas es que, a diferencia de los<br />
comentarios normales de <strong>Python</strong> y de los comentarios de otros lenguajes,<br />
las cadenas de documentación no se eliminan del bytecode, por lo<br />
que se pueden consultar en tiempo de ejecución, usando, por ejemplo,<br />
la función help del lenguaje, o utilizando la sentencia print como en el<br />
ejemplo anterior.<br />
>>> help(haz_algo)<br />
Help on function haz_algo in module __main__:<br />
haz_algo(arg)<br />
125
Change language