3ENGINE

Programación y otros cachivaches

Etiqueta: Python

Página 3/6

Tecnologia

Decoradores Python con parámetros


Ya expliqué en una entrada anterior que es eso de los decordadores Python. Si todavia no lo has hecho te recomiendo que leas el artículo antes de seguir.

Decoradores con parámetros

Hace unos días tuve la necesidad de pasar parámetros a un decorador. Queria crear un decorador que retornara un valor por defecto si la función decorada retorna valor nulo. Entonces me di cuenta que mi anterior artículo no cubria esta aspecto.

Este es mi decorador:

Tenemos una funcion un tanto maleducada 😉 que sólo saluda a personas que se llamen David. La vamos a decorar para que retorne un saludo por defecto en caso que retorne nulo:

Un test:

Y esta es la salida:

Otra posible aplicación de los decoradores con parámetros, es si por ejemplo queremos devolver un valor por defecto sólo si la llamada a un función genera una excepción.

El código completo:

Y esta es la salida:




Tecnologia

Utilizar markdown en modulos Pypi


Es posible que una vez subido un módulo Python a Python Package Index notes que la descripción del módulo (README) que aparece en la página PyPi no esté bien formateada.

Si formateaste la descripción del módulo con Markdown, caso bastante probable si tienes las fuentes en Github, tienes que saber que PyPi únicamente acepta reStructuredTxt como formato de descripción.

Las solución drástica es cambiar la descripción al formato aceptado por PyPi. O bien puedes traducir «on fly» de un formato a otro en setup.py.

Para hacer esto, primero instala pandoc. Se trata de una utilidad que es capaz de convertir ficheros de un lenguaje de marcado a otro.

Después instala el módulo Python pyandoc:

Por último modifica setup.py:

Las líneas de la 6 a la 16 averigua la ruta donde se encuentra pandoc instalado mediante una llamada al sistema del comando which. Un try/catch es necesario para garantizar la instalación del módulo mediante python setup.py install en un sistema sin pandoc instalado.




Tecnologia

Clases abstractas en Python


Python de forma nativa no soporta clases abstractas, pero eso no significa que no existan. A partir de la versión 2.6, Python trae el módulo abc (abstract base classes) de acuerdo a PEP 3119, que consigue emular la abstracción de clases mediante metaclases y decoradores Python.

python abstract class

Metaclases

Un buen artículo muy recomendable que consigue explicar el mundillo de las metaclases sin pegarse un tiro en la cabeza, es este de crysol Ahí va la virgen! Metaclases! (con Python). Pero para hacerse una idea, diremos que una metaclase es una clase cuyas instancias son clases en lugar de objetos.

Es decir, si para construir un objeto usas una clase, para construir una clase usas una metaclase. Es importante entender que en Python todo es un objeto (incluso las clases, los modulos, los tipos de datos, etc..) y por lo tanto las clases, al ser objetos, son instancias de una metaclase.

En el caso que nos ocupa, es interesante porque permite modificar el comportamiento o características de una clase en el momento de su creación.

Decoradores

Respecto a los decoradores pues prefiero recomendaros un artículo de la casa 😉 Decoradores Python. A modo de resumen diremos que un decorador Python permite añadir funcionalidad extra a una función mediante un wrapper (envoltorio).

Clases abstractas en Python

Para empezar. Definiremos un método abstracto mediante el uso del decorador @abstractmethod. Al instanciar la clase… ¡Sorpresa! ha funcionado. Python no se queja.

Para que el invento funcione, la clase Vehicle tiene que heredar de la metaclase ACBMeta. Con un poco de ‘azucar sintáctico’ (¿what?) mediante __metaclass__ es fácil. Ahora Python hace lo esperado, se queja porque no es posible instanciar una clase con métodos abstractos.

Para curiosos. En el repositorio oficial está la implementación de la metaclase ABCMeta. Ahora vamos a crear una clase Car que herede de Vehicle y que sobreescriba el método abstracto.

Como curiosidad, podemos hacer ‘trampas’ e invocar al método abstracto mediante el uso de super().

Con el decorador @abstractproperty podemos crear propiedades abstractas. Aquí un ejemplo.

El anterior ejemplo definimos una propiedad de lectura. También es posible crear propiedades abstractas de lectura y escritura (getter & setter) pero esto solo es posible hacerlo sin ‘azúcar sintáctico’




Tecnologia

Decoradores Python


Aunque los decoradores Python coinciden en el nombre con el Patron Decorador y guardan cierta similitud, no hay que confundirlos.

Decoradores Python

Mientras que el Patron Decorador permite añadir dinámicamente funcionalidad a un objeto, el objetivo principal de un decorador Python es añadir funcionalidad extra a una funcion. Para añadir funcionalidad hacemos uso de un wrapper. Un envoltorio, es decir, envolvemos la funcion. Para hacer esto, podemos usar clases u objetos.

Usando clases como decoradores Python

Para que esto funcione, el objeto devuelto por el decorador tiene que estar preparado para ser utilizado como una función. Esto significa que debe ser invocable. Para conseguir esto la clase debe implementar la función especial __call__ que permite emular un objeto como si fuera una función.

Ejemplo 1

Para hacerlo menos engorroso, Python proporciona soporte para envolver una función en un decorador mediante el símbolo @.

Ejemplo 2. La función se invoca en __init__

Ejemplo 3. Guarda la referencia en __init__ y se invoca en __call__

Ejemplo 4. Invocar y guarda el resultado de la función __init__ y hacer uso en __call__

Ejemplo 5. Invoca en __call__ y habilitar el paso de parámetros

Usando funciones como decoradores Python

Hemos visto que la única condición para que funcione un decorador es que éste sea invocable. En los ejemplos anteriores, hemos reemplazado la función original con un objeto de una clase que sobreescribe el método __call__. Podemos reescribir los ejemplos anteriores utilizando una función en lugar de una clase, aunque no da tanto juego.

Ejemplo 6. Generar un mensaje de bienvenida en formato HTML

Como antes hemos visto, para hacerlo menos engorroso hacemos uso del símbolo @.

Ejemplo 7. Un logger para registrar los parámetros pasados a la función

Ejemplo 8. Comprobar con ‘assert’ que el argumento es un entero

Nota: por defecto los asserts están activados. Para desactivarlos hay que pasar el parámetro -O al interprete de comandos.

Built-in Functions

Python incorpora algunas funciones útiles que pueden usarse como decoradores, por ejemplo classmethod, property y staticmethod

Ejemplo 9. uso de @staticmethod y @property para decorar funciones de una clase

Os dejo un enlace con una presentación sobre decoradores avanzados en Python.