Tester votre paquet dans différents environnements

Créer des paquetages Python

James Fulton

Climate informatics researcher

Tester plusieurs versions de Python

Ce setup.py accepte toute version de Python à partir de la 2.7.

from setuptools import setup, find_packages

setup(
    ...
    python_requires='>=2.7',
)

Pour tester ces versions de Python, vous devez :

Installer toutes ces versions de Python
Installer votre paquet et toutes les dépendances dans chaque Python
Exécuter pytest

Tester plusieurs versions de Python

Ce setup.py accepte toute version de Python à partir de la 2.7.

from setuptools import setup, find_packages

setup(
    ...
    python_requires='>=2.7',
)

Pour tester ces versions de Python, vous devez :

Installer toutes ces versions de Python
Exécuter tox

Qu'est-ce que tox ?

Conçu pour exécuter des tests avec plusieurs versions de Python

Configurer tox

Fichier de configuration - tox.ini

mysklearn/
|-- mysklearn
|   |-- ...
|-- tests
|   |-- ...
|-- setup.py
|-- LICENSE
|-- MANIFEST.in
|-- tox.ini   <--- fichier de configuration

Configurer tox

Fichier de configuration - tox.ini

[tox]

envlist = py27, py35, py36, py37


[testenv]

deps = pytest

commands =
    pytest

    echo "run more commands"
    ...

Les en-têtes sont entre crochets [...].
Pour tester Python X.Y, ajoutez pyXY à envlist.
Les versions de Python testées doivent déjà être installées.
Le paramètre commands liste les commandes de terminal que tox exécutera.
La liste commands peut contenir toute commande exécutable au terminal, comme ls, cd, echo, etc.

Exécuter tox

tox

mysklearn/    <-- se placer ici
|-- mysklearn
|   |-- ...
|-- tests
|   |-- ...
|-- setup.py
|-- LICENSE
|-- MANIFEST.in
|-- tox.ini

Sortie de tox

py27 create: /mypackages/mysklearn/.tox/py27
py27 installdeps: pytest
py27 inst: /mypackages/mysklearn/.tox/.tmp/package/1/mysklearn-0.1.0.zip
py27 installed: mysklearn==0.1.0,numpy==1.16.6,pandas==0.24.2,pytest==4.6.11,...
py27 run-test-pre: PYTHONHASHSEED='2837498672'
...

Sortie de tox

py27 run-test: commands[0] | pytest
======================== test session starts ========================
platform linux2 -- Python 2.7.17, ...
rootdir: /home/workspace/mypackages/mysklearn
collected 6 items                         

tests/preprocessing/test_normalize.py ...                     [ 50%]
tests/preprocessing/test_standardize.py ...                   [100%]

========================= 6 passed in 0.23s =========================

Sortie de tox

...
__________________________ summary __________________________
  py27: commands succeeded
  py35: commands succeeded
  py36: commands succeeded
  py37: commands succeeded

Sortie de tox

...
__________________________ summary __________________________
  py27: commands succeeded
  py35: commands succeeded
  py36: commands succeeded
ERROR:   py37: commands failed

Passons à la pratique !

Créer des paquetages Python