repositório_de_repositório

Informar um problema Ver código-fonte

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 argumento para a função implementation ao criar uma regra de repositório.

Participantes

attr

struct repository_ctx.attr

Uma estrutura para acessar os valores dos atributos. Os valores são fornecidos pelo usuário (se não forem, um valor padrão será usado).

delete

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 esta chamada.

Parâmetros

Parâmetro Descrição
path string; or 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.

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 contendo success, uma sinalização que é true se o download for concluído com êxito e, se for bem-sucedido, um hash do arquivo com os campos sha256 e integrity.

Parâmetros

Parâmetro Descrição
url string; or Iterable of strings; obrigatório
Lista 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 à segurança omitir o SHA-256, já que os arquivos remotos podem mudar. Na melhor das hipóteses, a omissão desse campo tornará sua versão não hermética. É opcional facilitar o desenvolvimento, mas deve ser definido antes do envio.
executable default = False
define a sinalização executável no arquivo criado, falso 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 código canônico.
auth default = {}
Um dicionário opcional que especifica informações de autenticação para alguns dos URLs.
integrity default = ''
Soma de verificação esperada do arquivo transferido por download, no formato Subresource Integrity. Ele precisa corresponder à soma de verificação do arquivo transferido por download. É um risco à segurança omitir a soma de verificação, já que os arquivos remotos podem mudar. Na melhor das hipóteses, a omissão desse campo tornará sua versão não hermética. É opcional facilitar o desenvolvimento, mas deve ser definido antes do envio.

download_e_extrair

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, extrai-o e retorna um struct contendo success, uma sinalização que é true se o download for concluído com êxito e, se for bem-sucedido, um hash do arquivo com os campos sha256 e integrity.

Parâmetros

Parâmetro Descrição
url string; or Iterable of strings; obrigatório
Lista de URLs espelhados que fazem referência ao mesmo arquivo.
output string; or Label; or path; default = ''
caminho 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 à segurança omitir o SHA-256, já que os arquivos remotos podem mudar. Na melhor das hipóteses, a omissão desse campo tornará sua versão não hermética. É opcional 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ó haverá 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 default = ''
' é o tipo de arquivo do arquivo transferido por download. Por padrão, o tipo de arquivo é determinado a partir da extensão de arquivo do URL. Se o arquivo não tiver extensão, será possível especificar "zip", "jar", "war", "aar", "tar", "tar.gz", "tgz", "tar.xz", "txz", ".tar.zst", ".tzst", "tar.bz2", ".tbz", ".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. Em vez de precisar especificar esse prefixo várias vezes no build_file, esse campo pode ser usado para removê-lo de 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 código canônico.
auth default = {}
Um dicionário opcional que especifica informações de autenticação para alguns dos URLs.
integrity default = ''
Soma de verificação esperada do arquivo transferido por download, no formato Subresource Integrity. Ele precisa corresponder à soma de verificação do arquivo transferido por download. É um risco à segurança omitir a soma de verificação, já que os arquivos remotos podem mudar. Na melhor das hipóteses, a omissão desse campo tornará sua versão não hermética. É opcional facilitar o desenvolvimento, mas deve ser definido antes do envio.
rename_files default = {}
Um dicionário opcional que especifica arquivos para renomear 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 contêm nomes de arquivos não Unicode ou que têm arquivos que serão extraídos para o mesmo caminho em sistemas de arquivos indiferentes a maiú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, 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 required
Lista de argumentos. O primeiro elemento precisa ser o caminho para o programa ser executado.
timeout default = 600
duração máxima do comando em segundos (o padrão é 600 segundos).
environment default = {}
força algumas variáveis de ambiente a serem definidas para serem passadas para o processo.
quiet default = True
Se stdout e stderr tiverem que ser impressos no terminal.
working_directory default = ""
Diretório de trabalho para a execução do comando. 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; obrigatório
para o arquivo que será descompactado, relativo ao diretório do repositório.
output string; or Label; or path; default = ''
caminho 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. Em vez de precisar especificar esse prefixo várias vezes no build_file, esse campo pode ser usado para removê-lo de arquivos extraídos.
rename_files default = {}
Um dicionário opcional que especifica arquivos para renomear 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 contêm nomes de arquivos não Unicode ou que têm arquivos que serão extraídos para o mesmo caminho em sistemas de arquivos indiferentes a maiú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; 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 sinalização executável no arquivo criado, true por padrão.
legacy_utf8 default = True
Codifica o conteúdo do arquivo para UTF-8, verdadeiro por padrão. As versões futuras mudarão o padrão e removerão esse parâmetro.

nome

string repository_ctx.name

O nome do repositório externo criado por esta regra.

os

repository_os repository_ctx.os

Uma estrutura 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 deve ser um arquivo de formato de diferença unificado padrão. A implementação do patch nativo do Bazel não é compatível com a correspondência de fuzz e com o patch binário, como a ferramenta de linha de comando do patch.

Parâmetros

Parâmetro Descrição
patch_file string; or Label; or path; obrigatório
O arquivo de patch a ser aplicado, que pode ser rótulo, caminho relativo ou caminho absoluto. Se for um caminho relativo, será resolvido para o diretório do repositório.
strip default = 0
retira o número especificado de componentes principais dos nomes dos arquivos;

caminho

path repository_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. 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 deve apontar para um arquivo não gerado). Se o caminho for um caminho, ele retornará o caminho como está.

Parâmetros

Parâmetro Descrição
path string; or Label; or path; obrigatório
string, rótulo ou caminho a 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; obrigatório
do arquivo a ser lido.

andamento_do_relatório

None repository_ctx.report_progress(status='')

Atualiza o status de progresso da busca deste repositório ou da extensão do módulo

Parâmetros

Parâmetro Descrição
status string; default = ''
string que descreve o status atual do progresso da busca 

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ório
O caminho para o qual o symlink deve apontar.
string; or Label; or 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)

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 é gravado em path. Um argumento executable opcional (padrão como verdadeiro) pode ser definido para ativar ou desativar o bit executável.

Parâmetros

Parâmetro Descrição
path string; or Label; or path; obrigatório
do arquivo a ser criado, relativo ao diretório do repositório.
template string; or Label; or path; obrigatório
para o arquivo de modelo.
substitutions default = {}
substituições a serem feitas ao expandir o modelo.
executable default = True
define a sinalização executável no arquivo criado, true por padrão.

qual

path repository_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
para encontrar no caminho.
Pode retornar None.

raiz_do_espaço_de_trabalho

path repository_ctx.workspace_root

O caminho para o espaço de trabalho raiz da invocação do Bazel.