module_ctx

7.3 · 7.2 · 7.1 · 7.0 · 6.5

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

unknown module_ctx.download(url, output='', sha256='', executable=False, allow_fail=False, canonical_id='', auth={}, headers={}, *, integrity='', block=True)

Faz o download de um arquivo para o caminho de saída do URL fornecido e retorna uma struct que contém 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.

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. É 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.
executable O padrão é False
define a flag executável no arquivo criado, que é "false" 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 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 é {}
Um dict opcional que especifica informações de autenticação para alguns dos URLs.
headers padrão é {}
Uma matriz 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 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={})

Faz o download de um arquivo para o caminho de saída do URL fornecido, extrai-o e retorna uma estrutura que contém 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.

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 é ''
caminho para o diretório em que o arquivo será descompactado, 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. É 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 do arquivo transferido por download. Por padrão, o tipo de arquivo é determinado pela extensão 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".
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 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 é {}
Um dict opcional que especifica informações de autenticação para alguns dos URLs.
headers padrão é {}
Uma matriz 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 transferido por download. É 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 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 a soma de verificação determinada. 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.
rename_files O padrão é {}
Uma matriz opcional que especifica os arquivos a serem renomeados durante a extração. As 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="")

Executa o comando fornecido pela lista de argumentos. O tempo de execução do comando é limitado por timeout (em segundos, 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 que serão transmitidas ao 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 é a duração máxima de 600
do comando em segundos (o padrão é de 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 relativo à raiz do repositório ou absoluto.

extension_metadata

extension_metadata module_ctx.extension_metadata(root_module_direct_deps=None, root_module_direct_dev_deps=None, reproducible=False)

Cria um objeto opaco que pode ser retornado da função de implementação da extensão do módulo para fornecer metadados ao Bazel sobre os repositórios gerados pela extensão.

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 root_module_direct_deps for, um aviso e um comando de correção serão exibidos quando a extensão for avaliada.

Se um dos valores root_module_direct_deps e root_module_direct_dev_deps for especificado, o outro também precisará ser especificado. As listas especificadas por esses dois parâmetros precisam ser distintas.

Exatamente um de root_module_direct_deps e root_module_direct_dev_deps pode ser definido como o valor especial "all", que é tratado como se uma lista com os nomes de todos os repositórios gerados pela extensão tivesse sido especificada como o valor.

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 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 root_module_direct_deps ou root_module_direct_dev_deps forem especificados, o outro também terá que ser. As listas especificadas por esses dois parâmetros precisam ser separadas.

Exatamente um de root_module_direct_deps e root_module_direct_dev_deps pode ser definido como o valor especial "all", que é tratado como se uma lista com os nomes de todos os repositórios gerados pela extensão fosse especificada como o valor.

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')

Extraia um arquivo para o diretório do repositório.

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 precisar 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 é {}
Um dict opcional que especifica os arquivos que serão renomeados durante a extração. As 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(). 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.

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; ou Label; ou path; obrigatório
caminho 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 O padrão é True
define a flag executável no arquivo criado, verdadeira por padrão.
legacy_utf8 O padrão é True
codifica o conteúdo do arquivo em UTF-8, verdadeiro 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)

Retorna o valor de uma variável de ambiente 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 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
O valor padrão a ser retornado se "name" não for encontrado
Pode retornar None.

is_dev_dependency

bool module_ctx.is_dev_dependency(tag)

Retorna se a tag especificada foi especificada no resultado de uma chamada use_extension com devDependency = True.

Parâmetros

Parâmetro Descrição
tag bazel_module_tag; required
Uma tag gerada em bazel_module.tags.

modules

list module_ctx.modules

Uma lista de todos os módulos do Bazel no gráfico de dependências externas que usam 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 é garantida como a mesma da pesquisa em largura máxima, começando pelo módulo raiz.

os

repository_os module_ctx.os

Uma struct para acessar informações do sistema.

caminho

path module_ctx.path(path)

Retorna um caminho de uma string, um rótulo ou um 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 no caminho do arquivo correspondente. 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 o caminho for um caminho, ele será retornado no estado em que se encontra.

Parâmetros

Parâmetro Descrição
path string ou Label ou path; requerido
string, label ou path para criar um caminho a partir de

ler

string module_ctx.read(path, *, watch='auto')

Lê o conteúdo de um arquivo no sistema de arquivos.

Parâmetros

Parâmetro Descrição
path string; ou Label; ou path; caminho obrigatório
do arquivo a ser lido.
watch O padrão é 'auto'
se você quer assistir ao 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.

report_progress

None module_ctx.report_progress(status='')

Atualiza o status de progresso para a busca dessa extensão de repositório ou módulo

Parâmetros

Parâmetro Descrição
status string: o padrão é a 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

Indica se o módulo raiz usa essa extensão como uma dependência não relacionada ao desenvolvedor.

relógio

None module_ctx.watch(path)

Informa ao Bazel que ele precisa monitorar as mudanças no caminho indicado, independentemente de ele existir ou não, ou se é um arquivo ou um diretório. Qualquer alteração no arquivo ou diretório invalidará esse repositório ou extensão do módulo e fará com que ele seja buscado novamente ou reavaliado na próxima vez.

"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 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 Label ou path; obrigatório
caminho do arquivo a ser monitorado.

qual

path module_ctx.which(program)

Retorna o caminho do programa correspondente ou None se não houver esse programa no caminho.

Parâmetros

Parâmetro Descrição
program required
Programa a ser encontrado no caminho.
Pode retornar None.