repositório_de_repositório

Reportar um problema Ver a fonte Nightly · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

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.

Membros

attr

struct repository_ctx.attr

Uma struct para acessar os valores dos atributos. Os valores são fornecidos pelo usuário. Caso contrário, um valor padrão é 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 ou path; required
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)

Faz o download de um arquivo para o caminho de saída do URL fornecido e retorna uma struct que contém 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. 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 iterável de strings; obrigatório
Lista de URLs espelhados que referenciam o mesmo arquivo.
output string; ou Label; ou path; o padrã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 baixado. Ele precisa corresponder ao hash SHA-256 do arquivo baixado. Omitir o SHA-256 é um risco de segurança, já que os arquivos remotos podem mudar. Na melhor das hipóteses, omitir esse campo vai tornar seu build não hermético. É opcional para facilitar o desenvolvimento, mas precisa ser definido antes do envio. Se fornecido, o cache do repositório será verificado primeiro em busca de um arquivo com o hash especificado. O download só será tentado se o arquivo não for encontrado no cache. Depois de um download bem-sucedido, o arquivo será adicionado ao cache.
executable O padrão é False
Defina a flag executável no arquivo criado. O padrão é "false".
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 o checksum (sha256 ou integrity).
auth O padrão é {}
Um dicionário opcional que especifica informações de autenticação para alguns dos URLs.
headers O padrão é {}
Um dicionário opcional que especifica cabeçalhos HTTP para todos os URLs.
integrity O padrão é ''
Soma de verificação esperada do arquivo baixado, no formato de integridade de subrecursos. Ele precisa corresponder ao checksum do arquivo baixado. Omitir o checksum é um risco de segurança, já que os arquivos remotos podem mudar. Na melhor das hipóteses, omitir esse campo vai tornar seu build não hermético. É opcional para facilitar o desenvolvimento, mas precisa ser definido antes do envio. Se fornecido, o cache do repositório será verificado primeiro em busca de um arquivo com o checksum especificado. Um download só será tentado se o arquivo não for encontrado no cache. Depois de um download bem-sucedido, o arquivo será adicionado ao cache.
block O padrão é True
. Se definido como "false", a chamada será retornada imediatamente e, em vez do valor de retorno regular, ela vai retornar um token com um único método, wait(), que bloqueia até que o download seja concluído e retorna o valor de retorno usual 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={})

Faz o download de um arquivo para o caminho de saída do URL fornecido, extrai e retorna uma struct que contém success, uma flag 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. 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 iterável de strings; obrigatório
Lista de URLs espelhados que referenciam o 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 baixado. Ele precisa corresponder ao hash SHA-256 do arquivo baixado. Omitir o SHA-256 é um risco de segurança, já que os arquivos remotos podem mudar. Na melhor das hipóteses, omitir esse campo vai tornar seu build não hermético. É opcional para facilitar o desenvolvimento, mas precisa ser definido antes do envio. Se fornecido, o cache do repositório será verificado primeiro em busca de um arquivo com o hash especificado. O download só será tentado se o arquivo não for encontrado no cache. Depois de um download bem-sucedido, o arquivo será adicionado ao cache.
type O padrão é ''
O tipo de arquivo do arquivo baixado. Por padrão, o tipo de arquivo é determinado pela extensão do arquivo do URL. Se o arquivo não tiver uma extensão, especifique "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 contêm um diretório de nível superior com todos os arquivos do 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 o checksum" (sha256 ou integrity).
auth O padrão é {}
Um dicionário opcional que especifica informações de autenticação para alguns dos URLs.
headers O padrão é {}
Um dicionário opcional que especifica cabeçalhos HTTP para todos os URLs.
integrity O padrão é ''
Soma de verificação esperada do arquivo baixado, no formato de integridade de subrecursos. Ele precisa corresponder ao checksum do arquivo baixado. Omitir o checksum é um risco de segurança, já que os arquivos remotos podem mudar. Na melhor das hipóteses, omitir esse campo vai tornar seu build não hermético. É opcional para facilitar o desenvolvimento, mas precisa ser definido antes do envio. Se fornecido, o cache do repositório será verificado primeiro em busca de um arquivo com o checksum especificado. Um download só será tentado se o arquivo não for encontrado no cache. Depois de um download bem-sucedido, o arquivo será adicionado ao cache.
rename_files O padrão é {}
Um dicionário 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 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 diferenciação de maiúsculas e 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, padrão de 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 obrigatório
Lista de argumentos. O primeiro elemento precisa ser o caminho para o programa a ser executado.
timeout O padrão é 600
. Duração máxima do comando em segundos (o padrão é 600 segundos).
environment O padrão é {}
. Força a definição de algumas variáveis de ambiente para serem transmitidas ao processo.
quiet O padrão é True
Se stdout e stderr devem 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')

Extraia um arquivo para o diretório do repositório.

Parâmetros

Parâmetro Descrição
archive string, Label ou path; required
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 a ser removido dos arquivos extraídos. Muitos arquivos contêm um diretório de nível superior com todos os arquivos do 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 dicionário 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 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 diferenciação de 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ó tenta monitorar o arquivo quando isso é permitido por lei. Consulte a documentação watch() para mais informações.

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; ou Label; ou path; required
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
Defina a flag executável no arquivo criado, que é "true" por padrão.
legacy_utf8 O padrão é True
Codifica o conteúdo do arquivo para UTF-8, o padrão é "true". Versões futuras vão mudar o padrão e remover esse parâmetro.

getenv

string repository_ctx.getenv(name, default=None)

Retorna o valor de uma variável de ambiente name como uma string, se ela existir, ou default, se não existir.

Ao criar incrementalmente, 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; required
Nome da variável de ambiente desejada.
default string ou None; o padrão é None
. Valor padrão a ser retornado se name não for encontrado.
Pode retornar None.

nome

string repository_ctx.name

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

os

repository_os repository_ctx.os

Uma struct para acessar informações do sistema.

patch

None repository_ctx.patch(patch_file, strip=0, *, watch_patch='auto')

Aplique um arquivo de patch ao diretório raiz do repositório externo. O arquivo de patch precisa estar no formato diff unificado padrão. A implementação de patch nativa do Bazel não é compatível com correspondência aproximada e patch binário, como a ferramenta de linha de comando patch.

Parâmetros

Parâmetro Descrição
patch_file string; ou Label; ou path; required
O arquivo de patch a ser aplicado. Pode ser um rótulo, um caminho relativo ou um caminho absoluto. Se for um caminho relativo, ele será resolvido para o diretório do repositório.
strip O padrão é 0
Remove o número especificado de componentes iniciais dos nomes de arquivos.
watch_patch O padrão é 'auto'
Se é para monitorar o arquivo de patch. 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ó tenta monitorar o arquivo quando isso é permitido por lei. Consulte a documentação watch() para mais informações.

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 como 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 de destino. O rótulo precisa apontar para um arquivo não gerado. Se o caminho for um caminho, ele será retornado como está.

Parâmetros

Parâmetro Descrição
path string; ou Label; ou path; required
string, Label ou path de onde criar um caminho.

ler

string repository_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; required
Caminho do arquivo a ser lido.
watch O padrão é 'auto'
. 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ó tenta monitorar o arquivo quando isso é permitido por lei. Consulte a documentação watch() para mais informações.

report_progress

None repository_ctx.report_progress(status='')

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

Parâmetros

Parâmetro Descrição
status string; o padrão é ''
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; ou Label; ou path; required
O caminho que o link simbólico deve apontar.
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')

Gera um novo arquivo usando um 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 é "true") pode ser definido para ativar ou desativar o bit executável.

Parâmetros

Parâmetro Descrição
path string; ou Label; ou path; required
Caminho do arquivo a ser criado, relativo ao diretório do repositório.
template string; ou Label; ou path; required
Caminho para o arquivo de modelo.
substitutions O padrão é {}
Substituições a serem feitas ao expandir o modelo.
executable O padrão é True
Defina a flag executável no arquivo criado, que é "true" por padrão.
watch_template O padrão é 'auto'
. 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ó tenta monitorar o arquivo quando isso é permitido por lei. Consulte a documentação watch() para mais informações.

relógio

None repository_ctx.watch(path)

Diz ao Bazel para ficar atento a mudanças no caminho especificado, independente de ele existir ou ser um arquivo ou diretório. Qualquer mudança no arquivo ou diretório vai invalidar esse repositório ou extensão de módulo, fazendo com que ele seja buscado ou reavaliado na próxima vez.

"Mudanças" incluem 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ça ou deixa de existir. É importante lembrar que isso não inclui mudanças em arquivos no diretório se o caminho for um diretório. Para isso, use path.readdir().

A tentativa de observar caminhos dentro do repositório que está sendo buscado ou dentro do diretório de trabalho da extensão do módulo atual vai resultar em um erro. Uma extensão de módulo que tenta observar um caminho fora do espaço de trabalho atual do Bazel também resulta em um erro.

Parâmetros

Parâmetro Descrição
path string; ou Label; ou path; required
Caminho do arquivo a ser monitorado.

watch_tree

None repository_ctx.watch_tree(path)

Instrui o Bazel a monitorar mudanças em arquivos ou diretórios de forma transitiva no caminho especificado. Qualquer mudança no conteúdo, na existência, nos nomes de arquivos ou diretórios fará com que esse repositório seja buscado novamente.

A tentativa de observar caminhos dentro do repositório que está sendo buscado vai resultar em um erro.

Parâmetros

Parâmetro Descrição
path string; ou Label; ou path; required
Caminho da árvore de diretórios a ser monitorada.

qual

path repository_ctx.which(program)

Retorna o path do programa correspondente ou None se não houver um programa desse tipo no caminho.

Parâmetros

Parâmetro Descrição
program required
Programa a ser encontrado no caminho.
Pode retornar None.

workspace_root

path repository_ctx.workspace_root

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