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)
None
si no existe una instancia de regla con ese nombre.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()
.
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, 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 con el formato
':foo'
para destinos en el mismo paquete o'//pkg:name'
para 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 forma recursiva 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, 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. 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
|
string; required El nombre del objetivo. |
existing_rules
unknown native.existing_rules()
existing_rule(name)
.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 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
native.exports_files(srcs, visibility=None, licenses=None)
Parámetros
Parámetro | Descripción |
---|---|
srcs
|
secuencia de cadenas;
obligatorio Es la lista de archivos que se exportarán. |
visibility
|
secuencia 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 . Son las licencias que se deben especificar. |
glob
sequence native.glob(include=[], exclude=[], exclude_directories=1, allow_empty=unbound)
- 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
|
int;
El valor predeterminado es 1 Es una marca que indica si se deben excluir directorios o no. |
allow_empty
|
el valor predeterminado es unbound Indica 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()
module.name
que se ve en module_ctx.modules
.
Puede mostrar None
.
module_version
string native.module_version()
module.version
que se ve en module_ctx.modules
.
Puede mostrar None
.
package_group
None
native.package_group(name, packages=[], includes=[])
visibility
.
Parámetros
Parámetro | Descripción |
---|---|
name
|
cadena;
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 cadenas.
El valor predeterminado es [] . Otros grupos de paquetes que se incluyen en este. |
package_name
string native.package_name()
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)
BUILD
para el que se ejecuta la macro actual). Si la entrada ya es un 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. No se la puede llamar (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 objetivo fijo que esté 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 Label; obligatorio La string 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()
repository_name
string native.repository_name()
--+incompatible_enable_deprecated_label_apis
Obsoleto. En su lugar, es preferible usar
repo_name
, 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 @
.
subpaquetes
sequence native.subpackages(include, exclude=[], allow_empty=False)
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 Indica 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 superflua. Si se establece como verdadero, esta función se realiza correctamente en ese caso. |