implementation
ao criar uma regra de repositório.
Participantes
- attr (em inglês)
- excluir
- fazer download
- download_and_extract
- execute
- extrair
- file
- name
- os
- patch
- path
- ler
- report_progress
- link simbólico
- modelo
- qual
- workspace_root
atribuição
struct repository_ctx.attrUm struct para acessar os valores dos atributos. Os valores são fornecidos pelo usuário. Se não forem, um valor padrão será usado.
excluir
bool repository_ctx.delete(path)Exclui um arquivo ou diretório. Retorna um booleano, indicando se o arquivo ou diretório foi realmente excluído por essa chamada.
Parâmetros
Parâmetro | Descrição |
---|---|
path
|
string; or path ;
obrigatórioCaminho do arquivo a ser excluído, relativo ao diretório do repositório ou absoluto. Pode ser um caminho ou uma string. |
fazer o download
struct repository_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 com
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 = ''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. É um risco de segurança omitir o SHA-256 porque os arquivos remotos podem ser alterados. 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 sinalização executável no arquivo criado. "false" por padrão. |
allow_fail
|
default = False Se definido, indica 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 Integridade de sub-recursos. 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 ser alterados. 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 repository_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, o extrai e retorna uma estrutura 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, em relação 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. É um risco de segurança omitir o SHA-256 porque os arquivos remotos podem ser alterados. 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, primeiro o cache do repositório será verificado em busca de um arquivo com o hash fornecido. O download só ocorrerá se o arquivo não for encontrado no cache. Após o download, 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ê poderá especificar explicitamente "zip", "jar", "war", "aar", "tar", "tar.gz", "tgz", "tar.xz", "txz", ".tar.zst", ".tzst", "tar.bz2", ".ar" ou ".deb" aqui. |
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 mortos. 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, indica 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 Integridade de sub-recursos. 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 ser alterados. 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 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. Ela pode ser usada 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 repository_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 de comandos. Pode ser relativo à raiz do repositório ou ao absoluto. |
extrair
None repository_ctx.extract(archive, output='', stripPrefix='', *, rename_files={})Extraia um arquivo para o diretório do repositório.
Parâmetros
Parâmetro | Descrição |
---|---|
archive
|
string; or Label; or path : caminho obrigatório para o arquivo que será descompactado, em relação ao diretório do repositório. |
output
|
string; or Label; or path ;
default = ''para o diretório em que o arquivo será descompactado, em relação ao diretório do repositório. |
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 mortos. Em vez de especificar esse prefixo várias vezes em build_file , esse campo pode ser usado para removê-lo dos arquivos extraídos.
|
rename_files
|
default = {} Um dict opcional que especifica 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. Ela pode ser usada 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. |
arquivo
None repository_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 alterarão o padrão e removerão esse parâmetro. |
name
string repository_ctx.nameO nome do repositório externo criado por esta regra.
os
repository_os repository_ctx.osUm struct para acessar informações do sistema.
patch
None repository_ctx.patch(patch_file, strip=0)Aplique um arquivo de patch ao diretório raiz do repositório externo. O arquivo de patch precisa ser um formato de diferença unificada padrão. A implementação de patch nativo do Bazel não é compatível com correspondência de fuzz e patch binário, como a ferramenta de linha de comando patch.
Parâmetros
Parâmetro | Descrição |
---|---|
patch_file
|
string; or Label; or path ;
obrigatórioO arquivo de patch a ser aplicado. Pode ser um rótulo, caminho relativo ou caminho absoluto. Se for um caminho relativo, ele será resolvido para o diretório do repositório. |
strip
|
default = 0 remove o número especificado de componentes principais dos nomes de arquivo. |
caminho
path repository_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 o caminho for um caminho, ele vai ser retornado no estado em que se encontra.
Parâmetros
Parâmetro | Descrição |
---|---|
path
|
string; or Label; or path ;
string, rótulo ou caminho obrigatórioa partir do qual criar um caminho |
ler
string repository_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 repository_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 ;
default = ''que descreve o status atual do progresso da busca |
link simbólico
None repository_ctx.symlink(target, link_name)Cria um link simbólico no sistema de arquivos.
Parâmetros
Parâmetro | Descrição |
---|---|
target
|
string; or Label; or path ;
obrigatórioO caminho para o qual o link simbólico deve apontar. |
link_name
|
string; or Label; or path ;
obrigatórioO 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)Gera um novo arquivo usando um
template
. Cada ocorrência em template
de uma chave de substitutions
será substituída pelo valor correspondente. O resultado é escrito em path
. Um argumento executable
opcional (o padrão é verdadeiro) pode ser definido para ativar ou desativar o bit executável.
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. |
template
|
string; or Label; or path : caminho obrigatório para o arquivo de modelo. |
substitutions
|
default = {} substituições a serem feitas ao expandir o modelo. |
executable
|
default = True define a flag executável no arquivo criado, "true" por padrão. |
qual
path repository_ctx.which(program)Retorna o caminho do programa correspondente ou None caso não haja esse programa no caminho.
Parâmetros
Parâmetro | Descrição |
---|---|
program
|
necessário Programa para encontrar no caminho. |
None
.
workspace_root
path repository_ctx.workspace_rootO caminho para o espaço de trabalho raiz da invocação do Bazel.