O contexto da extensão do módulo que contém funções auxiliares e informações sobre tags pertinentes no gráfico de dependências. Você recebe um objeto module_ctx como um argumento para a função implementation
ao criar uma extensão de módulo.
Membros
- download
- download_and_extract
- executar
- extension_metadata
- extrair
- file
- getenv
- is_dev_dependency
- modules
- os
- path
- ler
- report_progress
- root_module_has_non_dev_dependency
- assistir
- que
download
unknown module_ctx.download(url, output='', sha256='', executable=False, allow_fail=False, canonical_id='', auth={}, headers={}, *, integrity='', block=True)
success
, uma flag que é true
se o download for concluído e, se for concluído, um hash do arquivo com os campos sha256
e integrity
. Quando sha256
ou integrity
é especificado pelo usuário, é altamente recomendável definir um canonical_id
explícito. Por exemplo: get_default_canonical_id
Parâmetros
Parâmetro | Descrição |
---|---|
url
|
string ou iterável de strings;
obrigatório Lista de URLs de espelho que fazem referência ao mesmo arquivo. |
output
|
string; ou Label; ou path;
O padrão é o caminho '' para o arquivo de saída, relativo ao diretório do repositório. |
sha256
|
O padrão é '' . O hash SHA-256 esperado do arquivo transferido por download. Ele precisa corresponder ao hash SHA-256 do arquivo transferido por download. É um risco à segurança omitir o SHA-256 porque os arquivos remotos podem mudar. Na melhor das hipóteses, a omissão desse campo vai fazer com que o build não seja hermético. Ele é opcional para facilitar o desenvolvimento, mas deve ser definido antes do envio. Se fornecido, o cache do repositório será verificado primeiro em busca de um arquivo com o hash fornecido. Só haverá uma tentativa de download se o arquivo não for encontrado no cache. Após o download, o arquivo será adicionado ao cache. |
executable
|
O padrão é False Define a flag executável no arquivo criado, falsa por padrão. |
allow_fail
|
O padrão é False Se definido, indica o erro no valor de retorno em vez de gerar um erro para downloads com falha. |
canonical_id
|
o padrão é '' Se definido, restringe as ocorrências em cache aos casos em que o arquivo foi adicionado ao cache com o mesmo ID canônico. Por padrão, o armazenamento em cache usa a soma de verificação ( sha256 ou integrity ).
|
auth
|
o padrão é {} Um dict opcional que especifica informações de autenticação para alguns dos URLs. |
headers
|
o padrão é {} Um dict opcional que especifica cabeçalhos HTTP para todos os URLs. |
integrity
|
o padrão é '' Soma de verificação esperada do arquivo transferido por download, no formato Sub-resource Integrity. Ela precisa corresponder à soma de verificação do arquivo transferido por download. Omitir a soma de verificação é um risco de segurança, porque os arquivos remotos podem mudar. Na melhor das hipóteses, a omissão desse campo vai fazer com que o build não seja hermético. É opcional para facilitar o desenvolvimento, mas precisa ser definido antes do envio. Se fornecido, o cache do repositório será verificado primeiro para um arquivo com a soma de verificação especificada. O download só será tentado se o arquivo não for encontrado no cache. Após o download, o arquivo será adicionado ao cache. |
block
|
O padrão é True Se definido como falso, a chamada é retornada imediatamente e, em vez do valor de retorno normal, ela retorna um token com um único método, wait(), que bloqueia até que o download seja concluído e retorna o valor de retorno normal ou gera uma exceção como de costume. |
download_and_extract
struct module_ctx.download_and_extract(url, output='', sha256='', type='', stripPrefix='', allow_fail=False, canonical_id='', auth={}, headers={}, *, integrity='', rename_files={})
success
, uma flag que é true
se o download for concluído e, se for bem-sucedido, um hash do arquivo com os campos sha256
e integrity
. Quando sha256
ou integrity
é especificado pelo usuário, é altamente recomendável definir um canonical_id
explícito. Por exemplo: get_default_canonical_id
Parâmetros
Parâmetro | Descrição |
---|---|
url
|
string ou Iterable de strings;
obrigatório Lista de URLs espelhados que fazem referência ao mesmo arquivo. |
output
|
string ou Label ou path;
o padrão é '' Caminho para o diretório em que o arquivo será descompactado, em relação ao diretório do repositório. |
sha256
|
O padrão é '' . O hash SHA-256 esperado do arquivo transferido por download. Ele precisa corresponder ao hash SHA-256 do arquivo transferido por download. É um risco à segurança omitir o SHA-256 porque os arquivos remotos podem mudar. Na melhor das hipóteses, a omissão desse campo tornará sua construção não hermética. É opcional para facilitar o desenvolvimento, mas precisa ser definido antes do envio. Se fornecido, o cache do repositório será verificado primeiro para um arquivo com o hash fornecido. Um download só será tentado se o arquivo não for encontrado no cache. Após o download, o arquivo será adicionado ao cache. |
type
|
O padrão é '' O tipo de arquivo do arquivo transferido por download. Por padrão, o tipo de arquivo é determinado a partir da extensão do arquivo do URL. Se o arquivo não tiver uma extensão, especifique "zip", "jar", "war", "aar", "nupkg", "tar", "tar.gz", "tgz", "tar.xz", "txz", ".tar.zst", ".tzst", "tar.bz2", ".tbz", ".ar" ou ".deb" aqui. |
stripPrefix
|
O padrão é '' Um prefixo de diretório para remover dos arquivos extraídos. Muitos arquivos têm um diretório de nível superior que contém todos os arquivos no arquivo. Em vez de precisar especificar esse prefixo várias vezes no build_file , esse campo pode ser usado para removê-lo dos arquivos extraídos.
|
allow_fail
|
o padrão é False Se definido, indica o erro no valor de retorno em vez de gerar um erro para downloads com falha. |
canonical_id
|
O padrão é '' Se definido, restringe os acertos de cache aos casos em que o arquivo foi adicionado ao cache com o mesmo ID canônico. Por padrão, o armazenamento em cache usa a soma de verificação" ( sha256 ou integrity ).
|
auth
|
O padrão é {} Uma coleção opcional que especifica informações de autenticação para alguns dos URLs. |
headers
|
o padrão é {} Um dict opcional que especifica cabeçalhos HTTP para todos os URLs. |
integrity
|
O padrão é '' Soma de verificação esperada do arquivo transferido por download, no formato de integridade da sub-recurso. Ela precisa corresponder à soma de verificação do arquivo baixado. Omitir a soma de verificação é um risco de segurança, porque os arquivos remotos podem mudar. Na melhor das hipóteses, a omissão desse campo vai fazer com que o build não seja hermético. É opcional para facilitar o desenvolvimento, mas precisa ser definido antes do envio. Se fornecido, o cache do repositório será verificado primeiro em busca de um arquivo com a soma de verificação determinada. Só haverá uma tentativa de download se o arquivo não for encontrado no cache. Após o download, o arquivo será adicionado ao cache. |
rename_files
|
O padrão é {} Uma matriz opcional que especifica os arquivos a serem renomeados durante a extração. Entradas de arquivo com nomes que correspondem exatamente a uma chave serão renomeadas para o valor, antes de qualquer ajuste de prefixo de diretório. Isso pode ser usado para extrair arquivos que contêm nomes de arquivos não Unicode ou que têm arquivos que seriam extraídos para o mesmo caminho em sistemas de arquivos sem distinção entre maiúsculas e minúsculas. |
execute
exec_result module_ctx.execute(arguments, timeout=600, environment={}, quiet=True, working_directory="")
timeout
(em segundos, o padrão é 600 segundos). Esse método retorna uma estrutura exec_result
que contém a saída do comando. O mapa environment
pode ser usado para substituir algumas variáveis de ambiente a serem transmitidas para o processo.
Parâmetros
Parâmetro | Descrição |
---|---|
arguments
|
required Lista de argumentos. O primeiro elemento precisa ser o caminho do programa a ser executado. |
timeout
|
o padrão é 600 A duração máxima do comando em segundos (o padrão é 600 segundos). |
environment
|
O padrão é {} Força algumas variáveis de ambiente a serem definidas para serem transmitidas ao processo. |
quiet
|
O padrão é True Se stdout e stderr precisam ser impressos no terminal. |
working_directory
|
O padrão é "" , diretório de trabalho para execução de comandos. Pode ser absoluto ou relativo à raiz do repositório. O padrão é o repositório raiz. |
extension_metadata
extension_metadata module_ctx.extension_metadata(root_module_direct_deps=None, root_module_direct_dev_deps=None, reproducible=False)
Parâmetros
Parâmetro | Descrição |
---|---|
root_module_direct_deps
|
Sequência de strings ou string ou None .
O padrão é None . Os nomes dos repositórios que a extensão considera como dependências diretas do módulo raiz. Se o módulo raiz importar repositórios adicionais ou não importar todos esses repositórios pelo use_repo , o Bazel vai mostrar um aviso quando a extensão for avaliada, instruindo o usuário a executar bazel mod tidy para corrigir as chamadas use_repo automaticamente. Se um dos Se um dos valores Exatamente um de |
root_module_direct_dev_deps
|
Sequência de strings ou string ou None .
O padrão é None . Os nomes dos repositórios que a extensão considera dependências de desenvolvimento diretas do módulo raiz. Se o módulo raiz importar repositórios adicionais ou não importar todos esses repositórios usando use_repo em um proxy de extensão criado com use_extension(..., dev_dependency = True) , o Bazel vai mostrar um aviso quando a extensão for avaliada, instruindo o usuário a executar bazel mod tidy para corrigir as chamadas use_repo automaticamente. Se um dos valores Exatamente um de |
reproducible
|
bool;
o padrão é False Informa que essa extensão de módulo garante a reprodutibilidade completa, portanto, ela não pode ser armazenada no arquivo de bloqueio. |
extrair
None
module_ctx.extract(archive, output='', stripPrefix='', *, rename_files={}, watch_archive='auto')
Parâmetros
Parâmetro | Descrição |
---|---|
archive
|
string, Label ou path,
o caminho obrigatório para o arquivo que será descompactado, relativo ao diretório do repositório. |
output
|
string; ou Label; ou path;
O padrão é '' caminho para o diretório em que o arquivo será descompactado, relativo ao diretório do repositório. |
stripPrefix
|
O padrão é '' , um prefixo de diretório para remover dos arquivos extraídos. Muitos arquivos têm um diretório de nível superior que contém todos os arquivos no arquivo. Em vez de especificar esse prefixo várias vezes no build_file , esse campo pode ser usado para removê-lo dos arquivos extraídos.
|
rename_files
|
O padrão é {} Uma matriz opcional que especifica os arquivos a serem renomeados durante a extração. Entradas de arquivo com nomes que correspondem exatamente a uma chave serão renomeadas para o valor, antes de qualquer ajuste de prefixo de diretório. Isso pode ser usado para extrair arquivos que contêm nomes de arquivos não Unicode ou que têm arquivos que seriam extraídos para o mesmo caminho em sistemas de arquivos sem distinção entre maiúsculas e minúsculas. |
watch_archive
|
O padrão é 'auto' para monitorar o arquivo. Pode ser a string "yes", "no" ou "auto". Transmitir "yes" é equivalente a invocar imediatamente o método watch() . Passar "no" não tenta monitorar o arquivo. Transmitir "auto" só tentará monitorar o arquivo quando for permitido por lei. Consulte os documentos da watch() para mais informações.
|
arquivo
None
module_ctx.file(path, content='', executable=True, legacy_utf8=True)
Parâmetros
Parâmetro | Descrição |
---|---|
path
|
string; ou Label; ou path;
required Caminho do arquivo a ser criado, relativo ao diretório do repositório. |
content
|
o padrão é '' O conteúdo do arquivo a ser criado, vazio por padrão. |
executable
|
o padrão é True Define a flag executável no arquivo criado como verdadeira por padrão. |
legacy_utf8
|
O padrão é True Encode o conteúdo do arquivo em UTF-8, "true" por padrão. As versões futuras vão mudar o padrão e remover esse parâmetro. |
getenv
string module_ctx.getenv(name, default=None)
name
como uma string, se existir, ou default
, caso contrário. Ao criar de forma incremental, qualquer mudança no valor da variável nomeada por name
faz com que esse repositório seja buscado novamente.
Parâmetros
Parâmetro | Descrição |
---|---|
name
|
string;
obrigatório Nome da variável de ambiente desejada. |
default
|
string ou None ;
o padrão é None O valor padrão a ser retornado se name não for encontrado.
|
None
.
is_dev_dependency
bool module_ctx.is_dev_dependency(tag)
devDependency = True
.
Parâmetros
Parâmetro | Descrição |
---|---|
tag
|
bazel_module_tag;
obrigatório Uma tag extraída de bazel_module.tags. |
modules
list module_ctx.modules
os
repository_os module_ctx.os
caminho
path module_ctx.path(path)
Parâmetros
Parâmetro | Descrição |
---|---|
path
|
string ou Label ou path;
obrigatório string , Label ou path para criar um caminho.
|
ler
string module_ctx.read(path, *, watch='auto')
Parâmetros
Parâmetro | Descrição |
---|---|
path
|
string; ou Label; ou path;
required Caminho do arquivo de leitura. |
watch
|
O padrão é 'auto' Define se o arquivo será monitorado. Pode ser a string "yes", "no" ou "auto". Transmitir "yes" é equivalente a invocar imediatamente o método watch() . Transmitir "no" não tenta monitorar o arquivo. Transmitir "auto" só vai tentar monitorar o arquivo quando for permitido. Consulte os documentos de watch() para mais informações.
|
report_progress
None
module_ctx.report_progress(status='')
Parâmetros
Parâmetro | Descrição |
---|---|
status
|
string;
o padrão é '' string que descreve o status atual do progresso da busca.
|
root_module_has_non_dev_dependency
bool module_ctx.root_module_has_non_dev_dependency
relógio
None
module_ctx.watch(path)
"Mudanças" inclui alterações no conteúdo do arquivo (se o caminho for um arquivo), se o caminho era um arquivo, mas agora é um diretório ou vice-versa, e se o caminho começar ou parar de existir. Isso não inclui mudanças em nenhum arquivo no diretório se o caminho for um diretório. Para isso, use path.readdir()
.
Tentar monitorar caminhos dentro do repositório que está sendo buscado ou dentro do diretório de trabalho da extensão de módulo atual vai resultar em um erro. Uma extensão de módulo que tenta monitorar um caminho fora do espaço de trabalho atual do Bazel também vai resultar em um erro.
Parâmetros
Parâmetro | Descrição |
---|---|
path
|
string; ou Label; ou path;
obrigatório Caminho do arquivo a ser monitorado. |
qual
path module_ctx.which(program)
path
do programa correspondente ou None
se não houver esse programa no caminho.
Parâmetros
Parâmetro | Descrição |
---|---|
program
|
obrigatório Programa a ser encontrado no programa. |
None
.