Arquivos MODULE.bazel

Informar um problema Noite · 7,3 · 7,2 · 7,1 · 7,0 · 6,5

Métodos disponíveis nos arquivos MODULE.bazel.

Membros

archive_override

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

Especifica que essa dependência deve vir de um arquivo (zip, gzip etc.) em um determinado local, e não de um registro. Essa diretiva só entra em vigor no módulo raiz. Em outras palavras, se um módulo for usado como dependência por outras pessoas, as próprias substituições serão ignoradas.

Parâmetros

Parâmetro Descrição
module_name obrigatório
O nome da dependência do módulo do Bazel a que essa substituição será aplicada.
urls string; ou Iterable de strings. obrigatório
Os URLs do arquivo podem ser URLs http(s):// ou file://.
integrity o padrão é ''
A soma de verificação esperada do arquivo, no formato Sub-resource Integrity.
strip_prefix o padrão é ''
Um prefixo de diretório a ser removido 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 após a aplicação dos patches.
patch_strip o padrão é 0
Igual ao argumento --strip do patch do Unix.

bazel_dep

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

Declara uma dependência direta em outro módulo do Bazel.

Parâmetros

Parâmetro Descrição
name obrigatório
O nome do módulo a ser adicionado como uma 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 compatibility_level máximo com suporte para o módulo a ser 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. Por padrão, é o nome do módulo.
dev_dependency o padrão é False
Se for verdadeira, 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)

Especifica que uma dependência deve vir de uma determinada confirmação de um repositório Git. Essa diretiva só entra em vigor no módulo raiz. Em outras palavras, se um módulo for usado como dependência por outras pessoas, as próprias substituições serão ignoradas.

Parâmetros

Parâmetro Descrição
module_name obrigatório
O nome da dependência do módulo do Bazel a que essa substituição será aplicada.
remote obrigatório
O URL do repositório Git remoto.
commit o padrão é ''
A confirmação a ser verificada.
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 após a aplicação dos patches.
patch_strip o padrão é 0
Igual ao argumento --strip do patch do Unix.
init_submodules o padrão é False
Define se os submódulos no repositório buscado precisam ser inicializados de maneira recursiva.

local_path_override

None local_path_override(module_name, path)

Especifica que uma dependência deve vir de um determinado diretório no disco local. Essa diretiva só entra em vigor no módulo raiz. Em outras palavras, se um módulo for usado como dependência por outras pessoas, as próprias substituições serão ignoradas.

Parâmetros

Parâmetro Descrição
module_name obrigatório
O nome da dependência do módulo do Bazel a que essa substituição será aplicada.
path obrigatório
O caminho para o diretório em que este módulo está.

module

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

Declara determinadas propriedades do módulo do Bazel representadas pelo repositório atual do Bazel. Essas propriedades são metadados essenciais do módulo (como o nome e a versão) ou afetam o comportamento do módulo atual e de seus dependentes.

Ele precisa ser chamado no máximo uma vez. Ele só pode ser omitido se esse módulo for o módulo raiz (como se não depender de outro módulo).

Parâmetros

Parâmetro Descrição
name o padrão é ''
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. Pode ser omitido se esse módulo for o módulo raiz (como se ele não depender de outro módulo). A versão deve estar em um formato SemVer descontraído. consulte a documentação para mais detalhes.
compatibility_level o padrão é 0
O nível de compatibilidade do módulo. isso deve ser alterado sempre que uma alteração grande incompatível for introduzida. Essa é essencialmente a "versão principal" do módulo em termos de SemVer, exceto por ele não estar incorporado na string da versão em si, mas existir como um campo separado. Módulos com diferentes níveis de compatibilidade participam da resolução da 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 com níveis de compatibilidade diferentes (a menos que multiple_version_override esteja em vigor). Consulte a documentação para mais detalhes.
repo_name o padrão é ''
O nome do repositório que representa este módulo, como visto pelo próprio módulo. Por padrão, o nome do repositório é o nome do módulo. Isso pode ser especificado para facilitar a migração de projetos que usam um nome de repositório próprio 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írgula. Três restrições são aceitas: <=X.X.X: a versão do Bazel precisa ser igual ou anterior a X.X.X. Usado quando há uma alteração 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.Usada quando você depende de alguns recursos disponíveis somente a partir de X.X.X. -X.X.X: a versão X.X.X do Bazel não é compatível. Usado quando há um bug em X.X.X que atrapalha você, mas corrigido em versões posteriores.

multiple_version_override

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

Especifica que uma dependência ainda deve vir de um registro, mas várias versões dela precisam coexistir. Consulte a documentação para mais detalhes. Essa diretiva só entra em vigor no módulo raiz. Em outras palavras, se um módulo for usado como dependência por outras pessoas, as próprias substituições serão ignoradas.

Parâmetros

Parâmetro Descrição
module_name obrigatório
O nome da dependência do módulo do Bazel a que essa substituição será aplicada.
versions Iterável de strings. obrigatório
Especifica explicitamente as versões que podem coexistir. É preciso que essas versões já estejam presentes na pré-seleção do gráfico de dependências. As dependências neste 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 que têm uma versão mais recente do que qualquer outra permitida no mesmo nível vão causar um erro.
registry o padrão é ''
Substitui o registro deste módulo. em vez de encontrar esse módulo na lista padrão de registros, use o registro fornecido.

register_execution_platforms

None register_execution_platforms(dev_dependency=False, *platform_labels)

Especifica as plataformas de execução já definidas a serem registradas quando este módulo for selecionado. Precisa ser padrões de destino absolutos (ou seja, começar com @ 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)

Especifica os conjuntos de ferramentas já definidos a serem registrados quando este módulo for selecionado. Precisa ser padrões de destino absolutos (ou seja, começar com @ 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, 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, todos os destinos que fornecem o conjunto de ferramentas no pacote serão registrados em ordem lexicográfica pelo nome.

single_version_override

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

Especifica que uma dependência ainda deve vir de um registro, mas a versão deve ser fixada, o registro substituído ou uma lista de patches aplicados. Essa diretiva só entra em vigor no módulo raiz. Em outras palavras, se um módulo for usado como dependência por outras pessoas, as próprias substituições serão ignoradas.

Parâmetros

Parâmetro Descrição
module_name obrigatório
O nome da dependência do módulo do Bazel a que essa substituição será aplicada.
version o padrão é ''
Substitui a versão declarada deste módulo no gráfico de dependências. Em outras palavras, este módulo ficará "fixado" para esta versão de substituição. Esse atributo pode ser omitido se só quisermos substituir o registro ou os patches.
registry o padrão é ''
Substitui o registro deste módulo. em vez de encontrar esse módulo na lista padrão de registros, use o registro fornecido.
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 após a aplicação dos patches.
patch_strip o padrão é 0
Igual ao argumento --strip do patch do Unix.

use_extension

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

Retorna um objeto de proxy que representa uma extensão de módulo. seus métodos podem ser invocados para criar tags de extensão de módulo.

Parâmetros

Parâmetro Descrição
extension_bzl_file obrigatório
Um rótulo para o arquivo Starlark que define a extensão do módulo.
extension_name obrigatório
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 o 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 ser alterado a qualquer momento. Não dependa disso. 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 serão diferentes de todos os outros repositórios gerados pela extensão.

No momento, esse parâmetro é experimental e só está disponível com a flag --experimental_isolated_extension_usages.

use_repo

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

Importa um ou mais repositórios gerados pela extensão de módulo especificada para o escopo do módulo atual.

Parâmetros

Parâmetro Descrição
extension_proxy obrigatório
Um objeto de 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 obrigatório
Especifica determinados repositórios a serem importados para o escopo do módulo atual com nomes diferentes. As chaves precisam ser o nome a ser usado no escopo atual, enquanto 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)

Retorna um valor de proxy que pode ser invocado diretamente no arquivo MODULE.bazel como uma regra de repositório, uma ou mais vezes. Os repositórios criados dessa forma são visíveis apenas para o módulo atual, com o nome declarado usando o atributo name no proxy. O atributo booleano dev_dependency implícito também pode ser usado no proxy para indicar que um determinado repositório só será criado quando o módulo atual for o módulo raiz.

Parâmetros

Parâmetro Descrição
repo_rule_bzl_file obrigatório
Um rótulo para o arquivo Starlark que define a regra do repositório.
repo_rule_name obrigatório
O nome da regra de repositório a ser usada. Um símbolo com esse nome precisa ser exportado pelo arquivo Starlark.