DOCSTRINGS Y VARIABLES DE CLASE

PITÓN VOLCÁNICO DEL ANAMBRO HACIA EL EXTREMO ESTE DEL MACIZO DE ANAGA, NORESTE DE TENERIFE.

      Como ya hemos aprendido en las páginas anteriores, la documentación del código, es decir, explicar lo que hace y, a ser posible, introducir algún ejemplo de uso, esto es, el docstring resulta más que aconsejable, tanto para mantener el propio código como para clarificar su utilidad/funcionalidad tanto a uno mismo, andando el tiempo, como para terceros que trabajen sobre nuestro propio programa.

Para conseguir esto tan solo tenemos que cumplir tres reglas básicas:

1. Cada clase, función y método (no necesariamente las propiedades o atributos con sus valores respectivos pues éstos ya se explican por sí mismos) puede tener un docstring que deberá ubicarse justo por debajo de la modelización, en el caso de las clases, o de la declaración o definición justo debajo de las funciones o métodos.
2. Debe mostrase con la misma indentación a la que se somete el cuerpo de la función.
3. Cada docstring debe ir encerrado entre comillas dobles o simples, salvo en el caso de que necesitáramos más de una línea de texto, con lo que podemos recurrir a la triple comilla.

Es posible e, incluso, deseable, añadir, como ya hemos mencionado arriba, pequeños ejemplos de uso, advertencias, consejos, etc.

Veámoslo con el siguiente ejemplo:

       REALMENTE, EN ESTE EJEMPLO, DEBAJO DE self.area = base * altura,

HEMOS INTRODUCIDO UNA ACLARACIÓN, PUES ES EL PROPIO MÉTODO INICIALIZADOR O CONSTRUCTOR QUIEN, APROVECHANDO LA FLEXIBILIDAD DE PYTHON, REALIZA EL CÁLCULO (LUEGO HACE UNA FUNCIÓN) CUYO RESULTADO ALMACENA EN UNA VARIABLE, self.area, QUE DEVIENE EN PROPIEDAD DE LA CLASE Rectangulo. ESTE RESULTADO LO OBTENDREMOS YA DIRECTAMENTE AL LLAMAR A LA INSTANCIA r DE CLASE Rectángulo. TAN SÓLO FIJARSE EN QUE LLAMAMOS A r.area, QUE ES COMO SE LLAMAN A LAS PROPIEDADES Y NO r.area(), QUE ES COMO SE LLAMAN A LOS MÉTODOS.

VARIABLES DE CLASE

Su propio nombre nos indica el camino: se trata de variables que no se asignan directamente a una instancia aunque, por supuesto, sí que pueden ser llamadas desde éstas, en tanto que no se han declarado dentro del bloque de código de ninguna función definida, esto es, que no se tratan de variables locales (podemos repasar qué es una variable global y una variable local en este mismo manual para refrescar la memoria) sino que se declaran dentro de la modelización de la clase, es decir, que actúa como una suerte de variable global, justo debajo de la documentación de la clase y, habitualmente, después del inicializador __init__(self), dado que no tiene sentido, aunque luego realmente funcione, el declarar variables de clase sobre una clase que aún no ha sido construida con __new__() e inicializada con __init__(self), ¿no os parece?

El hecho de declarar una variable fuera, externalizadas, de los bloques de código de las instancias nos permite invocarlas fuera de las instancias.

Como siempre, ejemplo al canto:

Veamos un sencillo esquema de similitud (no es exactamente lo mismo, pero nos vale):

ANOCHECE EN EL PARQUE NACIONAL DE LAS CAÑADAS DEL TEIDE, CON EL VOLCÁN AL FONDO Y LAS LUCES DE LOS COCHES ATRAVESANDO LA CARRETERA A LAS FALDAS. CORAZÓN DE TENERIFE.