O contexto da regra do repositório que contém funções auxiliares e informações sobre atributos. Você recebe um objeto repository_ctx como um argumento para a função implementation
ao criar uma regra de repositório.
Membros
- attr
- delete
- fazer download
- download_and_extract
- executar
- extrair
- file
- getenv
- name
- so
- patch
- path
- ler
- report_progress
- symlink
- modelo
- assistir
- watch_tree
- que
- workspace_root
attr
struct repository_ctx.attr
excluir
bool repository_ctx.delete(path)
Parâmetros
Parâmetro | Descrição |
---|---|
path
|
string ou path;
obrigatório Caminho do arquivo a ser excluído, relativo ao diretório do repositório ou absoluto. Pode ser um caminho ou uma string. |
download
unknown repository_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 recomendado 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, Label ou path. O padrão é '' o caminho do 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. Omitir o SHA-256 é 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 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, 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 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. É 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 repository_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
. 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 é '' Path 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. Omitir o SHA-256 é um risco de segurança, 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 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 pela extensão do URL. Se o arquivo não tiver extensão, você poderá especificar explicitamente "zip", "jar", "war", "aar", "nupkg", "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 a ser removido 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
|
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 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 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 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 repository_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 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 é 600 Duração máxima do comando em segundos (padrão: 600 segundos). |
environment
|
o padrão é {} Força algumas variáveis de ambiente a serem definidas para transmissão 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. O padrão é o repositório raiz. |
extrair
None
repository_ctx.extract(archive, output='', stripPrefix='', *, rename_files={}, watch_archive='auto')
Parâmetros
Parâmetro | Descrição |
---|---|
archive
|
string; ou Label; ou path;
necessário caminho 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 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.
|
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
repository_ctx.file(path, content='', executable=True, legacy_utf8=True)
Parâmetros
Parâmetro | Descrição |
---|---|
path
|
string; ou Label; ou path;
obrigatório Caminho do arquivo a ser criado, em relação 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, verdadeiro por padrão. |
legacy_utf8
|
O padrão é True Encode o conteúdo do arquivo em UTF-8, "true" por padrão. Versões futuras vão mudar o padrão e remover esse parâmetro. |
getenv
string repository_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
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
.
nome
string repository_ctx.name
os
repository_os repository_ctx.os
patch
None
repository_ctx.patch(patch_file, strip=0, *, watch_patch='auto')
Parâmetros
Parâmetro | Descrição |
---|---|
patch_file
|
string; ou Label; ou path;
obrigatório O arquivo de patch a ser aplicado, pode ser rótulo, caminho relativo ou absoluto. Se for um caminho relativo, ele será resolvido para o diretório do repositório. |
strip
|
o padrão é 0 Retira o número especificado de componentes principais dos nomes dos arquivos. |
watch_patch
|
O padrão é 'auto' Define se o arquivo de patch 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.
|
caminho
path repository_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 repository_ctx.read(path, *, watch='auto')
Parâmetros
Parâmetro | Descrição |
---|---|
path
|
string ou Label ou path;
obrigatório Caminho do arquivo a ser lido. |
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
repository_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.
|
link simbólico
None
repository_ctx.symlink(target, link_name)
Parâmetros
Parâmetro | Descrição |
---|---|
target
|
string ou Label ou path;
obrigatório O caminho para o qual o link simbólico deve apontar. |
link_name
|
string; ou Label; ou path;
required O caminho do link simbólico a ser criado. |
modelo
None
repository_ctx.template(path, template, substitutions={}, executable=True, *, watch_template='auto')
template
. Todas as ocorrências em template
de uma chave de substitutions
serão substituídas pelo valor correspondente. O resultado é gravado em path
. Um argumento executable
opcional (padrão verdadeiro) pode ser definido para ativar ou desativar o bit executável.
Parâmetros
Parâmetro | Descrição |
---|---|
path
|
string; ou Label; ou path;
obrigatório Caminho do arquivo a ser criado, em relação ao diretório do repositório. |
template
|
string ou Label ou path;
obrigatório Caminho para o arquivo de modelo. |
substitutions
|
padrão é {} Substituições a serem feitas ao expandir o modelo. |
executable
|
o padrão é True Define a flag executável no arquivo criado como verdadeira por padrão. |
watch_template
|
O padrão é 'auto' Define se o arquivo de modelo 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.
|
relógio
None
repository_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 alterações 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 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. |
watch_tree
None
repository_ctx.watch_tree(path)
Tentar monitorar caminhos dentro do repositório que está sendo buscado resultará em um erro.
Parâmetros
Parâmetro | Descrição |
---|---|
path
|
string ou Label ou path;
obrigatório Caminho da árvore de diretórios a ser monitorada. |
qual
path repository_ctx.which(program)
path
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. |
None
.
workspace_root
path repository_ctx.workspace_root