O contexto da regra do repositório que contém funções auxiliares e informações sobre atributos. Você recebe um objetorepository_ctx como argumento para a função implementation
ao criar uma regra de repositório.
Membros
- attr
- delete
- fazer download
- download_and_extract
- executar
- extrair
- file
- name
- so
- patch
- path
- ler
- report_progress
- symlink
- modelo
- 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
struct repository_ctx.download(url, output='', sha256='', executable=False, allow_fail=False, canonical_id='', auth={}, *, integrity='')
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 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 é 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. 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. |
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 do cache aos casos em que o arquivo foi adicionado ao cache com o mesmo ID canônico |
auth
|
O padrão é {} Uma coleção opcional que especifica informações de autenticação para alguns dos 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. |
download_and_extract
struct repository_ctx.download_and_extract(url, output='', sha256='', type='', stripPrefix='', allow_fail=False, canonical_id='', auth={}, *, integrity='', rename_files={})
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. 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. 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
|
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", "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 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 do cache aos casos em que o arquivo foi adicionado ao cache com o mesmo ID canônico |
auth
|
O padrão é {} Uma coleção opcional que especifica informações de autenticação para alguns dos 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. 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. |
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 a 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 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. |
extrair
None
repository_ctx.extract(archive, output='', stripPrefix='', *, rename_files={})
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 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. |
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, 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 define a flag executável no arquivo criado, verdadeira 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. |
nome
string repository_ctx.name
os
repository_os repository_ctx.os
patch
None
repository_ctx.patch(patch_file, strip=0)
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 tira o número especificado de componentes iniciais dos nomes de arquivos. |
caminho
path repository_ctx.path(path)
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 repository_ctx.read(path)
Parâmetros
Parâmetro | Descrição |
---|---|
path
|
string; ou Label; ou path;
caminho obrigatório do arquivo a ser lido. |
report_progress
None
repository_ctx.report_progress(status='')
Parâmetros
Parâmetro | Descrição |
---|---|
status
|
string:
o padrão é a 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;
obrigatório O caminho do link simbólico a ser criado, relativo ao diretório do repositório. |
modelo
None
repository_ctx.template(path, template, substitutions={}, executable=True)
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 (o padrão é verdadeiro) pode ser configurado 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, relativo ao diretório do repositório. |
template
|
string; ou Label; ou path;
caminho obrigatório para o arquivo de modelo. |
substitutions
|
o padrão é {} substituições a serem feitas ao expandir o modelo. |
executable
|
O padrão é True define a flag executável no arquivo criado, verdadeira por padrão. |
qual
path repository_ctx.which(program)
Parâmetros
Parâmetro | Descrição |
---|---|
program
|
obrigatório Programa a ser encontrado no programa. |
None
.
workspace_root
path repository_ctx.workspace_root