Herramientas mínimas
La tentación es instalar veinte herramientas y configurar un pipeline de doscientas líneas. Funciona una semana y luego nadie lo mantiene. Este capítulo propone el mínimo que resuelve el 90 % de los problemas, y el orden en que se adopta.
En una línea
Sección titulada «En una línea»Entorno virtual, formateador, linter, tipos y depurador. Todo lo demás es opcional.
Las seis
Sección titulada «Las seis»| Herramienta | Para qué | Comando |
|---|---|---|
venv (o uv) |
Aislar dependencias | python -m venv .venv |
ruff format |
Formato uniforme | ruff format . |
ruff check |
Errores y código muerto | ruff check . --fix |
mypy |
Contratos de tipos | mypy src |
pytest |
Comportamiento | pytest -q |
pdb / py-spy |
Depurar | breakpoint() |
ruff hace las veces de dos herramientas (formato y lint) en un binario escrito en Rust, y sustituye a flake8, isort, black y pyupgrade a la vez. Es la razón de que esté en la lista y los otros no.
El orden
Sección titulada «El orden»- Entorno virtual por proyecto. Sin él, todo lo demás es irrelevante: dos proyectos con versiones distintas de la misma biblioteca son un bug garantizado.
- Formateador. Elimina discusiones de estilo y no discute: aplica y ya.
- Linter. Detecta variables sin usar, imports muertos y errores comunes. Se aplica con
--fixy se revisa lo que queda. - Tipos, en el código nuevo.
mypysobre un proyecto heredado sin anotaciones produce mil errores y se abandona. Empieza por los módulos que escribes hoy. - Tests. El capítulo 03 de la Parte VII.
- Depurador. Cuando haga falta; no se instala, viene con Python.
El archivo de configuración
Sección titulada «El archivo de configuración»[tool.ruff]line-length = 100target-version = "py311"
[tool.ruff.lint]select = ["E", "F", "I", "UP", "B"]
[tool.mypy]python_version = "3.11"warn_unused_ignores = truedisallow_untyped_defs = true
[tool.pytest.ini_options]testpaths = ["tests"]addopts = "-q"Todo en pyproject.toml, un archivo por proyecto, nada escondido en .flake8, setup.cfg y mypy.ini a la vez.
La trampa
Sección titulada «La trampa»Cuándo no instalar nada
Sección titulada «Cuándo no instalar nada»- Un script de veinte líneas. Ni
mypynipytest. - Un notebook de análisis. El entorno del notebook ya trae lo necesario.
- En un equipo sin CI. Las herramientas locales no se ejecutan solas; primero el CI (Parte VII, capítulo 08).
Ejercicio
Sección titulada «Ejercicio»Un equipo nuevo quiere montar un proyecto desde cero. Ordena estas tareas y explica por qué ese orden: (a) configurar mypy estricto, (b) crear el entorno virtual, (c) añadir ruff al editor, (d) escribir el primer test, (e) configurar el CI.
Solución
- (b) Entorno virtual. Sin él, nada de lo demás es reproducible.
- (c)
ruffen el editor. Se adopta sin fricción y desde el primer archivo, para que el formato no haya que corregirlo después en masa. - (d) El primer test. Antes del CI, para que haya algo que ejecutar; y antes de
mypy, porque el test documenta el comportamiento que el tipo debe respetar. - (e) El CI. Automatiza lo anterior en cada push. Es lo que hace que las herramientas se usen.
- (a)
mypyestricto. El último, y sólo sobre el código nuevo. Configurarlo primero, sin código, lleva a discusiones sobre reglas que aún no se han necesitado.
El criterio del orden: cada paso debe ser ejecutable y útil por sí solo, y el más costoso de mantener va al final, cuando ya hay evidencia de que hace falta.
Referencias
Sección titulada «Referencias»- Lott, S. F. Modern Python Cookbook, 3ª ed. Capítulos 16 y 17.
- Ramalho, L. Fluent Python, 2ª ed. Capítulo 8.
- Documentación de
ruff,mypy,pytestyuv.
Capítulos relacionados
Sección titulada «Capítulos relacionados»- 02 · El intérprete: qué ejecutan estas herramientas.
- 08 · CI y calidad (Parte VII): dónde se automatizan.
- 03 · Testing (Parte VII): qué escribir primero.