Métodos disponíveis nos arquivos MODULE.bazel.
Membros
- 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 | Descrição |
---|---|
module_name
|
required O nome da dependência do módulo do Bazel para aplicar essa substituição. |
urls
|
string ou iterável de strings;
requerido Os URLs do arquivo. Podem ser URLs http(s):// ou file://. |
integrity
|
O padrão é '' A checksum esperada do arquivo, no formato de integridade do subrecurso. |
strip_prefix
|
O padrão é '' Um prefixo de diretório para remover dos arquivos extraídos. |
patches
|
Iterável de strings. O padrão é [] .Uma lista de rótulos que apontam para arquivos de patch a serem aplicados a este módulo. Os arquivos de patch precisam existir na árvore de origem do projeto de nível superior. Elas são aplicadas na ordem da lista. |
patch_cmds
|
Iterável de strings.
O padrão é [] . Sequência de comandos Bash a serem aplicados no Linux/Macos depois que os patches forem aplicados. |
patch_strip
|
O padrão é 0 , o mesmo que o argumento --strip do patch do Unix. |
bazel_dep
None
bazel_dep(name, version='', max_compatibility_level=-1, repo_name='', dev_dependency=False)
Parâmetros
Parâmetro | Descrição |
---|---|
name
|
required O nome do módulo a ser adicionado como dependência direta. |
version
|
o padrão é '' A versão do módulo a ser adicionada como uma dependência direta. |
max_compatibility_level
|
O padrão é -1 O máximo de compatibility_level compatível para que o módulo seja adicionado como uma dependência direta. A versão do módulo implica o nível de compatibilidade mínimo compatível, bem como o máximo, se este atributo não for especificado.
|
repo_name
|
O padrão é '' , o nome do repositório externo que representa essa dependência. Esse é o nome padrão do módulo. |
dev_dependency
|
O padrão é False Se verdadeiro, essa dependência será ignorada se o módulo atual não for o módulo raiz ou se `--ignore_dev_dependency` estiver ativado. |
git_override
None
git_override(module_name, remote, commit='', patches=[], patch_cmds=[], patch_strip=0, init_submodules=False, strip_prefix='')
Parâmetros
Parâmetro | Descrição |
---|---|
module_name
|
required O nome da dependência do módulo do Bazel para aplicar essa substituição. |
remote
|
obrigatório O URL do repositório Git remoto. |
commit
|
O padrão é '' O commit que precisa ser extraído. |
patches
|
Iterável de strings. O padrão é [] .Uma lista de rótulos que apontam para arquivos de patch a serem aplicados a este módulo. Os arquivos de patch precisam existir na árvore de origem do projeto de nível superior. Elas são aplicadas na ordem da lista. |
patch_cmds
|
Iterável de strings.
O padrão é [] . Sequência de comandos Bash a serem aplicados no Linux/Macos depois que os patches forem aplicados. |
patch_strip
|
o padrão é 0 Igual ao argumento --strip do patch do Unix. |
init_submodules
|
O padrão é False Se os submódulos do Git no repositório buscado precisam ser inicializados recursivamente. |
strip_prefix
|
o padrão é '' Um prefixo de diretório a ser removido dos arquivos extraídos. Isso pode ser usado para segmentar um subdiretório do repositório do Git. O subdiretório precisa ter o próprio arquivo "MODULE.bazel" com um nome de módulo igual ao argumento "module_name" transmitido para "git_override". |
incluem
None
include(label)
include()
se comporta como se o arquivo incluído fosse colocado textualmente no local da chamada include()
, exceto que as vinculações de variáveis (como as usadas para use_extension
) só são visíveis no arquivo em que ocorrem, e não em nenhum arquivo incluído ou que inclui.Somente o módulo raiz pode usar include()
. Será um erro se o arquivo MÓDULO de um bazel_dep
usar include()
.
Somente arquivos no repositório principal podem ser incluídos.
include()
permite segmentar o arquivo do módulo raiz em várias partes para evitar um arquivo MODULE.bazel enorme ou gerenciar melhor o controle de acesso de segmentos semânticos individuais.
Parâmetros
Parâmetro | Descrição |
---|---|
label
|
obrigatório O rótulo que aponta para o arquivo a ser incluído. O rótulo precisa apontar para um arquivo no repositório principal. Em outras palavras, ele precisa começar com duas barras ( // ).
|
local_path_override
None
local_path_override(module_name, path)
Parâmetros
Parâmetro | Descrição |
---|---|
module_name
|
required O nome da dependência do módulo do Bazel para aplicar essa substituição. |
path
|
required O caminho para o diretório em que este módulo está. |
module
None
module(name='', version='', compatibility_level=0, repo_name='', bazel_compatibility=[])
Ele precisa ser chamado no máximo uma vez e, se for chamado, precisa ser a primeira diretiva no arquivo MODULE.bazel. Ele só pode ser omitido se for o módulo raiz, ou seja, se não depender de outro módulo.
Parâmetros
Parâmetro | Descrição |
---|---|
name
|
default é '' O nome do módulo. Pode ser omitido se esse módulo for o módulo raiz (como se ele não depender de outro módulo). Um nome de módulo válido precisa: 1) conter apenas letras minúsculas (a-z), dígitos (0-9), pontos (.), hifens (-) e sublinhados (_); 2) começar com uma letra minúscula; 3) terminar com uma letra minúscula ou um dígito. |
version
|
o padrão é '' A versão do módulo. Só pode ser omitido se esse módulo for o raiz, ou seja, se não for usado por outro módulo. A versão precisa estar em um formato SemVer relaxado. Consulte a documentação para mais detalhes. |
compatibility_level
|
padrão é 0 O nível de compatibilidade do módulo. Ele precisa ser alterado sempre que uma mudança incompatível importante for introduzida. Essa é essencialmente a "versão principal" do módulo em termos de SemVer, exceto que ela não está incorporada à string de versão, mas existe como um campo separado. Módulos com níveis de compatibilidade diferentes participam da resolução de versão como se fossem módulos com nomes diferentes, mas o gráfico de dependência final não pode conter vários módulos com o mesmo nome, mas níveis de compatibilidade diferentes, a menos que multiple_version_override esteja em vigor. Consulte a documentação para mais detalhes.
|
repo_name
|
default é '' O nome do repositório que representa esse módulo, conforme visto pelo próprio módulo. Por padrão, o nome do repositório é o mesmo do módulo. Isso pode ser especificado para facilitar a migração de projetos que usam um nome de repositório diferente do nome do módulo. |
bazel_compatibility
|
Iterável de strings.
O padrão é [] Uma lista de versões do Bazel que permite aos usuários declarar quais versões do Bazel são compatíveis com este módulo. Ele NÃO afeta a resolução da dependência, mas o bzlmod vai usar essas informações para verificar se a versão atual do Bazel é compatível. O formato desse valor é uma string de alguns valores de restrição separados por vírgulas. Três restrições são aceitas: <=X.X.X: a versão do Bazel precisa ser igual ou anterior a X.X.X. É usada quando há uma mudança incompatível conhecida em uma versão mais recente. >=X.X.X: a versão do Bazel precisa ser igual ou mais recente que X.X.X.Usado quando você depende de alguns recursos que só estão disponíveis desde X.X.X. -X.X.X: a versão X.X.X do Bazel não é compatível. Usado quando há um bug na X.X.X que afeta você, mas foi corrigido em versões posteriores. |
multiple_version_override
None
multiple_version_override(module_name, versions, registry='')
Parâmetros
Parâmetro | Descrição |
---|---|
module_name
|
required O nome da dependência do módulo do Bazel para aplicar essa substituição. |
versions
|
Iterável de strings;
requerido Especifica explicitamente as versões permitidas a coexistir. Essas versões já precisam estar presentes na pré-seleção do gráfico de dependências. As dependências nesse módulo serão "atualizadas" para a versão mais recente permitida mais próxima no mesmo nível de compatibilidade, enquanto as dependências com uma versão mais recente do que qualquer outra no mesmo nível vão causar erros. |
registry
|
default é '' Ignora o registro desse módulo. Em vez de encontrar esse módulo na lista padrão de registros, o registro fornecido precisa ser usado. |
register_execution_platforms
None
register_execution_platforms(dev_dependency=False, *platform_labels)
@
ou //
). Consulte a resolução do conjunto de ferramentas para mais informações.
Parâmetros
Parâmetro | Descrição |
---|---|
dev_dependency
|
O padrão é False Se verdadeiro, as plataformas de execução não serão registradas se o módulo atual não for o módulo raiz ou se `--ignore_dev_dependency` estiver ativado. |
platform_labels
|
sequência de strings;
obrigatório Os rótulos das plataformas a serem registradas. |
register_toolchains
None
register_toolchains(dev_dependency=False, *toolchain_labels)
@
ou //
). Consulte a resolução do conjunto de ferramentas para mais informações.
Parâmetros
Parâmetro | Descrição |
---|---|
dev_dependency
|
padrão é False .Se verdadeiro, os conjuntos de ferramentas não serão registrados se o módulo atual não for o módulo raiz ou se "--ignore_dev_dependency" estiver ativado. |
toolchain_labels
|
sequência de strings:
obrigatório Os rótulos dos conjuntos de ferramentas a serem registrados. Os rótulos podem incluir :all . Nesse caso, todas as metas de fornecimento de toolchain no pacote serão registradas em ordem alfabética por nome.
|
single_version_override
None
single_version_override(module_name, version='', registry='', patches=[], patch_cmds=[], patch_strip=0)
Parâmetros
Parâmetro | Descrição |
---|---|
module_name
|
required O nome da dependência do módulo do Bazel para aplicar essa substituição. |
version
|
O padrão é '' Override a versão declarada deste módulo no gráfico de dependências. Em outras palavras, o módulo será "fixado" a essa versão de substituição. Esse atributo pode ser omitido se só quisermos substituir o registro ou os patches. |
registry
|
padrão é '' Substitui o registro deste módulo. Em vez de encontrar esse módulo na lista padrão de registros, o registro fornecido será usado. |
patches
|
Iterável de strings.
O padrão é [] . Uma lista de identificadores que apontam para arquivos de patch a serem aplicados a este módulo. Os arquivos de patch precisam existir na árvore de origem do projeto de nível superior. Elas são aplicadas na ordem da lista. |
patch_cmds
|
Iterável de strings.
O padrão é [] . Sequência de comandos Bash a serem aplicados no Linux/Macos depois que os patches forem aplicados. |
patch_strip
|
O padrão é 0 , o mesmo que o argumento --strip do patch do Unix. |
use_extension
module_extension_proxy use_extension(extension_bzl_file, extension_name, *, dev_dependency=False, isolate=False)
Parâmetros
Parâmetro | Descrição |
---|---|
extension_bzl_file
|
required Um rótulo para o arquivo Starlark que define a extensão do módulo. |
extension_name
|
required O nome da extensão do módulo a ser usada. Um símbolo com esse nome precisa ser exportado pelo arquivo Starlark. |
dev_dependency
|
padrão é False Se verdadeiro, esse uso da extensão do módulo será ignorado se o módulo atual não for o módulo raiz ou se "--ignore_dev_dependency" estiver ativado. |
isolate
|
O padrão é False Experimental. Esse parâmetro é experimental e pode mudar a qualquer momento. Não dependa dele. Ela pode ser ativada experimentalmente definindo ---experimental_isolated_extension_usages . Se verdadeiro, esse uso da extensão do módulo será isolado de todos os outros usos, tanto neste módulo quanto em outros. As tags criadas para esse uso não afetam outros usos, e os repositórios gerados pela extensão para esse uso são diferentes de todos os outros repositórios gerados pela extensão. Esse parâmetro é experimental e está disponível apenas com a flag |
use_repo
None
use_repo(extension_proxy, *args, **kwargs)
Parâmetros
Parâmetro | Descrição |
---|---|
extension_proxy
|
required Um objeto proxy de extensão de módulo retornado por uma chamada use_extension .
|
args
|
obrigatório Os nomes dos repositórios a serem importados. |
kwargs
|
required Especifica repositórios específicos para importação no escopo do módulo atual com nomes diferentes. As chaves precisam ser o nome a ser usado no escopo atual, e os valores precisam ser os nomes originais exportados pela extensão do módulo. |
use_repo_rule
repo_rule_proxy use_repo_rule(repo_rule_bzl_file, repo_rule_name)
name
no proxy. O atributo booleano implícito dev_dependency
também pode ser usado no proxy para indicar que um determinado repositório só será criado quando o módulo atual for o raiz.
Parâmetros
Parâmetro | Descrição |
---|---|
repo_rule_bzl_file
|
required Um rótulo para o arquivo Starlark que define a regra do repositório. |
repo_rule_name
|
required O nome da regra do repositório a ser usada. Um símbolo com esse nome precisa ser exportado pelo arquivo Starlark. |