Descripción general de la extensión

Informar un problema Ver fuente Nightly · 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

En esta página, se describe cómo extender el lenguaje BUILD usando macros y reglas.

Las extensiones de Bazel son archivos que terminan en .bzl. Usa un load statement para importar un símbolo de una extensión.

Antes de aprender los conceptos más avanzados, haz lo siguiente:

Macros y reglas

Una macro es una función que crea una instancia de reglas. Resulta útil cuando un elemento BUILD se está volviendo demasiado repetitivo o complejo, ya que te permite volver a usarlo algo de código. La función se evalúa en cuanto se lee el archivo BUILD. Después del la evaluación del archivo BUILD, Bazel tiene poca información sobre las macros: Si la macro genera un genrule, Bazel se comportará como si escribieras el genrule Como resultado, bazel query solo mostrará las genrule generadas.

Una regla es más potente que una macro. Puede acceder a Bazel y control total de lo que sucede. Puede, por ejemplo, pasar información a otras reglas.

Si quieres reutilizar una lógica simple, comienza con una macro. Si una macro se vuelve complejo, suele ser una buena idea establecerla como una regla. Compatibilidad con un idioma nuevo generalmente se realiza con una regla. Las reglas son para usuarios avanzados, y la mayoría de los usuarios nunca tendrán que escribir una. Solo cargarán y llamarán a las reglas existentes.

Modelo de evaluación

Una compilación consta de tres fases.

  • Fase de carga. Primero, carga y evalúa todas las extensiones y todos los archivos BUILD necesarios para la compilación. La ejecución de los archivos BUILD solo crea instancias de reglas (cada vez que se llama a una regla, se agrega a un gráfico). Aquí es donde se evalúan las macros.

  • Fase de análisis. Se ejecuta el código de las reglas (su función implementation) y se crean instancias de las acciones. Una acción describe cómo generar Un conjunto de resultados a partir de un conjunto de entradas, como “run gcc on hello.c and get hello.o”. Debes indicar explícitamente qué archivos se generarán antes ejecutar los comandos reales. En otras palabras, la fase de análisis toma el gráfico generado por la fase de carga y genera un gráfico de acciones.

  • Fase de ejecución. Las acciones se ejecutan cuando al menos uno de sus resultados como en los productos necesarios. Si falta un archivo o si un comando no genera un resultado, la compilación falla. Las pruebas también se ejecutan durante esta fase.

Bazel usa el paralelismo para leer, analizar y evaluar los archivos .bzl y BUILD. archivos. Se lee un archivo como máximo una vez por compilación, y el resultado de la evaluación se almacena en caché y se vuelve a usar. Un archivo se evalúa solo una vez que todas sus dependencias (load() declaraciones) se hayan resuelto. Por diseño, la carga de un archivo .bzl no tiene efecto secundario, solo define valores y funciones.

Bazel intenta ser inteligente: usa el análisis de dependencias para saber qué archivos se deben cargar, qué reglas se deben analizar y qué acciones se deben ejecutar. Para Por ejemplo, si una regla genera acciones que no necesitas para la compilación actual, no se ejecutarán.

Cómo crear extensiones

Los siguientes dos vínculos te serán muy útiles cuando escribas tus propias extensiones. Conservar a su alcance:

Un paso más allá

Además de las macros y las reglas, te recomendamos que escribas aspectos y reglas del repositorio.