Saltar al contenido

Pytest lentos: encontrar, marcar, omitir y acelerar (xdist)

Última actualización: · Publicada por primera vez:

Las pruebas lentas de pytest tienen dos soluciones distintas. Algunas pruebas son lentas por un motivo, y conviene marcarlas y decidir cuándo ejecutarlas. Las demás son lentas por accidente, y puede acelerarlas con paralelismo, fixtures más económicos y dividiendo la suite entre trabajos de CI. Esta guía explica cómo encontrar pruebas lentas, cómo usar una marca de pytest para ellas, cómo omitirlas por defecto y ejecutarlas bajo demanda, y cómo usar xdist y la división de la suite. Forma parte del grupo de pruebas e2e lentas.

Encontrar las pruebas lentas

pytest --durations=20            # 20 slowest tests (setup, call, teardown)
pytest --durations=20 --durations-min=1.0   # only those over 1 second
pytest -q --setup-show -k test_name         # see fixture setup for one test

--durations muestra por separado el tiempo de setup y de teardown. Si una prueba muestra 0.01s de call y 3s de setup, el problema es el fixture, no la prueba.

Marcar las pruebas lentas

Registre una marca para que pytest no emita advertencias sobre ella, y aplíquela:

# pytest.ini
[pytest]
markers =
    slow: tests that take more than a second or two
    e2e: tests that drive a real browser or service
import pytest

@pytest.mark.slow
def test_full_import():
    ...

Después puede seleccionar o excluir pruebas por marca:

pytest -m "not slow"     # fast feedback: skip slow tests
pytest -m slow           # run only the slow tests
pytest                   # everything

Omitir las pruebas lentas por defecto y ejecutarlas bajo demanda

Un patrón habitual es omitir las pruebas lentas salvo que se pase un flag. Añada esto a conftest.py:

import pytest

def pytest_addoption(parser):
    parser.addoption("--runslow", action="store_true", default=False, help="run slow tests")

def pytest_collection_modifyitems(config, items):
    if config.getoption("--runslow"):
        return
    skip_slow = pytest.mark.skip(reason="need --runslow to run")
    for item in items:
        if "slow" in item.keywords:
            item.add_marker(skip_slow)

Así, pytest es rápido en un portátil y pytest --runslow ejecuta todo. En CI: ejecute -m "not slow" en cada PR, y el conjunto lento al hacer merge en main o cada noche, en un trabajo aparte. Para muchos proyectos de Python, este es el ahorro más grande. Las pruebas omitidas aparecen como skipped, así que siguen siendo visibles. Asegúrese de que alguien sea responsable del trabajo lento; una suite lenta que nunca se ejecuta equivale a no tener pruebas.

Ejecutar en paralelo con pytest-xdist

pip install pytest-xdist
pytest -n auto          # one worker per CPU core
pytest -n 4             # fixed worker count
pytest -n auto --dist loadfile   # keep tests from the same file together

-n auto usa todos los núcleos, que en un runner de 2 vCPU son dos workers. Las pruebas deben ser independientes: sin archivos, puertos o filas de base de datos compartidos. Para bases de datos, dé a cada worker la suya, usando el fixture worker_id:

@pytest.fixture(scope="session")
def db_name(worker_id):
    return "test" if worker_id == "master" else f"test_{worker_id}"

Los fixtures con scope="session" se ejecutan una vez por worker, no una vez por ejecución. Es lo esperado, pero los fixtures de sesión pesados se multiplican por el número de workers. --dist loadscope agrupa por módulo o clase y ayuda cuando los fixtures tienen alcance de módulo.

Fixtures más económicos

  • Prefiera scope="module" o "session" para configuraciones costosas de solo lectura.
  • Envuelva las pruebas de base de datos en una transacción y haga rollback en lugar de volver a crear las tablas.
  • Use SQLite en memoria solo si la semántica de producción lo permite; en caso contrario, una base de datos real en un contenedor iniciado una vez por trabajo es más fiel.
  • Sustituya time.sleep por un reloj simulado (freezegun o time-machine) o por una espera de evento.
  • Use pytest --lf (last failed) y --ff (failed first) en local.

Dividir la suite entre trabajos de CI

xdist usa los núcleos de un único runner. Para usar más runners, divida la suite. Plugins como pytest-split asignan las pruebas a grupos según duraciones almacenadas; pytest-shard y otros similares son alternativas, así que consulte el README de cada proyecto para conocer los flags actuales. Con pytest-split:

strategy:
  fail-fast: false
  matrix:
    group: [1, 2, 3, 4]
steps:
  - uses: actions/checkout@v4
  - uses: actions/setup-python@v5
    with: { python-version: "3.12", cache: pip }
  - run: pip install -r requirements.txt pytest-split pytest-xdist
  - run: pytest -n auto --splits 4 --group ${{ matrix.group }}

Genere las duraciones una vez con pytest --store-durations y confirme el archivo .test_durations, para que los grupos se equilibren por tiempo y no por número. El método general, las compensaciones de coste y el equilibrado se explican en la guía de sharding de pruebas y en el planificador.

Configuración de CI específica de Python

  • Use actions/setup-python con cache: pip (o uv con su caché) para restaurar las instalaciones de dependencias.
  • Instale solo las dependencias de prueba en el trabajo de tests.
  • Para pruebas de navegador desde Python, consulte pruebas de Playwright lentas, la sección de Python.

Más CPU

Si -n auto es el cuello de botella, más núcleos ayudan directamente, porque xdist escala con ellos. Consulte runners más rápidos de GitHub Actions. compiler.dev fue, de mediana, 1.5× más rápido en 18 stacks medidos (15 más rápidos, 2 iguales, 1 más lento) que el runner de 2 núcleos de GitHub, y el modo de comparación mide sus propios trabajos. El resto del pipeline está en el centro de CI lento.

Preguntas frecuentes

¿Cómo marco una prueba como lenta en pytest?

Decórela con @pytest.mark.slow y registre slow en markers dentro de pytest.ini para evitar advertencias.

¿Cómo omito las pruebas lentas en pytest?

Ejecute pytest -m "not slow", o añada una opción --runslow en conftest.py que omita las pruebas marcadas como lentas salvo que se pase el flag.

¿Cómo ejecuto solo las pruebas lentas?

pytest -m slow.

¿pytest-xdist es siempre más rápido?

No en suites pequeñas, donde el arranque de los workers cuesta más de lo que ahorra, ni cuando las pruebas comparten estado. En suites de un minuto o más suele ayudar mucho.

Ejecute esta suite de pytest en compiler.dev Sin tarjeta · 200 minutos gratuitos

Pruébelo gratis