repositório_de_repositório

Reportar um problema Ver código-fonte Nightly · 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

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

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 um diretório. Retorna um valor 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; 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)

Faz o download de um arquivo para o caminho de saída do URL fornecido e retorna uma estrutura contendo 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 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 é o caminho ''
para o arquivo de saída, relativo ao diretório do repositório.
sha256 string; 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 um download bem-sucedido, o arquivo será adicionado ao cache.
executable bool; o padrão é False
Define a flag executável no arquivo criado, falsa por padrão.
allow_fail bool; o padrão é False
. Se definido, indique o erro no valor de retorno em vez de gerar um erro para downloads com falha.
canonical_id string; 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 dict: o padrão é {}
. Uma matriz opcional que especifica informações de autenticação para alguns dos URLs.
headers dict. O padrão é {}
Um dict opcional que especifica cabeçalhos HTTP para todos os URLs.
integrity string; o padrão é ''
Soma de verificação esperada do arquivo transferido por download, no formato Sub-resource Integrity. 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. 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 bool; o padrão é True.
Se definido como falso, a chamada vai retornar imediatamente, em vez do valor de retorno normal, ela retornará um token com um único método, "wait()", que fica bloqueado até que o download seja concluído e retorna o valor de retorno normal ou é gerado normalmente.

download_and_extract

struct repository_ctx.download_and_extract(url, output='', sha256='', type='', strip_prefix='', 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-o e retorna uma estrutura 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 de espelho 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 string; 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. É um risco à segurança omitir o SHA-256 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 em busca de um arquivo com o hash fornecido. Só haverá uma tentativa de download se o arquivo não for encontrado no cache. Após o download, o arquivo será adicionado ao cache.
type string; 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 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" aqui.
strip_prefix string; 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 repetidamente no build_file, esse campo pode ser usado para removê-lo dos arquivos extraídos.

Para compatibilidade, esse parâmetro também pode ser usado com o nome stripPrefix, que foi descontinuado.

allow_fail bool; 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 string; 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 dict: o padrão é {}
. Uma matriz opcional que especifica informações de autenticação para alguns dos URLs.
headers dict: o padrão é {}
. Uma dict opcional que especifica cabeçalhos HTTP para todos os URLs.
integrity string; 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. 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.
rename_files dict; o padrão é {}
Uma matriz opcional que especifica os arquivos a serem renomeados 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 seriam extraídos para o mesmo caminho em sistemas de arquivos sem distinção entre 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 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 sequence: obrigatório
Lista de argumentos. O primeiro elemento precisa ser o caminho para o programa a ser executado.
timeout int; O padrão é 600
Duração máxima do comando em segundos (padrão: 600 segundos).
environment dict; o padrão é {}
Força algumas variáveis de ambiente a serem definidas para serem transmitidas ao processo. O valor pode ser None para remover a variável de ambiente.
quiet bool; o padrão é True
Se stdout e stderr precisam ser impressos no terminal.
working_directory string; o padrão é ""
Diretório de trabalho para a execução do comando. Pode ser relativo à raiz do repositório ou absoluto. O padrão é o repositório raiz.

extrair

None repository_ctx.extract(archive, output='', strip_prefix='', *, rename_files={}, watch_archive='auto')

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

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.
strip_prefix string; 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.

Para compatibilidade, esse parâmetro também pode ser usado com o nome stripPrefix, que foi descontinuado.

rename_files dict; 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 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 string; 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)

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; obrigatório
Caminho do arquivo a ser criado, em relação ao diretório do repositório.
content string; O padrão é ''
O conteúdo do arquivo a ser criado, vazio por padrão.
executable bool; O padrão é True
Define a flag executável no arquivo criado, verdadeira por padrão.
legacy_utf8 bool: o padrão é True
. Codifica o conteúdo do arquivo em UTF-8, verdadeiro por padrão. As 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 existir, ou default, caso contrário.

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.
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 de formato de diferença unificada (link em inglês). A implementação de patch nativa do Bazel não oferece suporte a correspondência de fuzz e patch binário, como a ferramenta de linha de comando de 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 int; o padrão é 0
Retira o número especificado de componentes principais dos nomes de arquivos.
watch_patch string; O padrão é 'auto'
. Indica 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)

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 no 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 path for um caminho, ele será retornado como está.

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')

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 de leitura.
watch string; o padrão é 'auto'
Define se o arquivo deve ser assistido. 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.

renomear

None repository_ctx.rename(src, dst)

Renomeia o arquivo ou diretório de src para dst. Os diretórios pais são criados conforme necessário. Falha se o caminho de destino já existir. Os dois caminhos precisam estar localizados no repositório.

Parâmetros

Parâmetro Descrição
src string; ou Label; ou path; obrigatório
O caminho do arquivo ou diretório a ser renomeado, relativo ao diretório do repositório.
dst string ou Label; ou path; required
O novo nome em que o arquivo ou diretório será renomeado, em relação ao diretório do repositório.

report_progress

None repository_ctx.report_progress(status='')

Atualiza o status de progresso da busca desse repositório ou extensão de 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; obrigatório
O caminho para o qual 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 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 Rótulo; ou caminho; obrigatório
Caminho para o arquivo de modelo.
substitutions dict: o padrão é {}
substituições a serem feitas ao expandir o modelo.
executable bool; O padrão é True
Define a flag executável no arquivo criado, verdadeira por padrão.
watch_template string; O padrão é 'auto'
Indica 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)

Informa ao Bazel que ele precisa monitorar as mudanças no caminho indicado, independentemente de ele existir ou não, ou se é um arquivo ou um diretório. Qualquer mudança no arquivo ou diretório invalida essa extensão de repositório ou módulo e faz com que ela seja recuperada ou reavaliada na próxima vez.

As "mudanças" incluem alterações no conteúdo do arquivo (se o caminho for um arquivo), se o caminho era um arquivo que agora é um diretório (ou vice-versa) e se o caminho começa ou deixa 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 monitorar caminhos dentro do repositório que está sendo buscado ou dentro do diretório de trabalho da extensão de módulo atual vai 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; required
Caminho do arquivo a ser observado.

watch_tree

None repository_ctx.watch_tree(path)

Instrui o Bazel a observar alterações em qualquer arquivo ou diretório transitivamente sob o caminho especificado. Qualquer mudança no conteúdo dos arquivos, na existência de arquivos ou diretórios, nos nomes de arquivos ou nos nomes de diretórios vai fazer com que o repositório seja buscado novamente.

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; required
Caminho da árvore de diretórios a ser observada.

qual

path repository_ctx.which(program)

Retorna a path do programa correspondente ou None se não houver esse programa no caminho.

Parâmetros

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