Archive for Setembre 2021
pytest: estructura de directoris
Introducció
El mecanisme d’importació de Python em resulta força confós. Segurament és per la gran flexibilitat que ofereix.
Com sigui, cada cop que haig de fer un nou projecte amb pytest em toca cercar com muntar les carpetes, on col·locar el __init__.py, etc. Això acaba resultant en una manera diferent per cada projecte, que els lints que tinc instal·lats al vim no reconeguin imports, i altres problemes.
Com que l’estructura habitual que faig servir és en realitat molt senzilla, he pensat fer aquest post per tenir-lo de referència. T’imagines que a partir d’ara els meus projectes tenen tots la mateixa estructura?
Objectiu
L’objectiu és:
- una carpeta on col·locar el codi font de l’aplicació. Bàsicament és un mòdul principal i un o més mòduls que contenen codi que fa servir el mòdul principal
- una carpeta on col·locar el codi de tests que, per pytest, per defecte serà
test/. Aquesta carpeta ha de poder contenir també mòduls de suport pels tests.
Exemple
L’exemple de projecte amb que il·lustraré aquesta estructura és molt bàsic
- el projecte es dirà
projecte - el mòdul principal es dirà
main.pyi farà servir funcionalitats del mòdul de suportutilmain.py - el mòdul de test de main es dirà, com sol ser habitual,
test/test_main.pyi farà servir funcionalitats detest/utiltest.py.
El mòdul principal, en aquest exemple, oferirà la funció absolutitza() que rebrà un valor (esperem que numèric) i retornarà la versió absoluta. Sí, Python ja ens ofereix aquesta funcionalitat amb abs() però no voldrem aquí un exemple tan complex com perquè Python no el tingui resolt, oi?
Per poder portar a terme aquesta funcionalitat, absolutitza() fa servir la funció utilmain.es_positiu() que dirà si el valor que li passem és o no positiu.
Estructura de carpetes
L’estructura de carpetes per aquest projecte serà:
projecte/$ tree
.
├── __init__.py
├── main.py
├── test
│ ├── __init__.py
│ ├── test_main.py
│ └── utiltest.py
└── utilmain.py
Aconseguim les carpetes amb la comanda:
$ mkdir -p projecte/test
Continguts
Els fitxers __init__.py permeten indicar a Python que consideri tota la carpeta on apareixen com un mòdul. No cal que tinguin res però hi podríem afegir codi arbitrari per inicialitzar coses. Aquí simplement els crearem buits
Aconseguim els fitxers __init__.py amb la comanda:
$ touch projecte/__init__.py projecte/test/__init__.py
El contingut dels altres fitxers seria:
main.py
# projecte/main.py
from projecte import utilmain
def absolutitza(valor):
return valor if utilmain.es_positiu(valor) else -valor
utilmain.py
# program/utilmain.py
def es_positiu(valor):
return valor >= 0
test_main.py
# test_main.py
from projecte.test import utiltest
from projecte.main import absolutitza
def test_quan_es_negatiu():
utiltest.printlog("absolutitza(-1)")
assert absolutitza(-1) == 1
def test_quan_es_positiu():
utiltest.printlog("absolutitza(1)")
assert absolutitza(1) == 1
utiltest.py
# utiltest.py
def printlog(missatge):
print('Comprovant', missatge)
Fixa’t especialment en els imports. Són absoluts al projecte.
Una mica farragós, potser, però pylint els detecta sense problemes
Resultat
Un cop tenim això, ja podem passar els tests
projecte/$ pytest
======================== test session ========================
platform linux -- Python 3.7.3, pytest-6.2.4, py-1.10.0, pluggy-0.13.1
rootdir: /tmp/ramdisk/projecte
collected 2 items
test/test_main.py .. [100%]
===================== 2 passed in 0.01s =====================Conclusions
Amb aquesta estructura aconseguim que el nostre projecte pugui tenir tests (amb mòduls d’ajuda de tests)
El cost és crear dos __init__.py i complicar el mecanisme d’importació doncs cal indicar a tot arreu el nom del projecte. Sembla, però, que aquesta és la manera recomanada, així que començaré a fer-lo servir a partir d’ara i, si trobo res millor… actualitzaré aquesta entrada.
blami tec 