nativo/nativa/indígena/aborigen

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 no se hubiera establecido el atributo.
Las siguientes funciones también están disponibles:

Miembros

existing_rule

unknown native.existing_rule(name)

Muestra un objeto inmutable similar a un diccionario que describe los atributos de una instancia de la regla cuya instancia se creó en el paquete de este subproceso, o 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().

Si se establece la marca --noincompatible_existing_rules_immutable_view, en su lugar, muestra un nuevo dict mutable con el mismo contenido.

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, 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 los atributos de la siguiente manera:

  • Los atributos de tipo str, int y bool se representan 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, evita usar esta función. Hace que los archivos BUILD se vuelvan 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 del formato interno a Starlark: una que usan los valores predeterminados calculados y la otra que usa 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 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 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 dict mutable con el mismo contenido.

Nota: Si es posible, evita usar esta función. Hace que los archivos BUILD se vuelvan frágiles y dependen 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 la llama dentro de un bucle.

exports_files

None native.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 sequence of strings; obligatorio
La lista de archivos para exportar.
visibility sequence; or None; default = None
Se puede especificar una declaración de visibilidad. Los archivos serán visibles para los destinos especificados. Si no se especifica la visibilidad, los archivos serán visibles para todos los paquetes.
licenses sequence of strings; or None; default = None
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 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 el argumento 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 sequence of strings; default = []
Es la lista de patrones glob que se incluirán.
exclude sequence of strings; predeterminado = []
La lista de patrones glob que se excluirán.
exclude_directories predeterminado = 1
Una marca para excluir directorios o no.
allow_empty predeterminado = no delimitado
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").

package_group

None native.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 obligatorio
Es el nombre único de esta regla.
packages sequence of strings; predeterminado = []
Una enumeración completa de los paquetes en este grupo.
includes sequence of strings; predeterminado = []
Otros grupos de paquetes que se incluyen en este.

package_name

string native.package_name()

Es el nombre del paquete que se está evaluando. 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 del archivo BUILD del llamador. Esta función es equivalente a la variable obsoleta PACKAGE_NAME.

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 que 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 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 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 deberían preferir pasar objetos de etiqueta a macros internas en lugar de strings de etiquetas).

Parámetros

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

repository_name

string native.repository_name()

Es el nombre del repositorio desde el que se llama a la regla o extensión de compilación. 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á como @. Esta función es equivalente a la variable obsoleta REPOSITORY_NAME.

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 en relación 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 sequence of strings; obligatorio
Es la lista de patrones glob que se incluirán en el análisis de subpaquetes.
exclude sequence of strings; predeterminado = []
La lista de patrones glob que se excluirán del análisis de subpaquetes.
allow_empty default = 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 superflous. Establecer el valor en verdadero permite que esta función se ejecute correctamente en ese caso.