Archivos BUILD

Denuncia un problema Nightly · 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

Métodos disponibles en los archivos BUILD. Consulta también la Enciclopedia de compilación para obtener funciones y reglas de compilación adicionales, que también se pueden usar en archivos BUILD.

Miembros

depset

depset depset(direct=None, order="default", *, transitive=None)

Crea un depset. El parámetro direct es una lista de elementos directos del conjunto de dependencias, y el parámetro transitive es una lista de conjuntos de dependencias cuyos elementos se convierten en elementos indirectos del conjunto de dependencias creado. El parámetro order especifica el orden en que se muestran los elementos cuando el depset se convierte en una lista. Consulta la Descripción general de las dependencias para obtener más información.

Todos los elementos (directos e indirectos) de un depósito deben ser del mismo tipo, como se obtuvo por la expresión type(x).

Dado que se usa un conjunto basado en hash para eliminar duplicados durante la iteración, todos los elementos de un conjunto de dependencias deben poder generar un hash. Sin embargo, actualmente, esta invariante no se verifica de manera coherente en todos los constructores. Usar la marca --incompatible_always_check_depset_elements para habilitar la verificación coherente este será el comportamiento predeterminado en versiones futuras. consulta el error 10313.

Además, actualmente los elementos deben ser inmutables, aunque esta restricción se flexibilizará en el futuro.

El orden del conjunto de dependencias creado debe ser compatible con el orden de sus conjuntos de dependencias transitive. El pedido de "default" es compatible con cualquier otro pedido. Los demás pedidos solo son compatibles con ellos mismos.

Parámetros

Parámetro Descripción
direct sequence o None; El valor predeterminado es None
Es una lista de elementos directos de un conjunto de dependencias.
order string; el valor predeterminado es "default"
La estrategia de recorrido para el nuevo depset. Consulta aquí para conocer los valores posibles.
transitive secuencia de depsets; o None; el valor predeterminado es None
Es una lista de los depsets cuyos elementos se convertirán en elementos indirectos del depset.

existing_rule

unknown existing_rule(name)

Muestra un objeto similar a un diccionario inmutable que describe los atributos de una regla a la que se le creó una instancia en el paquete de este subproceso, o None si no existe una instancia de regla con ese nombre.

Aquí, un objeto inmutable similar a un diccionario significa un objeto x profundamente inmutable que admite la iteración similar a un diccionario, len(x), name in x, x[name], x.get(name), x.items(), x.keys() y x.values().

El resultado contiene una entrada para cada atributo, excepto los privados (cuyos nombres no comienzan con una letra) y algunos tipos de atributos heredados que no se pueden representar. Además, contiene entradas para name y kind de la instancia de la regla (por ejemplo, 'cc_binary').

Los valores del resultado representan los valores de atributo de la siguiente manera:

  • Los atributos de tipo str, int y bool se representan como están.
  • Las etiquetas se convierten en cadenas del formato ':foo' para los destinos en el mismo paquete o '//pkg:name' para los destinos en un paquete diferente.
  • Las listas se representan como tuplas, y los diccionarios se convierten en diccionarios nuevos y mutables. Sus elementos se convierten de manera recurrente de la misma manera.
  • Los valores de select se muestran con su contenido transformado como se describió anteriormente.
  • Los atributos para los que no se especificó ningún valor durante la creación de instancias de la regla y cuyo valor predeterminado se calcula se excluyen del resultado. (Los valores predeterminados calculados no se pueden calcular hasta la fase de análisis).

Si es posible, utiliza esta función solo en las funciones de implementación de las macros simbólicas del finalizador de reglas. No se recomienda el uso de esta función en otros contextos y se inhabilitará en una versión futura de Bazel. hace que los archivos BUILD sean frágiles y dependen del orden. Además, ten en cuenta que difiere sutilmente de las otras dos conversiones de valores de atributos de reglas de formato interno a Starlark: una se usa por valores predeterminados calculados y la otra se usa por ctx.attr.foo.

Parámetros

Parámetro Descripción
name cadena; obligatorio
Es el nombre del destino.

existing_rules

unknown existing_rules()

Muestra un objeto inmutable similar a un diccionario, en el que se describen las reglas para las que se crearon instancias en el paquete de este subproceso. Cada entrada del objeto similar a dict asigna el nombre de la instancia de la regla al resultado que mostrará existing_rule(name).

En este caso, un objeto inmutable similar a un dict significa un objeto profundamente inmutable x que admite iteraciones similares a las de un diccionario: len(x), name in x, x[name], x.get(name), x.items(), x.keys() y x.values().

Si es posible, usa esta función solo en las funciones de implementación de macros simbólicas del finalizador de reglas. No se recomienda el uso de esta función en otros contextos y se inhabilitará en una versión futura de Bazel. Esto hace que los archivos BUILD sean frágiles y dependan del orden.

exports_files

None exports_files(srcs, visibility=None, licenses=None)

Especifica una lista de archivos que pertenecen a este paquete y que se exportan a otros paquetes.

Parámetros

Parámetro Descripción
srcs secuencia de strings; obligatorio
La lista de archivos para exportar.
visibility sequence; o None; el valor predeterminado es None
Se puede especificar una declaración de visibilidad. Los archivos serán visibles para los destinos especificados. Si no se especifica la visibilidad, todos los paquetes podrán ver los archivos.
licenses Secuencia de cadenas o None; El valor predeterminado es None
. Las licencias que se deben especificar.

glob

sequence glob(include=[], exclude=[], exclude_directories=1, allow_empty=unbound)

Glob muestra una lista nueva, mutable y ordenada de todos los archivos del paquete actual que cumplen con las siguientes condiciones:
  • Coincide con al menos un patrón en include.
  • No coincide con ninguno de los patrones de exclude ([] predeterminado).
Si habilitas el argumento exclude_directories (configurado en 1), los archivos de tipo directorio se omitirán de los resultados (valor predeterminado: 1).

Parámetros

Parámetro Descripción
include Secuencia de cadenas. El valor predeterminado es []
. Es la lista de patrones glob que se incluirán.
exclude secuencia de strings; el valor predeterminado es []
La lista de patrones glob que se excluirán.
exclude_directories int; el valor predeterminado es 1
Una marca para excluir directorios o no.
allow_empty el valor predeterminado es unbound
Si permitimos que los patrones glob no coincidan con nada. Si "allow_empty" es False, cada patrón de inclusión individual debe coincidir con algo y el resultado final no debe estar vacío (después de que se excluyan las coincidencias de los patrones "exclude").

module_name

string module_name()

El nombre del módulo de Bazel asociado con el repositorio en el que se encuentra este paquete. Si este paquete es de un repositorio definido en WORKSPACE en lugar de MODULE.bazel, este campo estará vacío. En el caso de los repositorios generados por extensiones de módulos, este es el nombre del módulo que aloja la extensión. Es igual al campo module.name que se ve en module_ctx.modules. Es posible que se muestre None.

module_version

string module_version()

Es la versión del módulo de Bazel asociada con el repositorio en el que se encuentra este paquete. Si este paquete proviene de un repositorio definido en WORKSPACE en lugar de MODULE.bazel, estará vacío. En el caso de los repositorios generados por extensiones de módulos, esta es la versión del módulo que aloja la extensión. Es igual que el campo module.version que se ve en module_ctx.modules. Es posible que se muestre None.

package_group

None package_group(name, packages=[], includes=[])

Esta función define un conjunto de paquetes y asigna una etiqueta al grupo. Se puede hacer referencia a la etiqueta en los atributos visibility.

Parámetros

Parámetro Descripción
name cadena; obligatorio
Es el nombre único de esta regla.
packages secuencia de strings; el valor predeterminado es []
Una enumeración completa de los paquetes en este grupo.
includes secuencia de strings; el valor predeterminado es []
Otros grupos de paquetes que se incluyen en este.

package_name

string package_name()

Es el nombre del paquete que se evalúa, sin el nombre del repositorio. Por ejemplo, en el archivo BUILD some/package/BUILD, su valor será some/package. Si el archivo Build llama a una función definida en un archivo .bzl, package_name() coincidirá con el paquete de archivos BUILD del llamador.

package_relative_label

Label package_relative_label(input)

Convierte la cadena de entrada en un objeto Label, en el contexto del paquete que se está inicializando (es decir, el archivo BUILD para el cual se ejecuta la macro actual). Si la entrada ya es Label, se muestra sin cambios.

Solo se puede llamar a esta función mientras se evalúa un archivo BUILD y las macros que llama directa o indirectamente. es posible que no se llame, por ejemplo, en una función de implementación de reglas.

El resultado de esta función es el mismo valor de Label que se produciría si pasas la cadena dada a un atributo con valor de etiqueta de un destino declarado en el archivo BUILD.

Nota de uso: La diferencia entre esta función y Label() es que Label() usa el contexto del paquete del archivo .bzl que lo llamó, no el paquete del archivo BUILD. Usa Label() cuando necesites hacer referencia a un destino fijo codificado en la macro, como un compilador. Usa package_relative_label() cuando necesites normalizar una cadena de etiqueta proporcionada por el archivo BUILD a un objeto Label. (No hay forma de convertir una cadena en un Label en el contexto de un paquete que no sea el archivo BUILD o el archivo .bzl de llamada. Por esa razón, las macros externas siempre deben preferir pasar objetos Label a macros internas en lugar de cadenas de etiquetas.

Parámetros

Parámetro Descripción
input string; o Etiqueta; obligatorio
Es la cadena de etiqueta de entrada o el objeto Label. Si se pasa un objeto Label, se muestra tal como está.

repo_name

string repo_name()

Es el nombre canónico del repositorio que contiene el paquete que se está evaluando actualmente, sin signos de arroba al principio.

repository_name

string repository_name()

Experimental. Esta API es experimental y puede cambiar en cualquier momento. No dependas de ella. Se puede habilitar de forma experimental con la configuración de --+incompatible_enable_deprecated_label_apis
Obsoleto. Es preferible usar repo_name en su lugar, que no contiene el signo arroba inicial falso, pero se comporta de forma idéntica.

Es el nombre canónico del repositorio que contiene el paquete que se está evaluando actualmente, con un solo signo @ (@) como prefijo. Por ejemplo, en los paquetes que crea la estrofa WORKSPACE local_repository(name='local', path=...), se establecerá en @local. En los paquetes del repositorio principal, se establecerá en @.

seleccionar

unknown select(x, no_match_error='')

select() es la función auxiliar que permite que un atributo de regla sea configurable. Consulta la enciclopedia de compilaciones para obtener más detalles.

Parámetros

Parámetro Descripción
x dict; obligatorio
Un dict que asigna condiciones de configuración a valores. Cada clave es una Label o una cadena de etiqueta que identifica una instancia config_setting o constraint_value. Consulta la documentación sobre macros para saber cuándo usar una etiqueta en lugar de una cadena.
no_match_error cadena; el valor predeterminado es ''
Es un error personalizado opcional para informar si no se cumple ninguna condición.

subpaquetes

sequence subpackages(include, exclude=[], allow_empty=False)

Devuelve una nueva lista mutable de cada subpaquete directo del paquete actual, independientemente de la profundidad del directorio del sistema de archivos. La lista que se muestra está ordenada y contiene los nombres de los subpaquetes relacionados con el paquete actual. Se recomienda usar los métodos del módulo bazel_skylib.subpackages en lugar de llamar directamente a esta función.

Parámetros

Parámetro Descripción
include secuencia de cadenas; obligatorio
Es la lista de patrones glob que se incluirán en el análisis de subpaquetes.
exclude secuencia de cadenas; el valor predeterminado es []
Es la lista de patrones glob que se excluirán del análisis de subpaquetes.
allow_empty bool; el valor predeterminado es False
Si se produce un error si la llamada muestra una lista vacía De forma predeterminada, la lista vacía indica un posible error en el archivo BUILD, en el que la llamada a subpackages() es superflua. Si se establece como verdadero, esta función se realiza correctamente en ese caso.