Métodos disponibles en archivos MODULE.bazel.
Miembros
- archive_override
- bazel_dep
- git_override
- include
- local_path_override
- module
- multiple_version_override
- register_execution_platforms
- register_toolchains
- single_version_override
- use_extension
- use_repo
- use_repo_rule
archive_override
None
archive_override(module_name, urls, integrity='', strip_prefix='', patches=[], patch_cmds=[], patch_strip=0)
Parámetros
Parámetro | Descripción |
---|---|
module_name
|
string;
obligatorio Es el nombre de la dependencia del módulo de Bazel a la que se aplicará esta anulación. |
urls
|
string; o iterable de string;
obligatorio las URL del archivo pueden ser URLs http(s):// o file://. |
integrity
|
string;
el valor predeterminado es '' La suma de verificación esperada del archivo de almacenamiento, en formato de integridad de los subrecursos. |
strip_prefix
|
string;
el valor predeterminado es '' Un prefijo de directorio para quitar los archivos extraídos. |
patches
|
Iterable de strings;
el valor predeterminado es [] Una lista de etiquetas que apuntan a archivos de parche para aplicar en este módulo. Los archivos de parche deben existir en el árbol fuente del proyecto de nivel superior. Se aplican en el orden de lista. |
patch_cmds
|
Iterable de strings;
el valor predeterminado es [] Secuencia de comandos de Bash que se aplicará en Linux/Macos después de aplicar los parches. |
patch_strip
|
int;
el valor predeterminado es 0 Es igual que el argumento --strip del parche de Unix. |
bazel_dep
None
bazel_dep(name, version='', max_compatibility_level=-1, repo_name='', dev_dependency=False)
Parámetros
Parámetro | Descripción |
---|---|
name
|
string;
obligatorio El nombre del módulo que se agregará como dependencia directa. |
version
|
string;
el valor predeterminado es '' La versión del módulo que se agregará como dependencia directa. |
max_compatibility_level
|
int;
el valor predeterminado es -1 El compatibility_level máximo admitido para que el módulo se agregue como dependencia directa. La versión del módulo implica el nivel de compatibilidad mínimo admitido, así como el máximo si no se especifica este atributo.
|
repo_name
|
string;
el valor predeterminado es '' El nombre del repositorio externo que representa esta dependencia. Este es el nombre del módulo de forma predeterminada. |
dev_dependency
|
bool;
el valor predeterminado es False Si el valor es verdadero, esta dependencia se ignorará si el módulo actual no es el módulo raíz o si se habilita `--ignore_dev_dependency`. |
git_override
None
git_override(module_name, remote, commit='', patches=[], patch_cmds=[], patch_strip=0, init_submodules=False, strip_prefix='')
Parámetros
Parámetro | Descripción |
---|---|
module_name
|
string;
obligatorio Es el nombre de la dependencia del módulo de Bazel a la que se aplicará esta anulación. |
remote
|
string;
obligatorio La URL del repositorio de Git remoto. |
commit
|
string;
el valor predeterminado es '' La confirmación que se debe comprobar. |
patches
|
Iterable de strings;
el valor predeterminado es [] Una lista de etiquetas que apuntan a archivos de parche para aplicar en este módulo. Los archivos de parche deben existir en el árbol fuente del proyecto de nivel superior. Se aplican en el orden de lista. |
patch_cmds
|
Iterable de strings;
el valor predeterminado es [] Secuencia de comandos de Bash que se aplicará en Linux/Macos después de aplicar los parches. |
patch_strip
|
int;
el valor predeterminado es 0 Es igual que el argumento --strip del parche de Unix. |
init_submodules
|
bool;
el valor predeterminado es False Indica si los submódulos de Git en el repositorio recuperado se deben inicializar de manera recurrente. |
strip_prefix
|
string;
el valor predeterminado es '' Un prefijo de directorio para quitar los archivos extraídos. Se puede usar para orientar a un subdirectorio del repositorio de Git. Ten en cuenta que el subdirectorio debe tener su propio archivo `MODULE.bazel` con un nombre de módulo que sea el mismo que el argumento `module_name` que se pasa a este `git_override`. |
incluye
None
include(label)
include()
se comporta como si el archivo incluido se colocara de forma textual en la ubicación de la llamada a include()
, con la excepción de que las vinculaciones de variables (como las que se usan para use_extension
) solo están visibles en el archivo en el que se producen, no en ningún archivo incluido o incluido.Solo el módulo raíz puede usar include()
; Es un error si el archivo MÓDULO de un bazel_dep
usa include()
.
Solo se pueden incluir archivos en el repositorio principal.
include()
te permite segmentar el archivo del módulo raíz en varias partes, para evitar tener un archivo MODULE.bazel enorme o administrar mejor el control de acceso para segmentos semánticos individuales.
Parámetros
Parámetro | Descripción |
---|---|
label
|
string;
obligatorio Es la etiqueta que apunta al archivo que se incluirá. La etiqueta debe apuntar a un archivo en el repositorio principal. En otras palabras, debe comenzar con doble barra diagonal ( // ).
|
local_path_override
None
local_path_override(module_name, path)
Parámetros
Parámetro | Descripción |
---|---|
module_name
|
string;
obligatorio Es el nombre de la dependencia del módulo de Bazel a la que se aplicará esta anulación. |
path
|
string;
obligatorio La ruta de acceso al directorio en el que se encuentra este módulo. |
module
None
module(name='', version='', compatibility_level=0, repo_name='', bazel_compatibility=[])
Se lo debe llamar como máximo una vez y, si se lo llama, debe ser la primera directiva del archivo MODULE.bazel. Se puede omitir solo si este módulo es el módulo raíz (como en el caso de que otro módulo no dependa de él).
Parámetros
Parámetro | Descripción |
---|---|
name
|
string;
el valor predeterminado es '' El nombre del módulo. Se puede omitir solo si este módulo es el módulo raíz (como en el caso de que otro módulo no dependa de él). Un nombre de módulo válido debe: 1) contener solo letras minúsculas (a-z), dígitos (0-9), puntos (.), guiones (-) y guiones bajos (_); 2) comiencen con una letra minúscula; 3) Terminar con una letra minúscula o un número |
version
|
string;
el valor predeterminado es '' La versión del módulo. Se puede omitir solo si este módulo es el módulo raíz (como en el caso de que otro módulo no dependa de él). La versión debe estar en un formato SemVer flexible. consulta la documentación para obtener más detalles. |
compatibility_level
|
int;
el valor predeterminado es 0 El nivel de compatibilidad del módulo cada vez que se introduzca un cambio incompatible importante. Esta es básicamente la "versión principal" del módulo en términos de SemVer, excepto que no está incorporado en la cadena de versión en sí, sino que existe como un campo separado. Los módulos con diferentes niveles de compatibilidad participan en la resolución de versión como si fueran módulos con nombres diferentes, pero el gráfico de dependencia final no puede contener varios módulos con el mismo nombre, pero con niveles de compatibilidad diferentes (a menos que multiple_version_override esté vigente). Para obtener más detalles, consulta la documentación.
|
repo_name
|
string;
el valor predeterminado es '' El nombre del repositorio que representa a este módulo, tal como lo ve el módulo en sí. De forma predeterminada, el nombre del repositorio es el nombre del módulo. Esto se puede especificar para facilitar la migración de proyectos que hayan usado un nombre de repositorio diferente del nombre de módulo. |
bazel_compatibility
|
Iterable de strings;
el valor predeterminado es [] Una lista de versiones de Bazel que permite a los usuarios declarar qué versiones de Bazel son compatibles con este módulo. NO afecta la resolución de dependencias, pero bzlmod usará esta información para verificar si tu versión actual de Bazel es compatible. El formato de este valor es una string de algunos valores de restricción separados por comas. Se admiten tres restricciones: <=X.X.X: La versión de Bazel debe ser igual o anterior a X.X.X. Se usa cuando hay un cambio incompatible conocido en una versión más reciente. >=X.X.X: La versión de Bazel debe ser igual o posterior a X.X.X.Se usa cuando dependes de algunas funciones que solo están disponibles a partir de X.X.X. -X.X.X: La versión X.X.X de Bazel no es compatible. Se usa cuando hay un error en X.X.X que genera problemas, pero que se corrigió en versiones posteriores. |
multiple_version_override
None
multiple_version_override(module_name, versions, registry='')
Parámetros
Parámetro | Descripción |
---|---|
module_name
|
string;
obligatorio Es el nombre de la dependencia del módulo de Bazel a la que se aplicará esta anulación. |
versions
|
Iterable de strings;
obligatorio Especifica de forma explícita las versiones que pueden coexistir. Estas versiones ya deben estar presentes en la selección previa del gráfico de dependencia. Se “actualizarán” las dependencias de este módulo a la versión permitida superior más cercana con el mismo nivel de compatibilidad, mientras que las dependencias que tengan una versión superior a cualquier versión permitida con el mismo nivel de compatibilidad causarán un error. |
registry
|
string;
el valor predeterminado es '' Anula el registro para este módulo; en lugar de encontrar este módulo en la lista predeterminada de registros, se debe usar el registro dado. |
register_execution_platforms
None
register_execution_platforms(dev_dependency=False, *platform_labels)
@
o //
). Consulta la resolución de la cadena de herramientas para obtener más información. Los patrones que se expanden a varios destinos, como :all
, se registrarán en orden lexicográfico por nombre.
Parámetros
Parámetro | Descripción |
---|---|
dev_dependency
|
bool;
el valor predeterminado es False Si el valor es verdadero, las plataformas de ejecución no se registrarán si el módulo actual no es el módulo raíz o si “--ignore_dev_dependency” está habilitado. |
platform_labels
|
secuencia de strings;
obligatorio Los patrones de destino que se registrarán. |
register_toolchains
None
register_toolchains(dev_dependency=False, *toolchain_labels)
@
o //
). Consulta la resolución de la cadena de herramientas para obtener más información. Los patrones que se expanden a varios destinos, como :all
, se registrarán en orden lexicográfico por nombre de destino (no el nombre de la implementación de la cadena de herramientas).
Parámetros
Parámetro | Descripción |
---|---|
dev_dependency
|
bool;
el valor predeterminado es False Si es verdadero, las cadenas de herramientas no se registrarán si el módulo actual no es el módulo raíz o si “--ignore_dev_dependency” está habilitado. |
toolchain_labels
|
secuencia de strings;
obligatorio Los patrones de destino que se registrarán. |
single_version_override
None
single_version_override(module_name, version='', registry='', patches=[], patch_cmds=[], patch_strip=0)
Parámetros
Parámetro | Descripción |
---|---|
module_name
|
string;
obligatorio Es el nombre de la dependencia del módulo de Bazel a la que se aplicará esta anulación. |
version
|
string;
el valor predeterminado es '' Anula la versión declarada de este módulo en el gráfico de dependencias. En otras palabras, este módulo estará “fijado” a esta versión de anulación. Este atributo se puede omitir si lo único que se desea anular es el registro o los parches. |
registry
|
string;
el valor predeterminado es '' Anula el registro para este módulo; en lugar de encontrar este módulo en la lista predeterminada de registros, se debe usar el registro dado. |
patches
|
Iterable de strings;
el valor predeterminado es [] Una lista de etiquetas que apuntan a archivos de parche para aplicar en este módulo. Los archivos de parche deben existir en el árbol fuente del proyecto de nivel superior. Se aplican en el orden de lista. |
patch_cmds
|
Iterable de strings;
el valor predeterminado es [] Secuencia de comandos de Bash que se aplicará en Linux/Macos después de aplicar los parches. |
patch_strip
|
int;
el valor predeterminado es 0 Es igual que el argumento --strip del parche de Unix. |
use_extension
module_extension_proxy use_extension(extension_bzl_file, extension_name, *, dev_dependency=False, isolate=False)
Parámetros
Parámetro | Descripción |
---|---|
extension_bzl_file
|
string;
obligatorio Es una etiqueta para el archivo de Starlark que define la extensión del módulo. |
extension_name
|
string;
obligatorio Es el nombre de la extensión del módulo que se usará. El archivo de Starlark debe exportar un símbolo con este nombre. |
dev_dependency
|
bool;
el valor predeterminado es False Si es verdadero, este uso de la extensión del módulo se ignorará si el módulo actual no es el módulo raíz o si se habilita `--ignore_dev_dependency`. |
isolate
|
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_isolated_extension_usages . Si es "true", la extensión del módulo se aislará de los demás usos, tanto en este módulo como en otros. Las etiquetas creadas para este uso no afectan otros usos, y los repositorios generados por la extensión para este uso serán distintos de todos los demás repositorios generados por la extensión. Actualmente, este parámetro es experimental y solo está disponible con la marca |
use_repo
None
use_repo(extension_proxy, *args, **kwargs)
Parámetros
Parámetro | Descripción |
---|---|
extension_proxy
|
module_extension_proxy;
obligatorio Un objeto del proxy de extensión del módulo que muestra una llamada a use_extension .
|
args
|
obligatorio Son los nombres de los repositorios que se importarán. |
kwargs
|
obligatorio Especifica ciertos repositorios para importar al alcance del módulo actual con nombres diferentes. Las claves deben ser el nombre que se usará en el alcance actual, mientras que los valores deben ser los nombres originales que exporta la extensión del módulo. |
use_repo_rule
repo_rule_proxy use_repo_rule(repo_rule_bzl_file, repo_rule_name)
name
en el proxy. El atributo booleano implícito dev_dependency
también se puede usar en el proxy para indicar que un repositorio determinado solo se creará cuando el módulo actual sea el módulo raíz.
Parámetros
Parámetro | Descripción |
---|---|
repo_rule_bzl_file
|
string;
obligatorio Es una etiqueta para el archivo de Starlark que define la regla del repositorio. |
repo_rule_name
|
string;
obligatorio El nombre de la regla del repositorio que se usará. El archivo de Starlark debe exportar un símbolo con este nombre. |