Las herramientas de calidad son útiles, pero si dependemos de recordarlas manualmente es fácil olvidarlas. pre-commit permite ejecutar controles automáticamente antes de confirmar cambios en Git.
En este tema instalaremos pre-commit, crearemos una configuración básica y ejecutaremos controles como Ruff, Black, mypy y pytest antes de realizar commits.
pre-commit es una herramienta que ejecuta hooks antes de un commit. Un hook es un control automático: formatear código, revisar linting, validar tipos, detectar espacios sobrantes o ejecutar pruebas.
La ventaja es que los problemas se detectan temprano, antes de que lleguen al repositorio compartido.
pre-commit trabaja con repositorios Git. Si tu proyecto todavía no tiene Git inicializado, puedes ejecutar:
git initLuego verifica el estado:
git statusActiva el entorno virtual del proyecto e instala la herramienta:
python -m pip install pre-commitVerifica la instalación:
python -m pre_commit --versionEl comando usa guion bajo cuando se ejecuta como módulo: python -m pre_commit.
En la raíz del proyecto crea .pre-commit-config.yaml:
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.6.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
- id: check-yaml
- id: check-tomlEstos hooks revisan detalles básicos: espacios al final de línea, final de archivo, YAML y TOML válidos.
Ejecuta:
python -m pre_commit installDesde ese momento, pre-commit se ejecutará automáticamente antes de cada commit.
Para probar la configuración en todos los archivos, ejecuta:
python -m pre_commit run --all-filesSi algún hook modifica archivos, revisa los cambios y vuelve a ejecutar el comando.
Podemos agregar Ruff como hook:
repos:
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.5.0
hooks:
- id: ruff
args: [--fix]
- id: ruff-formatRuff puede corregir algunos problemas automáticamente y también formatear si decides usar su formateador. Si el proyecto usa Black como formateador principal, puedes omitir ruff-format.
Si mantienes Black como formateador, agrega:
repos:
- repo: https://github.com/psf/black
rev: 24.4.2
hooks:
- id: blackBlack usará la configuración de pyproject.toml.
Para ordenar imports:
repos:
- repo: https://github.com/pycqa/isort
rev: 5.13.2
hooks:
- id: isortisort también leerá su configuración desde pyproject.toml.
Una configuración práctica para ventas_demo puede ser:
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.6.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
- id: check-yaml
- id: check-toml
- repo: https://github.com/pycqa/isort
rev: 5.13.2
hooks:
- id: isort
- repo: https://github.com/psf/black
rev: 24.4.2
hooks:
- id: black
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.5.0
hooks:
- id: ruff
args: [--fix]Las versiones son ejemplos. En un proyecto real conviene revisarlas y actualizarlas de forma controlada.
mypy puede ejecutarse como hook local si ya está instalado en el entorno:
repos:
- repo: local
hooks:
- id: mypy
name: mypy
entry: python -m mypy src
language: system
pass_filenames: falsepass_filenames: false indica que mypy revise src completo, no solo archivos modificados.
También puedes ejecutar pruebas como hook local:
repos:
- repo: local
hooks:
- id: pytest
name: pytest
entry: python -m pytest
language: system
pass_filenames: falseEn proyectos grandes, ejecutar toda la suite en cada commit puede ser lento. En ese caso se puede reservar para CI o usar una suite rápida.
Conviene ejecutar primero herramientas que modifican archivos y luego herramientas que revisan.
Si un hook modifica archivos, debes revisar esos cambios y volver a intentar el commit.
pre-commit puede actualizar versiones de hooks:
python -m pre_commit autoupdateDespués de actualizar, ejecuta:
python -m pre_commit run --all-filesAsí verificas que las nuevas versiones no introduzcan cambios inesperados.
Git permite saltar hooks con --no-verify:
git commit --no-verify -m "mensaje"Debe usarse solo en casos excepcionales. Si se vuelve costumbre, los controles dejan de cumplir su propósito.
Agrega al README.md una sección breve:
## Pre-commit
Instalar hooks:
python -m pre_commit install
Ejecutar todos los hooks:
python -m pre_commit run --all-filesLa documentación evita que cada integrante tenga que descubrir el flujo por su cuenta.
En ventas_demo, realiza estos pasos:
python -m pip install pre-commit
python -m pre_commit install
python -m pre_commit run --all-filesSi aparecen archivos modificados por hooks, revisa los cambios, vuelve a ejecutar pre-commit y luego ejecuta las pruebas.
Configura pre-commit para tu proyecto con estas tareas:
.pre-commit-config.yaml.Antes de continuar, verifica que puedes hacer lo siguiente:
.pre-commit-config.yaml.--all-files.En este tema automatizamos controles de calidad antes del commit. pre-commit ayuda a detectar problemas temprano y a mantener un estándar consistente sin depender solo de la memoria del programador.
En el próximo tema trabajaremos con logging, mensajes de error y salida por consola con criterio profesional.