O contexto da extensão do módulo que contém as funções auxiliares e informações sobre tags pertinentes em todo o gráfico de dependência. Você recebe um objeto module_ctx como argumento para a função implementation
ao criar uma extensão de módulo.
Membros
- fazer download
- download_and_extract
- executar
- extension_metadata
- file
- getenv (em inglês)
- is_dev_dependency
- modules
- so
- path
- ler
- report_progress
- root_module_has_non_dev_dependency
- relógio
- que
download
unknown module_ctx.download(url, output='', sha256='', executable=False, allow_fail=False, canonical_id='', auth={}, headers={}, *, integrity='', block=True)
success
, uma sinalização true
se o download for concluído e, se for bem-sucedido, um hash do arquivo com os campos sha256
e integrity
.
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 Rótulo; ou path
o padrã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 baixado. 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. Ele é opcional para facilitar o desenvolvimento, mas deve ser definido antes do envio. |
executable
|
o padrão é False define o flag executável no arquivo criado, sendo falso por padrão. |
allow_fail
|
o padrão é False Se definido, indique 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. |
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 baixado. É um risco à segurança omitir a soma de verificação porque os arquivos remotos podem mudar. Na melhor das hipóteses, a omissão desse campo tornará sua construção não hermética. Ele é opcional para facilitar o desenvolvimento, mas deve ser definido antes do envio. |
block
|
o padrão é True Se definida como "false", a chamada retornará imediatamente e, em vez do valor de retorno normal, ela retornará 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 é acionado normalmente. |
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 sinalização true
se o download for concluído e, se for bem-sucedido, um hash do arquivo com os campos sha256
e integrity
.
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 Rótulo; 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 baixado. 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. 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. uma tentativa de download só será feita se o arquivo não for encontrado no cache. Após um download bem-sucedido, o arquivo será adicionado ao cache. |
type
|
o padrão é '' o tipo de arquivamento do arquivo baixado. Por padrão, o tipo de arquivo é determinado a partir da extensão do arquivo do URL. Se o arquivo não tiver extensão, você poderá especificar explicitamente "zip", "jar", "war", "aar", "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 contêm um diretório de nível superior que contém todos os arquivos do arquivamento. Em vez de 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, indique 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. |
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 baixado. É um risco à segurança omitir a soma de verificação porque os arquivos remotos podem mudar. Na melhor das hipóteses, a omissão desse campo tornará sua construção não hermética. Ele é opcional para facilitar o desenvolvimento, mas deve ser definido antes do envio. |
rename_files
|
o padrão é {} Um dict opcional que especifica os arquivos que serão 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 contenham nomes de arquivo não Unicode ou que tenham arquivos que seriam extraídos para o mesmo caminho em sistemas de arquivos que não diferenciam maiúsculas de 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
|
obrigatório Lista de argumentos. O primeiro elemento precisa ser o caminho para o programa a ser executado. |
timeout
|
o padrão é 600 duração máxima do comando em segundos (o padrão é 600 segundos). |
environment
|
o padrão é {} força a configuração de algumas variáveis de ambiente 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 do comando. Pode ser absoluto ou relativo à raiz do repositório. |
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 dependências diretas do módulo raiz. Se o módulo raiz importar outros repositórios ou não importar todos eles usando o 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 for Se 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 como dependências de desenvolvimento diretas do módulo raiz. Se o módulo raiz importar outros repositórios ou não importar todos eles 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 Exatamente um de |
reproducible
|
bool;
o padrão é False Afirma que esta extensão de módulo garante a reprodutibilidade completa, portanto, não deve ser armazenada no arquivo de bloqueio. |
arquivo
None
module_ctx.file(path, content='', executable=True, legacy_utf8=True)
Parâmetros
Parâmetro | Descrição |
---|---|
path
|
string; ou Rótulo; ou path
obrigatório 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 defina o flag executável no arquivo criado como verdadeiro por padrão. |
legacy_utf8
|
o padrão é True codifique o conteúdo do arquivo como UTF-8, "true" por padrão. 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
, se não tiver.Ao criar de forma incremental, qualquer mudança no valor da variável nomeada por name
fará 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 Valor padrão a ser retornado se "nome" 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 Rótulo; ou path
obrigatório string, rótulo ou caminho a partir do qual um caminho será criado |
ler
string module_ctx.read(path, *, watch='auto')
Parâmetros
Parâmetro | Descrição |
---|---|
path
|
string; ou Rótulo; ou path
obrigatório do arquivo a ser lido. |
watch
|
o padrão é 'auto' se quer assistir o arquivo. Pode ser a string "yes", "no" ou "auto". Passar "sim" é equivalente a invocar imediatamente o método watch() . passar "não" não tenta assistir ao arquivo; passando "auto" só tentará assistir ao arquivo quando for permitido por lei (consulte os documentos do 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)
"Alterações" incluir 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ça ou para. 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 acompanhar os caminhos dentro do repositório que está sendo buscado ou dentro do diretório de trabalho da extensão do módulo atual 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 resulta em erro.
Parâmetros
Parâmetro | Descrição |
---|---|
path
|
string; ou Rótulo; ou path
obrigatório caminho do arquivo a ser observado. |
qual
path module_ctx.which(program)
Parâmetros
Parâmetro | Descrição |
---|---|
program
|
obrigatório Programa a ser encontrado no caminho. |
None
.