Archivos MODULE.bazel

Informar un problema

Métodos disponibles en archivos MODULE.bazel.

Miembros

archive_override

None archive_override(module_name, urls, integrity='', strip_prefix='', patches=[], patch_cmds=[], patch_strip=0)

Especifica que esta dependencia debe provenir de un archivo (zip, gzip, etc.) en una ubicación determinada, en lugar de un registro. Esta directiva solo se aplica en el módulo raíz; en otras palabras, si otros usuarios usan un módulo como dependencia, se ignorarán sus propias anulaciones.

Parámetros

Parámetro Descripción
module_name required
Es el nombre de la dependencia del módulo de Bazel a la que se aplicará esta anulación.
urls string o iterable de strings; required
Las URLs del archivo pueden ser http(s):// o file://.
integrity El valor predeterminado es ''
La suma de verificación esperada del archivo de almacenamiento, en formato de integridad del subrecurso.
strip_prefix la opción predeterminada es ''
Un prefijo de directorio para quitar de los archivos extraídos.
patches Iterable de strings; el valor predeterminado es []
Una lista de etiquetas que apunta a los archivos de parche para aplicar en este módulo. Los archivos de parche deben existir en el árbol de fuentes del proyecto de nivel superior. Se aplican en orden de lista.
patch_cmds Iterable de strings; el valor predeterminado es []
Secuencia de comandos Bash que se aplicarán en Linux/Macos después de la aplicación de los parches.
patch_strip el valor predeterminado es 0
Igual que el argumento --strip del parche Unix.

bazel_dep

None bazel_dep(name, version='', max_compatibility_level=-1, repo_name='', dev_dependency=False)

Declara una dependencia directa de otro módulo de Bazel.

Parámetros

Parámetro Descripción
name required
Es el nombre del módulo que se agregará como dependencia directa.
version el valor predeterminado es ''
Es la versión del módulo que se agregará como dependencia directa.
max_compatibility_level la configuración predeterminada es -1
El máximo de compatibility_level admitido para que el módulo se agregue como dependencia directa. La versión del módulo indica el valor mínimo de compatibilidad_level admitido, así como el máximo si no se especifica este atributo.
repo_name la configuración predeterminada es ''
El nombre del repositorio externo que representa esta dependencia. Este es el nombre predeterminado del módulo.
dev_dependency el valor predeterminado es False
Si 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)

Especifica que una dependencia debe provenir de una confirmación determinada de un repositorio de Git. Esta directiva solo se aplica en el módulo raíz; en otras palabras, si otros usuarios usan un módulo como dependencia, se ignorarán sus propias anulaciones.

Parámetros

Parámetro Descripción
module_name required
Es el nombre de la dependencia del módulo de Bazel a la que se aplicará esta anulación.
remote required
La URL del repositorio de Git remoto.
commit el valor predeterminado es ''
La confirmación que se debe verificar.
patches Iterable de strings; el valor predeterminado es []
Una lista de etiquetas que apunta a los archivos de parche para aplicar en este módulo. Los archivos de parche deben existir en el árbol de fuentes del proyecto de nivel superior. Se aplican en orden de lista.
patch_cmds Iterable de strings; el valor predeterminado es []
Secuencia de comandos Bash que se aplicarán en Linux/Macos después de la aplicación de los parches.
patch_strip el valor predeterminado es 0
Igual que el argumento --strip del parche Unix.
init_submodules El valor predeterminado es False
Indica si los submódulos del repositorio recuperado se deben inicializar de manera recursiva.

local_path_override

None local_path_override(module_name, path)

Especifica que una dependencia debe provenir de un directorio determinado en el disco local. Esta directiva solo se aplica en el módulo raíz; en otras palabras, si otros usuarios usan un módulo como dependencia, se ignorarán sus propias anulaciones.

Parámetros

Parámetro Descripción
module_name required
Es el nombre de la dependencia del módulo de Bazel a la que se aplicará esta anulación.
path required
La ruta de acceso al directorio en el que se encuentra este módulo.

módulo

None module(name='', version='', compatibility_level=0, repo_name='', bazel_compatibility=[])

Declara ciertas propiedades del módulo de Bazel que representa el repositorio actual de Bazel. Estas propiedades son metadatos esenciales del módulo (como el nombre y la versión) o afectan el comportamiento del módulo actual y sus dependientes.

Como máximo, debe llamarse una vez. Solo se puede omitir 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 predeterminado es ''
El nombre del módulo. Solo se puede omitir 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) comenzar con una letra minúscula; 3) terminar con una letra minúscula o un número.
version el valor predeterminado es ''
Corresponde a la versión del módulo. Solo se puede omitir 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 el valor predeterminado es 0
El nivel de compatibilidad del módulo. Esto debe cambiarse cada vez que se presenta un cambio importante incompatible. Esta es básicamente la "versión principal" del módulo en términos de SemVer, con la excepción de que no está incorporada en la cadena de versión en sí, pero existe como un campo independiente. Los módulos con diferentes niveles de compatibilidad participan en la resolución de la 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 diferentes niveles de compatibilidad (a menos que multiple_version_override esté vigente). Para obtener más detalles, consulta la documentación.
repo_name predeterminado es ''
El nombre del repositorio que representa este módulo, como lo ve el módulo en sí. De forma predeterminada, el nombre del repositorio es el nombre del módulo. Se puede especificar para facilitar la migración de proyectos que usaron un nombre de repositorio distinto de su nombre de módulo.
bazel_compatibility Iterable de strings; el valor predeterminado es []
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 interrumpe, pero se corrigió en versiones posteriores.

multiple_version_override

None multiple_version_override(module_name, versions, registry='')

Especifica que una dependencia aún debe provenir de un registro, pero se debe permitir que coexistan varias versiones de esta. Para obtener más detalles, consulta la documentación. Esta directiva solo se aplica en el módulo raíz; en otras palabras, si otros usuarios usan un módulo como dependencia, se ignorarán sus propias anulaciones.

Parámetros

Parámetro Descripción
module_name required
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 permitidas que pueden coexistir. Estas versiones ya deben estar presentes en la selección previa del gráfico de dependencia. Las dependencias de este módulo se "actualizarán" 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 la permitida en el mismo nivel de compatibilidad generarán un error.
registry el valor predeterminado es ''
Anula el registro de este módulo. En lugar de encontrar este módulo en la lista predeterminada de registros, se debe usar el registro determinado.

register_execution_platforms

None register_execution_platforms(dev_dependency=False, *platform_labels)

Especifica las plataformas de ejecución ya definidas que se registrarán cuando se seleccione este módulo. Deben ser patrones de destino absolutos (es decir, que comiencen con @ o //). Consulta la resolución de la cadena de herramientas para obtener más información.

Parámetros

Parámetro Descripción
dev_dependency el valor predeterminado es False
Si 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 se habilita `--ignore_dev_dependency`.
platform_labels secuencia de cadenas; obligatoria
Las etiquetas de las plataformas que se registrarán.

register_toolchains

None register_toolchains(dev_dependency=False, *toolchain_labels)

Especifica las cadenas de herramientas ya definidas que se registrarán cuando se seleccione este módulo. Deben ser patrones de destino absolutos (es decir, que comiencen con @ o //). Consulta la resolución de la cadena de herramientas para obtener más información.

Parámetros

Parámetro Descripción
dev_dependency el valor predeterminado es False
Si el valor es true, las cadenas de herramientas no se registrarán si el módulo actual no es el módulo raíz o si se habilita `--ignore_dev_dependency`.
toolchain_labels Sequence de strings; required
Las etiquetas de las cadenas de herramientas que se registrarán. Las etiquetas pueden incluir :all. En este caso, todos los destinos que proporcionan la cadena de herramientas en el paquete se registrarán en orden lexicográfico por nombre.

single_version_override

None single_version_override(module_name, version='', registry='', patches=[], patch_cmds=[], patch_strip=0)

Especifica que una dependencia aún debería provenir de un registro, pero que su versión se debe fijar, que se debe anular el registro, o bien que se debe aplicar una lista de parches. Esta directiva solo se aplica en el módulo raíz; en otras palabras, si otros usuarios usan un módulo como dependencia, se ignorarán sus propias anulaciones.

Parámetros

Parámetro Descripción
module_name required
Es el nombre de la dependencia del módulo de Bazel a la que se aplicará esta anulación.
version 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 se “fijará” a esta versión de anulación. Este atributo se puede omitir si lo único que se quiere anular es el registro o los parches.
registry el valor predeterminado es ''
Anula el registro de este módulo. En lugar de encontrar este módulo en la lista predeterminada de registros, se debe usar el registro determinado.
patches Iterable de strings; el valor predeterminado es []
Una lista de etiquetas que apunta a los archivos de parche para aplicar en este módulo. Los archivos de parche deben existir en el árbol de fuentes del proyecto de nivel superior. Se aplican en orden de lista.
patch_cmds Iterable de strings; el valor predeterminado es []
Secuencia de comandos Bash que se aplicarán en Linux/Macos después de la aplicación de los parches.
patch_strip el valor predeterminado es 0
Igual que el argumento --strip del parche Unix.

use_extension

module_extension_proxy use_extension(extension_bzl_file, extension_name, *, dev_dependency=False, isolate=False)

Devuelve un objeto proxy que representa una extensión de módulo. Se pueden invocar sus métodos para crear etiquetas de extensión de módulo.

Parámetros

Parámetro Descripción
extension_bzl_file required
Una etiqueta para el archivo de Starlark que define la extensión del módulo.
extension_name required
Es el nombre de la extensión del módulo que se usará. El archivo Starlark debe exportar un símbolo con este nombre.
dev_dependency 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 la configuración predeterminada es False
Experimental. Este parámetro es experimental y puede cambiar en cualquier momento. No dependas de ello. Se puede habilitar de manera experimental estableciendo ---experimental_isolated_extension_usages.
Si es verdadero, este uso de la extensión del módulo se aislará de todos 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 que genere la extensión para este uso serán distintos de todos los demás repositorios generados por la extensión.

Por el momento, este parámetro es experimental y solo está disponible con la marca --experimental_isolated_extension_usages.

use_repo

None use_repo(extension_proxy, *args, **kwargs)

Importa uno o más repositorios generados por la extensión de módulo determinada al alcance del módulo actual.

Parámetros

Parámetro Descripción
extension_proxy required
Un objeto de proxy de extensión del módulo que muestra una llamada a use_extension.
args required
Son los nombres de los repositorios que se importarán.
kwargs required
Especifica ciertos repositorios para importar al alcance del módulo actual con diferentes nombres. Las claves deben ser el nombre que se usará en el alcance actual, mientras que los valores deben ser los nombres originales exportados por la extensión del módulo.

use_repo_rule

repo_rule_proxy use_repo_rule(repo_rule_bzl_file, repo_rule_name)

Muestra un valor de proxy que se puede invocar directamente en el archivo MODULE.bazel como regla de repositorio, una o más veces. Los repositorios creados de esa manera solo son visibles para el módulo actual, bajo el nombre declarado con el atributo 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 required
Una etiqueta para el archivo de Starlark que define la regla del repositorio.
repo_rule_name required
Es el nombre de la regla de repositorio que se usará. El archivo Starlark debe exportar un símbolo con este nombre.