Es un módulo integrado para admitir reglas nativas y otras funciones de ayuda de paquetes. Todas las reglas nativas aparecen como funciones en este módulo, p.ej., native.cc_library. Ten en cuenta que el módulo nativo solo está disponible en la fase de carga (es decir, para macros, no para implementaciones de reglas). Los atributos ignorarán los valores None y los tratarán como si el atributo no se hubiera establecido.
También están disponibles las siguientes funciones:
Miembros
- existing_rule
- existing_rules
- exports_files
- glob
- module_name
- module_version
- package_group
- package_name
- package_relative_label
- repo_name
- repository_name
- subpaquetes
existing_rule
unknown native.existing_rule(name)Muestra un objeto inmutable similar a un diccionario 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().
Si se establece la marca --noincompatible_existing_rules_immutable_view, en su lugar, muestra un nuevo diccionario mutable con el mismo contenido.
El resultado contiene una entrada para cada atributo, a excepción de los privados (cuyos nombres no comienzan con una letra) y algunos tipos de atributos heredados que no se pueden representar. Además, el diccionario 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 tal 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
selectse 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, evita usar esta función. Hace que los archivos BUILD sean frágiles y dependan 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
|
obligatorio Es el nombre del destino. |
existing_rules
unknown native.existing_rules()Muestra un objeto similar a un diccionario inmutable que describe las reglas que se crearon hasta el momento en el paquete de este subproceso. Cada entrada del objeto similar a un diccionario asigna el nombre de la instancia de la regla al resultado que
existing_rule(name) mostraría.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().
Si se establece la marca --noincompatible_existing_rules_immutable_view, en su lugar, muestra un nuevo diccionario mutable con el mismo contenido.
Nota: Si es posible, evita usar esta función. Hace que los archivos BUILD sean frágiles y dependan del orden. Además, si se establece la marca --noincompatible_existing_rules_immutable_view, esta función puede ser muy costosa, en especial si se llama dentro de un bucle.
exports_files
None native.exports_files(srcs, visibility=None, licenses=None)Parámetros
| Parámetro | Descripción |
|---|---|
srcs
|
secuencia de strings;
obligatoria Es la lista de archivos para exportar. |
visibility
|
secuencia o None; el valor predeterminado es NoneSe 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. Son las licencias que se deben especificar. |
glob
sequence native.glob(include=[], exclude=[], exclude_directories=1, allow_empty=unbound)Glob muestra una lista nueva, mutable y ordenada de cada archivo en el paquete actual que:
- Coincide con al menos un patrón en
include. - No coincide con ninguno de los patrones de
exclude([]predeterminado).
exclude_directories está habilitado (configurado en 1), se omitirán los archivos de tipo directorio de los resultados (1 predeterminado).
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 cadenas.
El valor predeterminado es []. Es la lista de patrones glob que se excluirán. |
exclude_directories
|
El valor predeterminado es 1Es una marca que indica si se deben excluir directorios o no. |
allow_empty
|
el valor predeterminado es unboundIndica si se permite que los patrones glob no coincidan con nada. Si `allow_empty` es falso, cada patrón de inclusión individual debe coincidir con algún elemento y también el resultado final no debe estar vacío (después de excluir las coincidencias de los patrones `excluir`). |
module_name
string native.module_name()Es el nombre del módulo de Bazel asociado 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, este es el nombre del módulo que aloja la extensión. Es igual que el campo
module.name que se ve en module_ctx.modules.
Puede mostrar None.
module_version
string native.module_version()Es la versión del módulo de Bazel asociado 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 native.package_group(name, packages=[], includes=[])visibility.
Parámetros
| Parámetro | Descripción |
|---|---|
name
|
obligatorio Es el nombre único de esta regla. |
packages
|
Secuencia de cadenas.
El valor predeterminado es []. Es una enumeración completa de los paquetes de este grupo. |
includes
|
secuencia de strings; el valor predeterminado es []Otros grupos de paquetes que se incluyen en este. |
package_name
string native.package_name()Es el nombre del paquete que se evalúa, sin el nombre del repositorio. Por ejemplo, en el archivo COMPILACIÓN
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 del archivo BUILD del llamador.
package_relative_label
Label native.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 a las que llama directa o indirectamente. No se puede llamar a esta función en (por ejemplo) una función de implementación de reglas.
El resultado de esta función es el mismo valor Label que se produciría si se pasara la cadena determinada 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 que proporciona 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
|
cadena o Etiqueta;
obligatorio Es la cadena de la etiqueta de entrada o el objeto Label. Si se pasa un objeto Label, se muestra tal como está. |
repo_name
string native.repo_name()El nombre canónico del repositorio que contiene el paquete que se está evaluando en el momento, sin signos arroba iniciales.
repository_name
string native.repository_name()Experimental: Esta API es experimental y puede cambiar en cualquier momento. No dependa de él. Se puede habilitar de forma experimental configurando
--+incompatible_enable_deprecated_label_apis Obsoleto. En su lugar, prefiere usar
repo_name, que no contiene el signo @ inicial falso, pero se comporta de manera idéntica en otros aspectos.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 @.
subpaquetes
sequence native.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 a esta función directamente.
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
|
El valor predeterminado es FalseIndica si fallamos 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 superflous. Si se establece como verdadero, esta función se realiza correctamente en ese caso. |