Repolode
psf

psf/black

Black es un formateador de código Python con opiniones definidas y resultados deterministas que reescribe los archivos in situ con diffs mínimos.

Estrellas
41,948
Forks
2,940
Issues abiertos
298
Último commit
hace 12 horas

¿Qué es?

Black es un formateador de código Python con opiniones definidas. Reformatea archivos completos in situ con un conjunto deliberadamente reducido de opciones de estilo, para que el código se vea igual en todos los proyectos y se eviten debates sobre el formato. Está diseñado para producir los diffs más pequeños posibles, lo que permite centrarse en el contenido durante las revisiones de código.

Black requiere Python 3.10 o posterior y se instala con pip. También puede formatear Jupyter Notebooks si se instala con la dependencia adicional jupyter, y hay ejecutables independientes disponibles para quienes no quieran instalar Python. Lee la configuración de pyproject.toml, incluidos los patrones include y exclude, aunque los valores predeterminados están pensados para funcionar sin cambios.

Como medida de seguridad, Black comprueba que el código reformateado siga generando un AST equivalente al original; la opción --fast omite esta comprobación. El proyecto documenta su estilo de código y una política de estabilidad que limita los cambios de estilo a correcciones de errores y compatibilidad con nuevas sintaxis de Python.

Funciones clave

  • 01Reformatea archivos Python in situ con un conjunto reducido y fijo de opciones de estilo.
  • 02Genera diffs mínimos para que las revisiones de código se centren en el contenido.
  • 03De forma predeterminada, verifica que el código formateado sea equivalente al original en términos de AST.
  • 04Formatea Jupyter Notebooks si se instala con la dependencia adicional jupyter.
  • 05Lee la configuración del proyecto desde pyproject.toml.

Casos de uso

  • Aplicar un estilo de código coherente en todo un equipo o repositorio de Python.
  • Ejecutarlo automáticamente como hook de pre-commit o en CI para comprobar el formato.
  • Formatear código Python en Jupyter Notebooks junto con archivos de código fuente habituales.

Inicio rápido

  1. 1

    Instala Black con pip

    pip install black
  2. 2

    Da formato a un archivo o directorio

    black {source_file_or_directory}

Antes de usarlo

  • Requiere Python 3.10 o posterior para ejecutarse.

Temas

Preguntas frecuentes

¿Qué es black?
Black es un formateador de código Python con opiniones definidas y resultados deterministas que reescribe los archivos in situ con diffs mínimos. Black es un formateador de código Python con opiniones definidas. Reformatea archivos completos in situ con un conjunto deliberadamente reducido de opciones de estilo, para que el código se vea igual en todos los proyectos y se eviten debates sobre el formato. Está diseñado para producir los diffs más pequeños posibles, lo que permite centrarse en el contenido durante las revisiones de código.
¿black es gratuito? ¿Qué licencia tiene?
black es open source bajo la licencia MIT. Revisa los términos de la licencia antes de usarlo en productos comerciales.
¿black sigue mantenido?
Mantenimiento activo. El último commit de black fue el 19 oct 2026.
¿Para qué puedo usar black?
Aplicar un estilo de código coherente en todo un equipo o repositorio de Python. Ejecutarlo automáticamente como hook de pre-commit o en CI para comprobar el formato. Formatear código Python en Jupyter Notebooks junto con archivos de código fuente habituales.
¿Cómo se instala black?
Instala Black con pip: pip install black Da formato a un archivo o directorio: black {source_file_or_directory}
¿Dónde consigo black?
El código fuente y las instrucciones de instalación están en GitHub: https://github.com/psf/black

Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.

Proyectos relacionados