Probar en múltiples versiones de Python (Creación de paquetes de Python 3ª parte)

Hasta ahora las pruebas se ha ejecutado únicamente en la configuración del ordenador de trabajo. Es decir, en la versión de Python con la que estamos trabajando. Pero puede ser interesante probar que el paquete funciona con diferentes versiones de Python a la que tenemos instalada. Para probar en múltiples versiones de Python el código del paquete vamos a utilizar tox.

Esta entrada forma parte de la colección “Creación de paquetes de Python” que consta de las siguientes siete entradas:

1. Creación de paquetes de Python
2. Pruebas unitarias en Python
3. Probar en múltiples versiones de Python
4. Cobertura de las pruebas unitarias en Python
5. Gestionar las dependencias de paquetes Python
6. Documentar paquetes de Python
7. Distribuir paquetes de Python

Instalación y configuración de Tox

Tox es una herramienta de Python con la cual es posible automatizar y estandarizar los procesos de prueba en Python. Permitiendo probar fácilmente el código en más de un entorno. Es decir, facilita probar el código fácilmente en más de una versión de Python, como podría ser Python 3.7 y Python 2.7 al mismo tiempo. Para lo que es necesario configurar estos entornos en nuestra máquina.

Tox se puede instalar con pip como cualquier otro paquete de Python. Para lo que deberemos escribir en la terminal el siguiente comando pip install tox. Una vez hecho esto es necesario crear un archivo tox.ini en la carpeta raíz donde se encuentra el código que queremos probar. Un archivo básico para tox puede ser el que ha dejado la plantilla de Cookiecutter:

[tox]
envlist = py37,py36,py35

[testenv]
commands = pytest 
deps = pytest

En donde mediante la opción envlist se indican los entornos en los que deseamos probar el código. En este caso indicamos que se pruebe en Python 3.7, 3.6, etc. Posteriormente se indica los comandos que debe ejecutar tox. Si trabajamos con pytest solamente es necesario indicar este comando. Finalmente, en nuestro archivo se encuentran las dependencias, como solamente trabajamos con pytest esta es la única dependencia.

Con esto podemos ejecutar tox para lanzar las pruebas en cada uno de los entornos que se indicaron en la configuración. Pero antes de ese es necesario instalar los entornos.

Instalación de virtualenv

Anaconda es uno de los entornos de trabajo en Python más populares entre los científicos e ingenieros de datos. Por eso vamos a usar este entorno como ejemplo. Para disponer de múltiples entornos en anaconda es necesario instalar virtualenv, para lo que usaremos conda

conda install virtualenv

Es necesario realizar la instalación de virtualenv con conda en lugar de pip porque virtualenv necesita interactuar con la instalación de Anaconda.

Creación de los entornos en Acancoda

Una vez instalado virtualenv es necesario crear los entornos, en este caso también con conda. Por ejemplo, para crear un entorno de Python 3.6 deberemos escribir el siguiente comando

conda create -n py36 python=3.6 --yes  

Si lo que deseamos es crear un entorno con Python 3.5 debemos escribir

conda create -n py35 python=3.5 --yes  

Hacer que tox pueda encontrar los entornos en UNIX

Una vez creados los entornos estos se ubican generalmente, cuando trabajamos en una instalación de Anconada 3, en ~/opt/anaconda3/envs/ o en la ruta relativa donde se hubiese instalado. Ahora es necesario hacer que tox pueda encontrar estos archivos para lo que tenemos que crear un enlace simbólico en ~/opt/anaconda3/bin. En los sistemas Unix (Linux y macOS) esto se puede hacer situándonos en ~/opt/anaconda3/bin y escribiendo el siguiente comando

ln -s ~/opt/anaconda3/envs/py36/bin/python python3.6

y análogamente para cualquier otro entorno que hubiésemos creado.

Hacer que tox pueda encontrar los entornos en Windows

En el caso de trabjar en anaconda sobre Windows no se pueden usar enlaces simbólicos, por lo es necesario crear un script llamado python2.7.bat con el siguiente contenido

@C:\Users\your_user_name\Anaconda3\pkgs\python-3.6.10-0\python.exe %*

Asumiendo que esa es la ruta en la que se encuentra Anaconda y estamos usando Python 3.6.

Ejecución de tox

Ahora, si todo está bien podemos lanzar tox para probar nuestro código en todos los entornos que hemos configurado. Algo que se hace situándonos en nuestro proyecto y escribiendo tox en la terminal.

% tox
....
py37: commands succeeded
py36: commands succeeded
py35: commands succeeded
congratulations :)

Conclusiones

En esta entrada se ha visto los pasos para poder probar en múltiples versiones de Python el código de nuestro paquete. Algo que es importante especialmente si queremos distribuirlo y no sabemos en qué entornos funciona y en cuáles no. La semana que vienes explicaremos otro punto clave, la medida de las cobertura de las pruebas unitarias.

Imagen de seth0s en Pixabay