module_ctx

Informar um problema Ver fonte Por noite

O contexto da extensão de 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.

Participantes

Baixar

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 estrutura contendo 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, Label ou path. O padrão é o caminho ''
para o arquivo de saída, relativo ao diretório do repositório.
sha256 string; 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. Ele é opcional para facilitar o desenvolvimento, mas deve ser definido antes do envio.
executable bool; o padrão é False.
Defina a flag de executável no arquivo criado, que será falso por padrão.
allow_fail bool; 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 string; 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 dict; o padrão é {}
Um dict opcional que especifica informações de autenticação para alguns dos URLs.
headers dict. O padrão é {}
. Um dict opcional que especifica cabeçalhos HTTP para todos os URLs.
integrity string; 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 bool; o padrão é True.
Se definido como falso, a chamada vai retornar imediatamente, em vez do valor de retorno normal, ela vai retornar um token com um único método, "wait()", que fica bloqueado até que o download seja concluído e retorna o valor de retorno normal ou é gerado 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={})

Faz o download de um arquivo para o caminho de saída do URL fornecido, extrai esse arquivo e retorna um struct contendo 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, Label ou path. O padrão é ''
o caminho para o diretório em que o arquivo será descompactado, em relação ao diretório do repositório.
sha256 string; 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. 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ó será feita 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 string. O padrão é ''
, que é o tipo 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 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 string; o padrão é ''
, um prefixo de diretório a ser removido 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 bool; 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 string; 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 dict; o padrão é {}
Um dict opcional que especifica informações de autenticação para alguns dos URLs.
headers dict. O padrão é {}
. Um dict opcional que especifica cabeçalhos HTTP para todos os URLs.
integrity string; 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 dict; o padrão é {}
Um dict 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 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="")

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 sequência; obrigatório
Lista de argumentos, o primeiro elemento precisa ser o caminho para o programa a ser executado.
timeout int. O padrão é a duração máxima de 600
do comando em segundos (o padrão é de 600 segundos).
environment dict; o padrão é {}
força algumas variáveis de ambiente a serem definidas para serem transmitidas ao processo.
quiet bool; o padrão é True
. Se stdout e stderr precisam ser impressos no terminal.
working_directory string; o padrão é ""
Diretório de trabalho para a execução do comando. 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)

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

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.

root_module_direct_dev_deps sequência de strings ou string; ou None; 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 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
. Afirma que essa extensão de módulo garante uma reprodutibilidade completa. Por isso, ela não pode ser armazenada no arquivo de bloqueio.

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, o caminho obrigatório
do arquivo a ser criado, relativo ao diretório do repositório.
content string; o padrão é ''
o conteúdo do arquivo a ser criado, vazio por padrão.
executable bool; o padrão é True.
Defina a sinalização de executável no arquivo criado, verdadeiro por padrão.
legacy_utf8 bool; o padrão é True
codificar o conteúdo do arquivo como UTF-8, verdadeiro 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)

Retorna o valor de uma variável de ambiente 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
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; obrigatório
Uma tag extraída de bazel_module.tags.

modules

list module_ctx.modules

Uma lista de todos os módulos do Bazel no gráfico de dependência externa que usam essa extensão de módulo, cada um sendo 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 da pesquisa em amplitude, começando no módulo raiz.

os

repository_os module_ctx.os

Um 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 para o 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 pretendido (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; string, rótulo ou caminho obrigatório
que será usado para criar um caminho

leitura

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, o caminho obrigatório
do arquivo de leitura.
watch string; o padrão é 'auto'
se você quer assistir 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. Passar "auto" só tentará observar 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 do progresso para a busca deste repositório ou extensão de módulo

Parâmetros

Parâmetro Descrição
status string; o padrão é ''
que descreve o status atual da busca

root_module_has_non_dev_dependency

bool module_ctx.root_module_has_non_dev_dependency

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

relógio

None module_ctx.watch(path)

Diz ao Bazel para monitorar as alterações no caminho especificado, independentemente de ele existir ou não, ou seja, 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.

As "mudanças" incluem alterações no conteúdo do arquivo (se o caminho for um arquivo), se o caminho era um arquivo que agora é um diretório (ou vice-versa) e se o caminho começa ou deixa 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, o caminho obrigatório
do arquivo a ser observado.

qual

path module_ctx.which(program)

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

Parâmetros

Parâmetro Descrição
program string; obrigatório
Programa a ser encontrado no caminho.
Pode retornar None.