Hasta ahora pasamos muchas opciones por la terminal: --cov=src, --cov-branch, --cov-report y otras. Eso sirve para aprender, pero en un proyecto real conviene guardar la configuración en un archivo.
En este tema vamos a usar pyproject.toml para configurar qué código medir, qué archivos excluir y si queremos activar cobertura de ramas.
Sin configuración, cada persona puede medir de una manera distinta. Una ejecución puede incluir tests, otra puede medir scripts auxiliares y otra puede olvidar branch coverage.
La configuración evita esos problemas porque deja por escrito las reglas de medición del proyecto.
En la raíz de cobertura-demo, crea o edita el archivo pyproject.toml:
cobertura-demo/
|-- pyproject.toml
|-- src/
| `-- tienda/
`-- tests/Si el archivo ya existe porque el proyecto usa otras herramientas, agrega las secciones de coverage sin borrar la configuración existente.
La opción source indica qué parte del proyecto se considera código de aplicación:
[tool.coverage.run]
source = ["src"]Con esta configuración, coverage se enfoca en src y deja de tratar los tests como parte principal de la medición.
Luego puedes ejecutar:
python -m coverage run -m pytest
python -m coverage report -mPara medir ramas por defecto, agrega branch = true:
[tool.coverage.run]
source = ["src"]
branch = trueAsí ya no necesitas recordar --branch en cada ejecución con coverage.py.
python -m coverage run -m pytest
python -m coverage report -mEl reporte incluirá información de ramas cuando corresponda.
omit excluye archivos o patrones que no queremos medir. Por ejemplo:
[tool.coverage.run]
source = ["src"]
branch = true
omit = [
"*/__init__.py",
"*/migrations/*",
"*/scripts/*",
]Esto puede ser útil para archivos vacíos, migraciones generadas o scripts auxiliares que no forman parte del comportamiento principal.
Excluir archivos baja el ruido, pero también puede ocultar problemas. No conviene usar omit para esconder código difícil de probar.
Antes de omitir un archivo, revisa si realmente cumple alguna de estas condiciones:
include sirve para limitar la medición a ciertos patrones. Es menos común cuando ya usamos source, pero puede ser útil en proyectos grandes.
[tool.coverage.run]
include = [
"src/tienda/*.py",
]En general, evita mezclar source e include sin una razón clara. Para este curso, source = ["src"] suele ser suficiente.
También puedes configurar opciones del reporte:
[tool.coverage.report]
show_missing = true
skip_covered = false
precision = 2Con show_missing = true, el reporte muestra líneas faltantes sin tener que pasar -m cada vez.
python -m coverage reportPara el proyecto del curso, una configuración razonable sería:
[tool.coverage.run]
source = ["src"]
branch = true
omit = [
"*/__init__.py",
]
[tool.coverage.report]
show_missing = true
precision = 2Esta configuración mide el código de src, activa ramas y muestra líneas faltantes en el reporte.
pytest-cov también respeta la configuración de coverage. Puedes ejecutar:
En Windows PowerShell:
$env:PYTHONPATH="src"
python -m pytest --cov --cov-report=term-missingEn Linux o macOS:
PYTHONPATH=src python -m pytest --cov --cov-report=term-missingAl usar --cov sin valor, pytest-cov toma la configuración de coverage para decidir qué medir.
Si tienes dudas sobre la configuración cargada, ejecuta:
python -m coverage debug configEste comando muestra qué archivo de configuración se encontró y qué opciones quedaron activas.
Con show_missing = true y branch = true, el reporte puede verse así:
Name Stmts Miss Branch BrPart Cover Missing
-------------------------------------------------------------------
src\tienda\tarifas.py 17 0 12 0 100.00%Si aparecen ramas parciales, revisa si falta una prueba real o si el código necesita simplificarse.
source = ["src"] esté bajo [tool.coverage.run].branch = true esté bien escrito.En este tema centralizamos la configuración de coverage en pyproject.toml. Definimos source, omit, include, branch y opciones del reporte.
En el próximo tema vamos a ver cómo excluir líneas justificadas con pragma: no cover.