implementation
ao criar uma extensão de módulo.
Participantes
- fazer download
- download_and_extract
- execute
- extension_metadata
- file
- is_dev_dependency
- modules
- os
- path
- ler
- report_progress
- root_module_has_non_dev_dependency
- qual
download
struct module_ctx.download(url, output='', sha256='', executable=False, allow_fail=False, canonical_id='', auth={}, *, integrity='')Faz o download de um arquivo para o caminho de saída do URL fornecido e retorna um struct contendo
success
, uma flag true
se o download for concluído e, em caso de êxito, um hash do arquivo com os campos sha256
e integrity
.
Parâmetros
Parâmetro | Descrição |
---|---|
url
|
string; or Iterable of strings ;
obrigatórioLista de URLs espelhados que fazem referência ao mesmo arquivo. |
output
|
string; or Label; or path ;
padrão = ''do caminho para o arquivo de saída, relativo ao diretório do repositório. |
sha256
|
default = '' o hash SHA-256 esperado do arquivo transferido por download. Ele precisa corresponder ao hash SHA-256 do arquivo transferido por download. Ignorar o SHA-256 é um risco de segurança, já que os arquivos remotos podem mudar. Na melhor das hipóteses, a omissão desse campo tornará seu build não hermético. Ele é opcional para facilitar o desenvolvimento, mas deve ser definido antes do envio. |
executable
|
default = False define a flag executável no arquivo criado; "false" por padrão. |
allow_fail
|
default = False Se definido, indique o erro no valor de retorno em vez de gerar um erro para downloads com falha |
canonical_id
|
default = '' Se definido, restrinja as ocorrências em cache aos casos em que o arquivo foi adicionado ao cache com o mesmo ID canônico. |
auth
|
default = {} Um dict opcional que especifica informações de autenticação para alguns URLs. |
integrity
|
default = '' Soma de verificação esperada do arquivo transferido por download, no formato de integridade do sub-recurso. Ela precisa corresponder à soma de verificação do arquivo transferido por download. É um risco de 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á seu build não hermético. Ele é opcional para facilitar o desenvolvimento, mas deve ser definido antes do envio. |
download_and_extract
struct module_ctx.download_and_extract(url, output='', sha256='', type='', stripPrefix='', allow_fail=False, canonical_id='', auth={}, *, integrity='', rename_files={})Faz o download de um arquivo para o caminho de saída do URL fornecido, extrai-o e retorna um struct contendo
success
, uma flag true
se o download for concluído e, em caso de êxito, um hash do arquivo com os campos sha256
e integrity
.
Parâmetros
Parâmetro | Descrição |
---|---|
url
|
string; or Iterable of strings ;
obrigatórioLista de URLs espelhados que fazem referência ao mesmo arquivo. |
output
|
string; or Label; or path ;
default = ''para o diretório em que o arquivo será descompactado, relativo ao diretório do repositório. |
sha256
|
default = '' o hash SHA-256 esperado do arquivo transferido por download. Ele precisa corresponder ao hash SHA-256 do arquivo transferido por download. Ignorar o SHA-256 é um risco de segurança, já que os arquivos remotos podem mudar. Na melhor das hipóteses, a omissão desse campo tornará seu build não 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 um download bem-sucedido, o arquivo será adicionado ao cache. |
type
|
default = '' é o tipo de arquivo do download. Por padrão, o tipo de arquivo é determinado pela extensão de arquivo do URL. Se o arquivo não tiver extensão, você pode especificar explicitamente "zip", "jar", "war", "aar", "tar", "tar.gz", "tgz", "tar.xz", "txz", ".tar.zst", ".tzst", "tar.bz2", ".ar" ou ".deb". |
stripPrefix
|
default = '' 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. Em vez de especificar esse prefixo várias vezes em build_file , esse campo pode ser usado para removê-lo dos arquivos extraídos.
|
allow_fail
|
default = False Se definido, indique o erro no valor de retorno em vez de gerar um erro para downloads com falha |
canonical_id
|
default = '' Se definido, restrinja as ocorrências em cache aos casos em que o arquivo foi adicionado ao cache com o mesmo ID canônico. |
auth
|
default = {} Um dict opcional que especifica informações de autenticação para alguns URLs. |
integrity
|
default = '' Soma de verificação esperada do arquivo transferido por download, no formato de integridade do sub-recurso. Ela precisa corresponder à soma de verificação do arquivo transferido por download. É um risco de 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á seu build não hermético. Ele é opcional para facilitar o desenvolvimento, mas deve ser definido antes do envio. |
rename_files
|
default = {} Um dict opcional que especifica os arquivos a serem renomeados durante a extração. As entradas do arquivo com nomes que correspondem exatamente a uma chave sã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 que não diferenciam maiúsculas de minúsculas. |
execute
exec_result module_ctx.execute(arguments, timeout=600, environment={}, quiet=True, working_directory="")Executa o comando fornecido pela lista de argumentos. O tempo de execução do comando é limitado por
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
|
default = 600 duração máxima do comando em segundos (o padrão é 600 segundos). |
environment
|
default = {} força a configuração de algumas variáveis de ambiente para o processo. |
quiet
|
default = True Se stdout e stderr precisam ser impressos no terminal. |
working_directory
|
default = "" Diretório de trabalho para execução do comando. Pode ser relativo à raiz ou absoluto do repositório. |
extension_metadata
extension_metadata module_ctx.extension_metadata(root_module_direct_deps=None, root_module_direct_dev_deps=None)Constrói um objeto opaco que pode ser retornado da função de implementação da extensão do módulo para fornecer metadados sobre os repositórios gerados pela extensão para o Bazel.
Parâmetros
Parâmetro | Descrição |
---|---|
root_module_direct_deps
|
sequence of strings; or string; or None ;
default = NoneOs 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 eles pelo use_repo , o Bazel exibirá um aviso e um comando de correção quando a extensão for avaliada.Se Exatamente um de |
root_module_direct_dev_deps
|
sequence of strings; or string; or None ;
default = NoneOs nomes dos repositórios que a extensão considera como dependências diretas de desenvolvimento do módulo raiz. Se o módulo raiz importar repositórios adicionais ou não importar todos eles usando o use_repo em um proxy de extensão criado com use_extension(..., dev_dependency = True) , o Bazel exibirá um aviso e um comando de correção quando a extensão for avaliada.Se Exatamente um de |
arquivo
None module_ctx.file(path, content='', executable=True, legacy_utf8=True)Gera um arquivo no diretório do repositório com o conteúdo fornecido.
Parâmetros
Parâmetro | Descrição |
---|---|
path
|
string; or Label; or path :
caminho obrigatório do arquivo a ser criado, relativo ao diretório do repositório. |
content
|
default = '' o conteúdo do arquivo a ser criado, vazio por padrão. |
executable
|
default = True define a flag executável no arquivo criado (true) por padrão. |
legacy_utf8
|
default = True codifica o conteúdo do arquivo como UTF-8, que é "true" por padrão. Versões futuras vão mudar o padrão e remover esse parâmetro. |
is_dev_dependency
bool module_ctx.is_dev_dependency(tag)Retorna indicando se a tag fornecida foi especificada no resultado de uma chamada use_extension com
devDependency = True
.
Parâmetros
Parâmetro | Descrição |
---|---|
tag
|
bazel_module_tag ;
obrigatórioUma tag recebida de bazel_module.tags. |
módulos
list module_ctx.modulesUma lista de todos os módulos do Bazel no gráfico de dependências externo que usa essa extensão de módulo. Cada um deles é um objeto bazel_module que expõe todas as tags especificadas para essa extensão. A ordem de iteração desse dicionário é a mesma que a pesquisa que prioriza a amplitude, a partir do módulo raiz.
os
repository_os module_ctx.osUm struct para acessar informações do sistema.
caminho
path module_ctx.path(path)Retorna um caminho de uma string, rótulo ou caminho. Se o caminho for relativo, ele será resolvido em relação ao diretório do repositório. Se o caminho for um rótulo, ele será resolvido para o caminho do arquivo correspondente. Observe que os repositórios remotos são executados durante a fase de análise e, portanto, não podem depender de um resultado de destino (o rótulo precisa apontar para um arquivo não gerado). Se for um caminho, ele vai retornar no estado em que se encontra.
Parâmetros
Parâmetro | Descrição |
---|---|
path
|
string; or Label; or path ;
string, rótulo ou caminho obrigatórios para criar um caminho |
leitura
string module_ctx.read(path)Lê o conteúdo de um arquivo no sistema de arquivos.
Parâmetros
Parâmetro | Descrição |
---|---|
path
|
string; or Label; or path :
caminhoobrigatório do arquivo a ser lido. |
report_progress
None module_ctx.report_progress(status='')Atualiza o status de progresso para a busca deste repositório ou extensão do módulo.
Parâmetros
Parâmetro | Descrição |
---|---|
status
|
string ;
string default = ''que descreve o status atual do progresso da busca |
root_module_has_non_dev_dependency
bool module_ctx.root_module_has_non_dev_dependencyDefine se o módulo raiz usa essa extensão como uma dependência não de desenvolvimento.
qual
path module_ctx.which(program)Retorna o caminho do programa correspondente ou None se não houver tal programa no caminho.
Parâmetros
Parâmetro | Descrição |
---|---|
program
|
necessário Programa a ser encontrado no caminho. |
None
.