Ya comenzó el registro para BazelCon 2024

Se usó la API de Cloud Translation para traducir esta página.

Archivos .bzl

Informar un problema Por la noche · 7.3 · 7.2 · 7.1 · 7.0 · 6.5

Métodos globales disponibles en todos los archivos .bzl.

Miembros

analysis_test_transition
aspecto
configuration_field
depset
exec_group
exec_transition
module_extension
proveedor
repository_rule
rule
seleccionar
subregla
tag_class
visibilidad

analysis_test_transition

transition analysis_test_transition(settings)

Crea una transición de configuración que se aplicará a las dependencias de una regla de prueba de análisis. Esta transición solo se puede aplicar a los atributos de reglas con analysis_test = True. Esas reglas tienen capacidades de restricción (por ejemplo, el tamaño de su árbol de dependencias es limitado), por lo que las transiciones creadas con esta función tienen un alcance potencial limitado en comparación con las transiciones creadas con transition().

Esta función está diseñada principalmente para facilitar la biblioteca principal de Analysis Test Framework. Consulta su documentación (o su implementación) para conocer las prácticas recomendadas.

Parámetros

Parámetro Descripción

settings dict; obligatorio
Es un diccionario que contiene información sobre los ajustes de configuración que debe establecerse con esta transición de configuración. Las claves son etiquetas de configuración de compilación y los valores son sus nuevos valores posteriores a la transición. El resto de la configuración no se modificará. Úsalo para declarar parámetros de configuración específicos que una prueba de análisis debe establecer para aprobarse.

Parámetro	Descripción
`settings`	dict; obligatorio Es un diccionario que contiene información sobre los ajustes de configuración que debe establecerse con esta transición de configuración. Las claves son etiquetas de configuración de compilación y los valores son sus nuevos valores posteriores a la transición. El resto de la configuración no se modificará. Úsalo para declarar parámetros de configuración específicos que una prueba de análisis debe establecer para aprobarse.

aspecto

Aspect aspect(implementation, attr_aspects=[], toolchains_aspects=[], attrs={}, required_providers=[], required_aspect_providers=[], provides=[], requires=[], fragments=[], host_fragments=[], toolchains=[], incompatible_use_toolchain_transition=False, doc=None, *, apply_to_generating_rules=False, exec_compatible_with=[], exec_groups=None, subrules=[])

Crea un aspecto nuevo. El resultado de esta función se debe almacenar en un valor global. Consulta la introducción a los aspectos para obtener más detalles.

Parámetros

Parámetro	Descripción
`implementation`	function; obligatorio Es una función de Starlark que implementa este aspecto, con exactamente dos parámetros: Target (el objetivo al que se aplica el aspecto) y ctx (el contexto de la regla desde el que se crea el objetivo). Los atributos del destino están disponibles en el campo `ctx.rule`. Esta función se evalúa durante la fase de análisis de cada aplicación de un aspecto a un objetivo.
`attr_aspects`	secuencia de strings; el valor predeterminado es `[]` Lista de nombres de atributos. El aspecto se propaga a lo largo de las dependencias especificadas en los atributos de un destino con estos nombres. Los valores comunes aquí incluyen `deps` y `exports`. La lista también puede contener una sola cadena `"*"` para propagarse a lo largo de todas las dependencias de un destino.
`toolchains_aspects`	sequence; el valor predeterminado es `[]` Lista de tipos de cadenas de herramientas. El aspecto se propaga a las cadenas de herramientas de destino que coinciden con estos tipos de cadenas de herramientas.
`attrs`	dict; el valor predeterminado es `{}` Es un diccionario que declara todos los atributos del aspecto. Asigna de un nombre de atributo a un objeto de atributo, como `attr.label` o `attr.string` (consulta el módulo `attr`). Los atributos de aspecto están disponibles para la función de implementación como campos del parámetro `ctx`. Los atributos implícitos que comienzan con `_` deben tener valores predeterminados y tener el tipo `label` o `label_list`. Los atributos explícitos deben tener el tipo `string` y usar la restricción `values`. Los atributos explícitos restringen el aspecto para que se use únicamente con reglas que tengan atributos del mismo nombre, tipo y valores válidos según la restricción. Los atributos declarados convertirán `None` al valor predeterminado.
`required_providers`	sequence; el valor predeterminado es `[]` Este atributo permite que el aspecto limite su propagación solo a los destinos cuyas reglas anuncien sus proveedores obligatorios. El valor debe ser una lista que contenga proveedores individuales o listas de proveedores, pero no ambas. Por ejemplo, `[[FooInfo], [BarInfo], [BazInfo, QuxInfo]]` es un valor válido, mientras que `[FooInfo, BarInfo, [BazInfo, QuxInfo]]` no lo es. Una lista de proveedores no anidada se convertirá automáticamente en una lista que contiene una lista de proveedores. Es decir, `[FooInfo, BarInfo]` se convertirá automáticamente en `[[FooInfo, BarInfo]]`. Para que algunos objetivos de reglas (p.ej., `some_rule`) sean visibles para un aspecto, `some_rule` debe promocionar todos los proveedores de, al menos, una de las listas de proveedores obligatorias. Por ejemplo, si las `required_providers` de un aspecto son `[[FooInfo], [BarInfo], [BazInfo, QuxInfo]]`, este aspecto puede ver los objetivos de `some_rule` solo si `some_rule` proporciona `FooInfo`, o `BarInfo`, o `BazInfo` y `QuxInfo`.
`required_aspect_providers`	secuencia: El valor predeterminado es `[]` . Este atributo permite que este aspecto inspeccione otros aspectos. El valor debe ser una lista que contenga proveedores individuales o listas de proveedores, pero no ambos. Por ejemplo, `[[FooInfo], [BarInfo], [BazInfo, QuxInfo]]` es un valor válido, mientras que `[FooInfo, BarInfo, [BazInfo, QuxInfo]]` no lo es. Una lista de proveedores no anidada se convertirá automáticamente en una lista que contenga una lista de proveedores. Es decir, `[FooInfo, BarInfo]` se convertirá automáticamente en `[[FooInfo, BarInfo]]`. Para que otro aspecto (p. ej., `other_aspect`) sea visible para este aspecto, `other_aspect` debe proporcionar todos los proveedores de al menos una de las listas. En el ejemplo de `[[FooInfo], [BarInfo], [BazInfo, QuxInfo]]`, este aspecto puede ver `other_aspect` solo si `other_aspect` proporciona `FooInfo`, o `BarInfo`, o `BazInfo` y `QuxInfo`.
`provides`	sequence; el valor predeterminado es `[]` Una lista de proveedores que debe mostrar la función de implementación. Se produce un error si la función de implementación omite cualquiera de los tipos de proveedores que se enumeran aquí de su valor que se muestra. Sin embargo, la función de implementación puede mostrar proveedores adicionales que no se mencionan aquí. Cada elemento de la lista es un objeto `*Info` que muestra `provider()`, excepto que un proveedor heredado está representado por su nombre de cadena.Cuando un destino de la regla se usa como dependencia de un destino que declara un proveedor obligatorio, no es necesario especificar ese proveedor aquí. Es suficiente que la función de implementación lo devuelva. Sin embargo, se considera una práctica recomendada especificarlo, aunque esto no es obligatorio. Sin embargo, el campo `required_providers` de un aspecto requiere que los proveedores se especifiquen aquí.
`requires`	secuencia de Aspectos el valor predeterminado es `[]` Lista de aspectos que se deben propagar antes de este aspecto.
`fragments`	Secuencia de cadenas. El valor predeterminado es `[]` . Es la lista de nombres de fragmentos de configuración que el aspecto requiere en la configuración de destino.
`host_fragments`	Secuencia de cadenas. El valor predeterminado es `[]` . Es la lista de nombres de fragmentos de configuración que el aspecto requiere en la configuración del host.
`toolchains`	sequence; el valor predeterminado es `[]` Si se establece, el conjunto de cadenas de herramientas que requiere este aspecto. La lista puede contener objetos String, Label o StarlarkToolchainTypeApi, en cualquier combinación. Las cadenas de herramientas se encontrarán revisando la plataforma actual y se proporcionarán a la implementación de aspectos a través de `ctx.toolchain`.
`incompatible_use_toolchain_transition`	bool; El valor predeterminado es `False` . Está obsoleto, ya no se usa y se debe quitar.
`doc`	string; o `None`; el valor predeterminado es `None` Una descripción del aspecto que se puede extraer con herramientas de generación de documentación.
`apply_to_generating_rules`	bool; el valor predeterminado es `False` Si es verdadero, el aspecto, cuando se aplique a un archivo de salida, se aplicará a la regla de generación del archivo de salida. Por ejemplo, supongamos que un aspecto se propaga de forma transitiva a través del atributo "deps" y se aplica al objetivo "alpha". Supongamos que "alpha" tiene "deps = [':beta_output']`, donde "beta_output" es un resultado declarado de un objetivo "beta". Supongamos que "beta" tiene un objetivo "charlie" como uno de sus "deps". Si "apply_to_generating_rules=True" para el aspecto, el aspecto se propagará a través de "alpha", "beta" y "charlie". Si es "False", el aspecto solo se propagará a "alpha". Es falso de forma predeterminada.
`exec_compatible_with`	secuencia de cadenas; el valor predeterminado es `[]` Es una lista de restricciones en la plataforma de ejecución que se aplican a todas las instancias de este aspecto.
`exec_groups`	dict; o `None`; el valor predeterminado es `None` Dictado del nombre del grupo de ejecución (cadena) a `exec_group`. Si se establece, permite que los aspectos ejecuten acciones en varias plataformas de ejecución dentro de una sola instancia. Consulta la documentación de grupos de ejecución para obtener más información.
`subrules`	secuencia de subreglas; el valor predeterminado es `[]` Experimental: Es la lista de subreglas que usa este aspecto.

configuration_field

LateBoundDefault configuration_field(fragment, name)

Hace referencia a un valor predeterminado vinculado tardíamente para un atributo de tipo label. Un valor es "vinculado tardíamente" si requiere que se compile la configuración antes de determinar el valor. Cualquier atributo que use esto como valor debe ser privado.

Ejemplo de uso:

Definición de un atributo de regla:

'_foo': attr.label(default=configuration_field(fragment='java', name='toolchain'))

Acceso en la implementación de reglas:

  def _rule_impl(ctx):
    foo_info = ctx.attr._foo
    ...

Parámetros

Parámetro	Descripción
`fragment`	cadena; obligatorio Es el nombre de un fragmento de configuración que contiene el valor vinculado tardío.
`name`	string; obligatorio Es el nombre del valor que se obtendrá del fragmento de configuración.

depset

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

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

Todos los elementos (directos e indirectos) de un conjunto de dependencias deben ser del mismo tipo, como se obtiene con la expresión type(x).

Debido a que un conjunto basado en hash se usa para eliminar duplicados durante la iteración, todos los elementos de un depset deben tener codificación hash. Sin embargo, 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, los elementos deben ser inmutables, aunque esta restricción se relajará 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í 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.

exec_group

exec_group exec_group(toolchains=[], exec_compatible_with=[])

Crea un grupo de ejecución que se puede usar para crear acciones para una plataforma de ejecución específica durante la implementación de reglas.

Parámetros

Parámetro	Descripción
`toolchains`	sequence; El valor predeterminado es `[]` Es el conjunto de cadenas de herramientas que requiere este grupo de ejecución. La lista puede contener objetos String, Label o StarlarkToolchainTypeApi, en cualquier combinación.
`exec_compatible_with`	Secuencia de cadenas. El valor predeterminado es `[]` . Es una lista de restricciones en la plataforma de ejecución.

exec_transition

transition exec_transition(implementation, inputs, outputs)

Una versión especializada de transition() que se usa para definir la transición de ejecución. Consulta su documentación (o su implementación) para conocer las prácticas recomendadas. Solo se puede usar desde los componentes integrados de Bazel.

Parámetros

Parámetro	Descripción
`implementation`	callable; obligatorio
`inputs`	secuencia de strings; obligatorio
`outputs`	secuencia de cadenas; obligatorio

module_extension

unknown module_extension(implementation, *, tag_classes={}, doc=None, environ=[], os_dependent=False, arch_dependent=False)

Crea una nueva extensión de módulo. Guárdalo en un valor global para que se pueda exportar y usar en un archivo MODULE.bazel con use_extension.

Parámetros

Parámetro	Descripción
`implementation`	callable; required Es la función que implementa esta extensión de módulo. Debe tomar un solo parámetro, `module_ctx`. Se llama a la función una vez al comienzo de una compilación para determinar el conjunto de repositorios disponibles.
`tag_classes`	dict; El valor predeterminado es `{}` . Es un diccionario para declarar todas las clases de etiquetas que usa la extensión. Se asigna del nombre de la clase de etiqueta a un objeto `tag_class`.
`doc`	string; o `None`; el valor predeterminado es `None` Una descripción de la extensión del módulo que se puede extraer con herramientas de generación de documentación.
`environ`	Secuencia de cadenas. El valor predeterminado es `[]` . Proporciona una lista de variables de entorno de las que depende esta extensión de módulo. Si cambia una variable de entorno de esa lista, se volverá a evaluar la extensión.
`os_dependent`	bool; el valor predeterminado es `False` Indica si esta extensión depende del SO o no
`arch_dependent`	bool; el valor predeterminado es `False` Indica si esta extensión depende de la arquitectura o no.

proveedor

unknown provider(doc=None, *, fields=None, init=None)

Define un símbolo de proveedor. El resultado de esta función se debe almacenar en un valor global. Se puede crear una instancia del proveedor llamándolo o se puede usar directamente como clave para recuperar una instancia de ese proveedor desde un destino. Ejemplo:

MyInfo = provider()
...
def _my_library_impl(ctx):
    ...
    my_info = MyInfo(x = 2, y = 3)
    # my_info.x == 2
    # my_info.y == 3
    ...

Consulta Reglas (proveedores) para obtener una guía completa sobre cómo usar los proveedores.

Muestra un valor de llamada Provider si no se especifica init.

Si se especifica init, muestra una tupla de 2 elementos: un valor que se puede llamar de Provider y un valor que se puede llamar de constructor sin procesar. Consulta Rules (Custom initialization of custom providers) y el análisis del parámetro init que aparece a continuación para obtener más detalles.

Parámetros

Parámetro Descripción

doc string; o None; el valor predeterminado es None
Una descripción del proveedor que se puede extraer con herramientas de generación de documentación.

Parámetro	Descripción
`doc`	string; o `None`; el valor predeterminado es `None` Una descripción del proveedor que se puede extraer con herramientas de generación de documentación.
`fields`	secuencia de strings; o dict; o `None`; la configuración predeterminada es `None` Si se especifica, restringe el conjunto de campos permitidos. Los valores posibles son los siguientes: lista de campos: provider(fields = ['a', 'b']) nombre del campo del diccionario -> documentación: provider( fields = { 'a' : 'Documentation for a', 'b' : 'Documentation for b' }) Todos los campos son opcionales.
`init`	callable; o `None`; el valor predeterminado es `None` Es una devolución de llamada opcional para el procesamiento previo y la validación de los valores de campo del proveedor durante la creación de instancias. Si se especifica `init`, `provider()` muestra una tupla de 2 elementos: el símbolo de proveedor normal y un constructor sin procesar. A continuación, se incluye una descripción precisa. Consulta Reglas (inicialización personalizada de proveedores) para obtener una explicación intuitiva y casos de uso. Supongamos que `P` es el símbolo del proveedor creado con una llamada a `provider()`. De forma conceptual, una instancia de `P` se genera llamando a una función de constructor predeterminada `c(args, kwargs)`, que hace lo siguiente: Si `args` no está vacío, se produce un error. Se produce un error si se especificó el parámetro `fields` cuando se llamó a `provider()` y si `kwargs` contiene alguna clave que no aparecía en `fields`. De lo contrario, `c` muestra una instancia nueva que tiene, para cada entrada `k: v` en `kwargs`, un campo llamado `k` con el valor `v`. En el caso en que no se proporcione una devolución de llamada `init`, una llamada al símbolo `P` actúa como una llamada a la función de constructor predeterminada `c`. en otras palabras, `P(args, *kwargs)` muestra `c(args, *kwargs)`. Por ejemplo, MyInfo = provider() m = MyInfo(foo = 1) hará que `m` sea una instancia de `MyInfo` con `m.foo == 1`. Sin embargo, en el caso de que se especifique `init`, la llamada `P(args, *kwargs)` realizará los siguientes pasos: La devolución de llamada se invoca como `init(args, kwargs)`, es decir, con los mismos argumentos posicionales y de palabras clave que se pasaron a `P`. Se espera que el valor que se muestra de `init` sea un diccionario, `d`, cuyas claves son cadenas de nombres de campo. De lo contrario, se producirá un error. Se genera una instancia nueva de `P` como si se llamara al constructor predeterminado con las entradas de `d` como argumentos de palabras clave, como en `c(d)`. Nota: Los pasos anteriores implican que se produce un error si `args` o `kwargs` no coinciden con la firma de `init`, si falla la evaluación del cuerpo de `init` (quizás intencionalmente mediante una llamada a `fail()`) o si el valor que se muestra de `init` no es un diccionario con el esquema esperado. De esta manera, la devolución de llamada `init` generaliza la construcción normal del proveedor, ya que permite argumentos posicionales y lógica arbitraria para el procesamiento previo y la validación. No permite eludir la lista de elementos permitidos de `fields`. Cuando se especifica `init`, el valor que se muestra de `provider()` se convierte en una tupla `(P, r)`, donde `r` es el constructor sin procesar*. De hecho, el comportamiento de `r` es exactamente el de la función de constructor predeterminado `c` que se analizó anteriormente. Por lo general, `r` está vinculado a una variable cuyo nombre tiene un prefijo de guion bajo, de modo que solo el archivo .bzl actual tenga acceso directo a él: MyInfo, _new_myinfo = provider(init = ...)

fields

secuencia de strings; o dict; o None; la configuración predeterminada es None
Si se especifica, restringe el conjunto de campos permitidos.
Los valores posibles son los siguientes:

lista de campos:
```
provider(fields = ['a', 'b'])
```

nombre del campo del diccionario -> documentación:

provider(
       fields = { 'a' : 'Documentation for a', 'b' : 'Documentation for b' })

Todos los campos son opcionales.

init

callable; o None; el valor predeterminado es None
Es una devolución de llamada opcional para el procesamiento previo y la validación de los valores de campo del proveedor durante la creación de instancias. Si se especifica init, provider() muestra una tupla de 2 elementos: el símbolo de proveedor normal y un constructor sin procesar.

A continuación, se incluye una descripción precisa. Consulta Reglas (inicialización personalizada de proveedores) para obtener una explicación intuitiva y casos de uso.

Supongamos que P es el símbolo del proveedor creado con una llamada a provider(). De forma conceptual, una instancia de P se genera llamando a una función de constructor predeterminada c(*args, **kwargs), que hace lo siguiente:

Si args no está vacío, se produce un error.
Se produce un error si se especificó el parámetro fields cuando se llamó a provider() y si kwargs contiene alguna clave que no aparecía en fields.
De lo contrario, c muestra una instancia nueva que tiene, para cada entrada k: v en kwargs, un campo llamado k con el valor v.

En el caso en que no se proporcione una devolución de llamada init, una llamada al símbolo P actúa como una llamada a la función de constructor predeterminada c. en otras palabras, P(*args, **kwargs) muestra c(*args, **kwargs). Por ejemplo,

MyInfo = provider()
m = MyInfo(foo = 1)

hará que m sea una instancia de MyInfo con m.foo == 1.

Sin embargo, en el caso de que se especifique init, la llamada P(*args, **kwargs) realizará los siguientes pasos:

La devolución de llamada se invoca como init(*args, **kwargs), es decir, con los mismos argumentos posicionales y de palabras clave que se pasaron a P.
Se espera que el valor que se muestra de init sea un diccionario, d, cuyas claves son cadenas de nombres de campo. De lo contrario, se producirá un error.
Se genera una instancia nueva de P como si se llamara al constructor predeterminado con las entradas de d como argumentos de palabras clave, como en c(**d).

Nota: Los pasos anteriores implican que se produce un error si *args o **kwargs no coinciden con la firma de init, si falla la evaluación del cuerpo de init (quizás intencionalmente mediante una llamada a fail()) o si el valor que se muestra de init no es un diccionario con el esquema esperado.

De esta manera, la devolución de llamada init generaliza la construcción normal del proveedor, ya que permite argumentos posicionales y lógica arbitraria para el procesamiento previo y la validación. No permite eludir la lista de elementos permitidos de fields.

Cuando se especifica init, el valor que se muestra de provider() se convierte en una tupla (P, r), donde r es el constructor sin procesar. De hecho, el comportamiento de r es exactamente el de la función de constructor predeterminado c que se analizó anteriormente. Por lo general, r está vinculado a una variable cuyo nombre tiene un prefijo de guion bajo, de modo que solo el archivo .bzl actual tenga acceso directo a él:

MyInfo, _new_myinfo = provider(init = ...)

repository_rule

callable repository_rule(implementation, *, attrs=None, local=False, environ=[], configure=False, remotable=False, doc=None)

Crea una nueva regla de repositorio. Almacenarlo en un valor global para que se pueda cargar y llamar desde una función de implementación module_extension() o que lo use use_repo_rule()

Parámetros

Parámetro	Descripción
`implementation`	callable; required es la función que implementa esta regla. Debe tener un solo parámetro, `repository_ctx`. Se llama a la función durante la fase de carga para cada instancia de la regla.
`attrs`	dict o `None`; el valor predeterminado es `None` Es un diccionario para declarar todos los atributos de la regla del repositorio. Asigna desde un nombre de atributo hasta un objeto de atributo (consulta la sección `attr`). Los atributos que comienzan con `_` son privados y se pueden usar para agregar una dependencia implícita de una etiqueta a un archivo (una regla de repositorio no puede depender de un artefacto generado). El atributo `name` se agrega de forma implícita y no debe especificarse. Los atributos declarados convertirán `None` al valor predeterminado.
`local`	bool; el valor predeterminado es `False` Indica que esta regla recupera todo del sistema local y que debe volver a evaluarse en cada recuperación.
`environ`	Secuencia de cadenas. El valor predeterminado es `[]` . Obsoleto. Este parámetro ya no está disponible. Migra a `repository_ctx.getenv`. Proporciona una lista de variables de entorno de las que depende esta regla del repositorio. Si cambia una variable de entorno de esa lista, se volverá a recuperar el repositorio.
`configure`	bool; El valor predeterminado es `False` Indica que el repositorio inspecciona el sistema con fines de configuración.
`remotable`	bool; el valor predeterminado es `False` Experimental Este parámetro es experimental y puede cambiar en cualquier momento. No dependa de él. Se puede habilitar de forma experimental estableciendo `--experimental_repo_remote_exec` Compatible con la ejecución remota
`doc`	cadena o `None`; el valor predeterminado es `None` Es una descripción de la regla del repositorio que pueden extraer las herramientas de generación de documentación.

regla

callable rule(implementation, *, test=unbound, attrs={}, outputs=None, executable=unbound, output_to_genfiles=False, fragments=[], host_fragments=[], _skylark_testable=False, toolchains=[], incompatible_use_toolchain_transition=False, doc=None, provides=[], dependency_resolution_rule=False, exec_compatible_with=[], analysis_test=False, build_setting=None, cfg=None, exec_groups=None, initializer=None, parent=None, extendable=None, subrules=[])

Crea una regla nueva, a la que se puede llamar desde un archivo CREA o una macro para crear orientaciones.

Las reglas se deben asignar a variables globales en un archivo .bzl. El nombre de la variable global es el nombre de la regla.

Las reglas de prueba deben tener un nombre que termine en _test, mientras que las demás reglas no deben tener este sufijo. (Esta restricción solo se aplica a las reglas, no a sus objetivos).

Parámetros

Parámetro	Descripción
`implementation`	function; obligatorio La función Starlark que implementa esta regla debe tener exactamente un parámetro: ctx. Se llama a la función durante la fase de análisis para cada instancia de la regla. Puede acceder a los atributos que proporciona el usuario. Debe crear acciones para generar todos los resultados declarados.
`test`	bool; el valor predeterminado es `unbound` Indica si esta regla es una regla de prueba, es decir, si puede ser el objeto de un comando `blaze test`. Todas las reglas de prueba se consideran automáticamente executable. No es necesario (y se recomienda) configurar de manera explícita `executable = True` para una regla de prueba. El valor predeterminado es `False`. Consulta la página Reglas para obtener más información.
`attrs`	dict; El valor predeterminado es `{}` . Es un diccionario para declarar todos los atributos de la regla. Asigna desde un nombre de atributo hasta un objeto de atributo (consulta la sección `attr`). Los atributos que comienzan con `_` son privados y se pueden usar para agregar una dependencia implícita en una etiqueta. El atributo `name` se agrega de forma implícita y no debe especificarse. Los atributos `visibility`, `deprecation`, `tags`, `testonly` y `features` se agregan de forma implícita y no se pueden anular. La mayoría de las reglas solo necesitan unos pocos atributos. Para limitar el uso de memoria, existe un límite en la cantidad de atributos que se pueden declarar. Los atributos declarados convertirán `None` al valor predeterminado.
`outputs`	dict; o `None`; o función; el valor predeterminado es `None` Obsoleto. Este parámetro dejó de estar disponible y se quitará pronto. No dependa de él. Está inhabilitada con `--incompatible_no_rule_outputs_param`. Usa esta función experimental para verificar que tu código sea compatible con su eliminación inminente. Este parámetro ya no está disponible. Migra las reglas para usar `OutputGroupInfo` o `attr.output` en su lugar. Un esquema para definir resultados declarados con anterioridad. A diferencia de los atributos `output` y `output_list`, el usuario no especifica las etiquetas para estos archivos. Consulta la página Reglas para obtener más información sobre los resultados declarados previamente. El valor de este argumento es un diccionario o una función de devolución de llamada que produce un diccionario. La devolución de llamada funciona de manera similar a los atributos de dependencia calculados: los nombres de los parámetros de la función se comparan con los atributos de la regla, por lo que, por ejemplo, si pasas `outputs = _my_func` con la definición `def _my_func(srcs, deps): ...`, la función tendrá acceso a los atributos `srcs` y `deps`. Ya sea que el diccionario se especifique directamente o a través de una función, se interpreta de la siguiente manera. Cada entrada del diccionario crea un resultado declarado previamente en el que la clave es un identificador y el valor es una plantilla de cadena que determina la etiqueta del resultado. En la función de implementación de la regla, el identificador se convierte en el nombre del campo que se usa para acceder a `File` del resultado en `ctx.outputs`. La etiqueta del resultado tiene el mismo paquete que la regla, y la parte posterior al paquete se produce cuando se sustituye cada marcador de posición del formato `"%{ATTR}"` por una cadena formada a partir del valor del atributo `ATTR`: Los atributos de tipo string se sustituyen textualmente. Los atributos de tipo de etiqueta se convierten en la parte de la etiqueta después del paquete, menos la extensión del archivo. Por ejemplo, la etiqueta `"//pkg:a/b.c"` se convierte en `"a/b"`. Los atributos de tipo de salida se convierten en la parte de la etiqueta después del paquete, incluida la extensión del archivo (en el ejemplo anterior, `"a/b.c"`). Todos los atributos de tipo lista (por ejemplo, `attr.label_list`) que se usan en los marcadores de posición deben tener exactamente un elemento. Su conversión es igual a la versión que no está en la lista (`attr.label`). Es posible que otros tipos de atributos no aparezcan en los marcadores de posición. Los marcadores de posición especiales que no son de atributos `%{dirname}` y `%{basename}` se expanden a esas partes de la etiqueta de la regla, sin incluir su paquete. Por ejemplo, en `"//pkg:a/b.c"`, el nombre de directorio es `a` y el nombre base es `b.c`. En la práctica, el marcador de posición de sustitución más común es `"%{name}"`. Por ejemplo, para un objetivo llamado "foo", el diccionario de resultados `{"bin": "%{name}.exe"}` declara previamente un resultado llamado `foo.exe` al que se puede acceder en la función de implementación como `ctx.outputs.bin`.
`executable`	bool; el valor predeterminado es `unbound` Si esta regla se considera ejecutable, es decir, si puede estar sujeta a un comando `blaze run`. El valor predeterminado es `False`. Consulta la página Reglas para obtener más información.
`output_to_genfiles`	bool; El valor predeterminado es `False` . Si es verdadero, los archivos se generarán en el directorio genfiles en lugar del directorio bin. A menos que la necesites para mantener la compatibilidad con reglas existentes (p.ej., cuando se generan archivos de encabezado para C++), no establezcas esta marca.
`fragments`	secuencia de strings; el valor predeterminado es `[]` Lista de nombres de fragmentos de configuración que requiere la regla en la configuración de destino.
`host_fragments`	Secuencia de cadenas. El valor predeterminado es `[]` . Es la lista de nombres de los fragmentos de configuración que la regla requiere en la configuración del host.
`_skylark_testable`	bool; El valor predeterminado es `False` (Experimental) Si es verdadero, esta regla expondrá sus acciones para que las inspeccionen las reglas que dependen de ella a través de un proveedor `Actions`. El proveedor también está disponible para la regla en sí. Para ello, llama a ctx.created_actions(). Esto solo debe usarse para probar el comportamiento en el tiempo de análisis de las reglas de Starlark. Es posible que esta marca se quite en el futuro.
`toolchains`	sequence; el valor predeterminado es `[]` Si se establece, el conjunto de cadenas de herramientas que requiere esta regla. La lista puede contener objetos String, Label o StarlarkToolchainTypeApi, en cualquier combinación. Las cadenas de herramientas se encontrarán revisando la plataforma actual y se proporcionarán a la implementación de reglas a través de `ctx.toolchain`.
`incompatible_use_toolchain_transition`	bool; El valor predeterminado es `False` . Está obsoleto, ya no se usa y se debe quitar.
`doc`	cadena o `None`; el valor predeterminado es `None` Es una descripción de la regla que pueden extraer las herramientas de generación de documentación.
`provides`	sequence: El valor predeterminado es `[]` . Es una lista de proveedores que debe mostrar la función de implementación. Es un error si la función de implementación omite cualquiera de los tipos de proveedores que se enumeran aquí de su valor que se muestra. Sin embargo, la función de implementación puede mostrar proveedores adicionales que no se mencionan aquí. Cada elemento de la lista es un objeto `*Info` que muestra `provider()`, excepto que un proveedor heredado está representado por su nombre de cadena.Cuando un destino de la regla se usa como dependencia de un destino que declara un proveedor obligatorio, no es necesario especificar ese proveedor aquí. Basta con que la función de implementación lo muestre. Sin embargo, se considera una práctica recomendada especificarlo, aunque esto no es obligatorio. Sin embargo, el campo `required_providers` de un aspecto requiere que los proveedores se especifiquen aquí.
`dependency_resolution_rule`	bool; El valor predeterminado es `False` Si se establece, la regla puede ser una dependencia a través de atributos que también se marcan como disponibles en los materializadores. Cada atributo de reglas con este conjunto de marcas debe marcarse como disponible en los materializadores. Esto se hace para que las reglas marcadas de esta manera no puedan depender de reglas que no estén marcadas.
`exec_compatible_with`	secuencia de strings; el valor predeterminado es `[]` Una lista de restricciones en la plataforma de ejecución que se aplican a todos los destinos de este tipo de regla.
`analysis_test`	bool; el valor predeterminado es `False` Si es verdadera, esta regla se trata como una prueba de análisis. Nota: Las reglas de prueba de análisis se definen principalmente con la infraestructura proporcionada en las bibliotecas principales de Starlark. Consulta Pruebas para obtener orientación. Si una regla se define como una regla de prueba de análisis, se permite usar transiciones de configuración definidas con analysis_test_transition en sus atributos, pero se aplican algunas restricciones: Los destinos de esta regla están limitados en la cantidad de dependencias transitivas que pueden tener. La regla se considera una regla de prueba (como si se configuraran `test=True`). Esta acción anula el valor de `test`. Es posible que la función de implementación de reglas no registre acciones. En su lugar, debe registrar un resultado de aprobado o reprobado a través de AnalysisTestResultInfo.
`build_setting`	BuildSetting; o `None`; el valor predeterminado es `None` Si se establece, describe qué tipo de `build setting` es esta regla. Consulta el módulo `config`. Si se establece, se agrega automáticamente un atributo obligatorio llamado "build_setting_default" a esta regla, con un tipo que corresponde al valor que se pasa aquí.
`cfg`	el valor predeterminado es `None` Si se establece, apunta a la transición de configuración que la regla aplicará a su propia configuración antes del análisis.
`exec_groups`	dict o `None`; el valor predeterminado es `None` Diccionario del nombre del grupo de ejecución (cadena) a `exec_group`s. Si se establece, permite que las reglas ejecuten acciones en varias plataformas de ejecución dentro de un solo objetivo. Consulta la documentación de los grupos de ejecución para obtener más información.
`initializer`	el valor predeterminado es `None` Experimental: La función Stalark inicializa los atributos de la regla. Se llama a la función en el momento de la carga para cada instancia de la regla. Se llama con `name` y los valores de los atributos públicos definidos por la regla (no con atributos genéricos, como `tags`). Debe mostrar un diccionario de los nombres de los atributos a los valores deseados. Los atributos que no se muestran no se ven afectados. Si se muestra `None` como valor, se usará el valor predeterminado especificado en la definición del atributo. Los inicializadores se evalúan antes que los valores predeterminados especificados en una definición de atributo. En consecuencia, si un parámetro en la firma del inicializador contiene valores predeterminados, reemplaza el valor predeterminado de la definición del atributo (excepto si muestra `None`). Del mismo modo, si un parámetro en la firma del inicializador no tiene un valor predeterminado, será obligatorio. En esos casos, se recomienda omitir la configuración predeterminada o obligatoria en la definición de un atributo. Se recomienda usar `**kwargs` para los atributos que no se controlan. En el caso de las reglas extendidas, se llama a todos los inicializadores desde los secundarios hasta los superiores. A cada inicializador se le pasan solo los atributos públicos que conoce.
`parent`	El valor predeterminado es `None` Experimental: Es la regla de Stalark que se extiende. Cuando se configuran, se combinan los atributos públicos y los proveedores anunciados. La regla coincide con `executable` y `test` del elemento superior. Se combinan los valores de `fragments`, `toolchains`, `exec_compatible_with` y `exec_groups`. Es posible que no se configuren los parámetros obsoletos o heredados. La transición de configuración entrante `cfg` del elemento superior se aplica después de la configuración entrante de thisrule.
`extendable`	bool, Label, string o `None`; El valor predeterminado es `None` Experimental: Es una etiqueta de una lista de entidades permitidas que define qué reglas pueden extender esta regla. También se puede establecer en verdadero o falso para permitir o no la extensión. Bazel tiene la opción predeterminada para permitir extensiones siempre.
`subrules`	secuencia de subreglas; el valor predeterminado es `[]` Experimental: Es la lista de subreglas que usa esta regla.

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.

subregla

Subrule subrule(implementation, attrs={}, toolchains=[], fragments=[], subrules=[])

Construye una instancia nueva de una subregla. El resultado de esta función debe almacenarse en una variable global antes de poder usarse.

Parámetros

Parámetro	Descripción
`implementation`	function; obligatorio La función Starlark que implementa esta subregla
`attrs`	dict; el valor predeterminado es `{}` Es un diccionario para declarar todos los atributos (privados) de la subregla. Las subreglas solo pueden tener atributos privados que sean de tipo etiqueta (es decir, etiqueta o lista de etiquetas). Bazel pasa automáticamente los valores resueltos correspondientes a estas etiquetas a la función de implementación de la subregla como argumentos con nombre (por lo tanto, la función de implementación debe aceptar parámetros con nombre que coincidan con los nombres de los atributos). Los tipos de estos valores serán los siguientes: `FilesToRunProvider` para atributos de etiqueta con `executable=True` `File` para atributos de etiqueta con `allow_single_file=True` `Target` para todos los demás atributos de etiqueta `[Target]` para todos los atributos de la lista de etiquetas
`toolchains`	sequence; el valor predeterminado es `[]` Si se establece, es el conjunto de cadenas de herramientas que requiere esta subregla. La lista puede contener objetos String, Label o StarlarkToolchainTypeApi, en cualquier combinación. Se buscarán cadenas de herramientas verificando la plataforma actual y se proporcionarán a la implementación de la subregla a través de `ctx.toolchains`.
`fragments`	Secuencia de cadenas. El valor predeterminado es `[]` . Es la lista de nombres de fragmentos de configuración que requiere la subregla en la configuración de destino.
`subrules`	Secuencia de subreglas. El valor predeterminado es `[]` . Es la lista de otras subreglas que necesita esta subregla.

tag_class

tag_class tag_class(attrs={}, *, doc=None)

Crea un nuevo objeto tag_class, que define un esquema de atributos para una clase de etiquetas, que son objetos de datos que puede usar una extensión de módulo.

Parámetros

Parámetro Descripción

Parámetro	Descripción
`attrs`	dict; el valor predeterminado es `{}` Es un diccionario para declarar todos los atributos de esta clase de etiqueta. Asigna de un nombre de atributo a un objeto de atributo (consulta attr). Ten en cuenta que, a diferencia de `rule()`, `aspect()` y `repository_rule()`, los atributos declarados no convertirán `None` al valor predeterminado. Para que se use el valor predeterminado, el emisor debe omitir el atributo por completo.
`doc`	cadena o `None`; el valor predeterminado es `None` Es una descripción de la clase de etiqueta que pueden extraer las herramientas de generación de documentación.

attrs

dict; el valor predeterminado es {}
Es un diccionario para declarar todos los atributos de esta clase de etiqueta. Asigna de un nombre de atributo a un objeto de atributo (consulta attr).

Ten en cuenta que, a diferencia de rule(), aspect() y repository_rule(), los atributos declarados no convertirán None al valor predeterminado. Para que se use el valor predeterminado, el emisor debe omitir el atributo por completo.

doc cadena o None; el valor predeterminado es None
Es una descripción de la clase de etiqueta que pueden extraer las herramientas de generación de documentación.

visibilidad

None visibility(value)

Establece la visibilidad de la carga del módulo .bzl que se está inicializando en ese momento.

La visibilidad de la carga de un módulo determina si otros archivos de COMPILACIÓN y .bzl pueden cargarlo. (Esto es diferente de la visibilidad del destino del archivo fuente .bzl subyacente, que determina si el archivo puede aparecer como una dependencia de otros destinos). La visibilidad de carga funciona a nivel de paquetes: para cargar un módulo, el archivo que realiza la carga debe estar en un paquete al que se le haya otorgado visibilidad para el módulo. Un módulo siempre se puede cargar dentro de su propio paquete, independientemente de su visibilidad.

Solo se puede llamar a visibility() una vez por archivo .bzl y solo en el nivel superior, no dentro de una función. El estilo preferido es colocar esta llamada inmediatamente debajo de las sentencias load() y cualquier lógica breve necesaria para determinar el argumento.

Si la marca --check_bzl_visibility se establece como falsa, las infracciones de visibilidad de carga emitirán advertencias, pero no fallará la compilación.

Parámetros

Parámetro Descripción

Parámetro	Descripción
`value`	obligatorio Una lista de cadenas de especificación del paquete o una sola cadena de especificación del paquete. Las especificaciones de paquetes siguen el mismo formato que para `package_group`, excepto que no se permiten especificaciones de paquetes negativas. Es decir, una especificación puede tener los siguientes formatos: `"//foo"`: Es el paquete `//foo`. `"//foo/..."`: Es el paquete `//foo` y todos sus subpaquetes. `"public"` o `"private"`: Todos los paquetes o ningún paquete, respectivamente No se permite la sintaxis "@". Todas las especificaciones se interpretan en relación con el repositorio del módulo actual. Si `value` es una lista de cadenas, el conjunto de paquetes a los que se otorgó visibilidad para este módulo es la unión de los paquetes representados por cada especificación. (Una lista vacía tiene el mismo efecto que `private`). Si `value` es una sola cadena, se trata como si fuera la lista singleton `[value]`. Ten en cuenta que las marcas `--incompatible_package_group_has_public_syntax` y `--incompatible_fix_package_group_reporoot_syntax` no tienen efecto en este argumento. Los valores `"public"` y `"private"` siempre están disponibles, y `"//..."` siempre se interpreta como "todos los paquetes del repositorio actual".

value

obligatorio
Una lista de cadenas de especificación del paquete o una sola cadena de especificación del paquete.

Las especificaciones de paquetes siguen el mismo formato que para package_group, excepto que no se permiten especificaciones de paquetes negativas. Es decir, una especificación puede tener los siguientes formatos:

"//foo": Es el paquete //foo.
"//foo/...": Es el paquete //foo y todos sus subpaquetes.
"public" o "private": Todos los paquetes o ningún paquete, respectivamente

No se permite la sintaxis "@". Todas las especificaciones se interpretan en relación con el repositorio del módulo actual.

Si value es una lista de cadenas, el conjunto de paquetes a los que se otorgó visibilidad para este módulo es la unión de los paquetes representados por cada especificación. (Una lista vacía tiene el mismo efecto que private). Si value es una sola cadena, se trata como si fuera la lista singleton [value].

Ten en cuenta que las marcas --incompatible_package_group_has_public_syntax y --incompatible_fix_package_group_reporoot_syntax no tienen efecto en este argumento. Los valores "public" y "private" siempre están disponibles, y "//..." siempre se interpreta como "todos los paquetes del repositorio actual".