Guía de estilo .bzl

En esta página, se abarcan los lineamientos de estilo básicos para Starlark y también se incluye información sobre macros y reglas.

Starlark es un lenguaje que define cómo se compila el software y, por lo tanto, es un lenguaje de programación y de configuración.

Usarás Starlark para escribir archivos BUILD, macros y reglas de compilación. Las macros y las reglas son esencialmente metalenguajes, ya que definen cómo se escriben los archivos BUILD. Los archivos BUILD deben ser simples y repetitivos.

Todo el software se lee con más frecuencia de lo que se escribe. Esto es especialmente cierto para Starlark, ya que los ingenieros leen archivos BUILD para comprender las dependencias de sus objetivos y los detalles de sus compilaciones. Esta lectura suele ocurrir de forma rápida, apurada o en paralelo a la realización de alguna otra tarea. Por lo tanto, la simplicidad y la legibilidad son muy importantes para que los usuarios puedan analizar y comprender los archivos BUILD rápidamente.

Cuando un usuario abre un archivo BUILD, quiere saber rápidamente la lista de objetivos en el archivo, revisar la lista de fuentes de esa biblioteca de C++ o quitar una dependencia de ese objeto binario de Java. Cada vez que agregas una capa de abstracción, le dificultas al usuario realizar estas tareas.

Muchas herramientas diferentes también analizan y actualizan los archivos BUILD. Es posible que las herramientas no puedan editar tu archivo BUILD si usa abstracciones. Si mantienes la simplicidad de tus archivos BUILD, podrás obtener mejores herramientas. A medida que crece una base de código, se vuelve más frecuente realizar cambios en muchos archivos BUILD para actualizar una biblioteca o realizar una limpieza.

Consejo general

• Usa Buildifier como formateador y linter.
• Sigue los lineamientos para las pruebas.

Estilo

Estilo de Python

En caso de duda, sigue la guía de estilo de PEP 8 siempre que sea posible. En particular, usa cuatro espacios en lugar de dos para la sangría y sigue la convención de Python.

Como Starlark no es Python, no se aplican algunos aspectos del estilo de Python. Por ejemplo, PEP 8 recomienda que las comparaciones con singleton se realicen con is, que no es un operador en Starlark.

Cadena de documentación

Documenta archivos y funciones con cadenas de documentación. Usa una cadena de documentación en la parte superior de cada archivo .bzl y una cadena de documentación para cada función pública.

Documenta reglas y aspectos

Las reglas y los aspectos, junto con sus atributos, así como los proveedores y sus campos, deben documentarse con el argumento doc.

Convención de nombres

• Los nombres de las variables y las funciones usan letras minúsculas con palabras separadas por guiones bajos ([a-z][a-z0-9_]*), como cc_library.
• Los valores privados de nivel superior comienzan con un guion bajo. Bazel exige que no se puedan usar valores privados de otros archivos. Las variables locales no deben usar el prefijo de guion bajo.

Longitud de la línea

Al igual que en los archivos BUILD, no hay un límite estricto de longitud de línea, ya que las etiquetas pueden ser largas. Cuando sea posible, intenta usar como máximo 79 caracteres por línea (siguiendo la guía de estilo de Python, PEP 8). Este lineamiento no debe aplicarse de forma estricta: los editores deben mostrar más de 80 columnas, los cambios automatizados suelen introducir líneas más largas y los humanos no deben perder tiempo dividiendo líneas que ya son legibles.

Argumentos de palabras clave

En los argumentos de palabras clave, se prefieren los espacios alrededor del signo igual:

def fct(name, srcs):
    filtered_srcs = my_filter(source = srcs)
    native.cc_library(
        name = name,
        srcs = filtered_srcs,
        testonly = True,
    )

Valores booleanos

Prefiere los valores True y False (en lugar de 1 y 0) para los valores booleanos (por ejemplo, cuando se usa un atributo booleano en una regla).

Usa print solo para depuración

No uses la función print() en el código de producción. Solo está diseñada para la depuración y enviará spam a todos los usuarios directos e indirectos de tu archivo .bzl. La única excepción es que puedes enviar código que use print() si está inhabilitado de forma predeterminada y solo se puede habilitar editando la fuente. Por ejemplo, si todos los usos de print() están protegidos por if DEBUG:, en el que DEBUG está codificado como False. Ten en cuenta si estas instrucciones son lo suficientemente útiles como para justificar su impacto en la legibilidad.

Macros

Una macro es una función que instancia una o más reglas durante la fase de carga. En general, usa reglas siempre que sea posible en lugar de macros. El gráfico de compilación que ve el usuario no es el mismo que el que usa Bazel durante la compilación. Las macros se expanden antes de que Bazel realice cualquier análisis del gráfico de compilación.

Por lo tanto, cuando algo sale mal, el usuario deberá comprender la implementación de tu macro para solucionar problemas de compilación. Además, los resultados de bazel query pueden ser difíciles de interpretar porque los objetivos que se muestran en los resultados provienen de la expansión de macros. Por último, los aspectos no conocen las macros, por lo que las herramientas que dependen de los aspectos (IDE y otros) podrían fallar.

Un uso seguro para las macros es definir objetivos adicionales que se deben consultar directamente en la CLI de Bazel o en archivos BUILD. En ese caso, solo los usuarios finales de esos objetivos deben conocerlos, y cualquier problema de compilación que introduzcan las macros nunca está lejos de su uso.

Para las macros que definen objetivos generados (detalles de implementación de la macro a los que no se debe hacer referencia en la CLI ni depender de objetivos que no estén instanciados por esa macro), sigue estas prácticas recomendadas:

• Una macro debe tomar un argumento name y definir un objetivo con ese nombre. Ese objetivo se convierte en el objetivo principal de esa macro.
• Los objetivos generados, es decir, todos los demás objetivos definidos por una macro, deben cumplir con lo siguiente:
  • Sus nombres deben tener el prefijo <name>. Por ejemplo, usar name = '%s_bar' % (name).
  • Tener visibilidad restringida (//visibility:private).
  • Tener una etiqueta manual para evitar la expansión en objetivos comodín (:all, ..., :*, etcétera).
• El name solo se debe usar para derivar nombres de objetivos definidos por la macro y no para nada más. Por ejemplo, no uses el nombre para derivar una dependencia o un archivo de entrada que no genere la macro en sí.
• Todos los objetivos creados en la macro deben estar vinculados de alguna manera al objetivo principal.
• Por convención, name debe ser el primer argumento cuando se define una macro.
• Mantén la coherencia de los nombres de los parámetros en la macro. Si un parámetro se pasa como un valor de atributo al objetivo principal, mantén el mismo nombre. Si un parámetro de macro tiene el mismo propósito que un atributo de regla común, como deps, nómbralo como lo harías con el atributo (consulta más abajo).
• Cuando llames a una macro, usa solo argumentos de palabras clave. Esto es coherente con las reglas y mejora mucho la legibilidad.

Los ingenieros suelen escribir macros cuando la API de Starlark de las reglas pertinentes es insuficiente para su caso de uso específico, independientemente de si la regla se define dentro de Bazel en código nativo o en Starlark. Si tienes este problema, pregúntale al autor de la regla si puede extender la API para lograr tus objetivos.

Como regla general, cuanto más se parezcan las macros a las reglas, mejor.

Consulta también macros.

Reglas

• Las reglas, los aspectos y sus atributos deben usar nombres en minúscula ("snake case").
• Los nombres de las reglas son sustantivos que describen el tipo principal de artefacto que produce la regla, desde el punto de vista de sus dependencias (o, para las reglas de hoja, el usuario). No es necesariamente un sufijo de archivo. Por ejemplo, una regla que produce artefactos de C++ destinados a usarse como extensiones de Python podría llamarse py_extension. Para la mayoría de los lenguajes, las reglas típicas incluyen lo siguiente:
  • *_library - una unidad de compilación o "módulo".
  • *_binary - Un objetivo que produce un ejecutable o una unidad de implementación.
  • *_test - Un objetivo de prueba. Puede incluir varias pruebas. Espera que todas las pruebas en un objetivo *_test sean variaciones sobre el mismo tema, por ejemplo, probar una sola biblioteca.
  • *_import: Un objetivo que encapsula un artefacto precompilado, como un archivo .jar o .dll que se usa durante la compilación.
• Usa nombres y tipos coherentes para los atributos. Algunos atributos de aplicación general incluyen lo siguiente:
  • srcs: label_list, que permite archivos: archivos fuente, por lo general, creados por humanos.
  • deps: label_list, que, por lo general, no permite archivos: dependencias de compilación.
  • data: label_list, que permite archivos: archivos de datos, como datos de prueba, etcétera.
  • runtime_deps: label_list: dependencias del entorno de ejecución que no son necesarias para la compilación.
• Para cualquier atributo con un comportamiento no obvio (por ejemplo, plantillas de cadenas con sustituciones especiales o herramientas que se invocan con requisitos específicos), proporciona documentación con el argumento de palabra clave doc para la declaración del atributo (attr.label_list() o similar).
• Las funciones de implementación de reglas casi siempre deben ser funciones privadas (con un guion bajo inicial). Un estilo común es darle a la función de implementación de myrule el nombre _myrule_impl.
• Pasa información entre tus reglas con una interfaz de proveedor bien definida proveedor. Declara y documenta los campos del proveedor.
• Diseña tu regla teniendo en cuenta la extensibilidad. Ten en cuenta que es posible que otras reglas quieran interactuar con tu regla, acceder a tus proveedores y reutilizar las acciones que crees.
• Sigue los lineamientos de rendimiento en tus reglas.