Visão geral da extensão

Informar um problema Mostrar fonte Por noite · 7,4 do Google. 7,3 · 7.2 · 7,1 · 7,0 · 6,5

Esta página descreve como estender a linguagem BUILD usando macros e regras.

As extensões do Bazel são arquivos que terminam em .bzl. Use um instrução de carregamento para importar um símbolo de uma extensão.

Antes de aprender os conceitos mais avançados, faça o seguinte:

Macros e regras

Uma macro é uma função que instancia regras. Isso é útil quando um arquivo BUILD está ficando muito repetitivo ou complexo, porque permite reutilizar algum código. A função é avaliada assim que o arquivo BUILD é lido. Após a avaliação do arquivo BUILD, o Bazel tem poucas informações sobre macros: se a macro gerar um genrule, o Bazel vai se comportar como se você tivesse escrito o genrule. Como resultado, bazel query listará apenas o genrule gerado.

Uma regra é mais eficiente do que uma macro. Ele pode acessar os elementos internos do Bazel e ter controle total sobre o que está acontecendo. Ela pode, por exemplo, transmitir informações a outras regras.

Se você quiser reutilizar uma lógica simples, comece com uma macro. Se uma macro se tornar complexa, geralmente é uma boa ideia torná-la uma regra. Suporte para um novo idioma geralmente é feito com uma regra. As regras são para usuários avançados, e a maioria deles nunca precisa escrever uma. Eles só vão carregar e chamar as regras existentes.

Modelo de avaliação

Um build consiste em três fases.

  • Fase de carregamento. Primeiro, carregue e avalie todas as extensões e todos os BUILD os arquivos necessários para o build. A execução dos arquivos BUILD simplesmente instancia regras (sempre que uma regra é chamada, ela é adicionada a um gráfico). É aqui que as macros são avaliadas.

  • Fase de análise. O código das regras é executado (o implementation delas) ) e ações são instanciadas. Uma ação descreve como gerar um conjunto de saídas de um conjunto de entradas, como "executar gcc em hello.c e obter hello.o". É necessário listar explicitamente quais arquivos serão gerados antes e executar os comandos reais. Em outras palavras, a fase de análise leva o gráfico gerado pela fase de carregamento e gera um gráfico de ações.

  • Fase de execução. As ações são executadas quando pelo menos uma das saídas é obrigatórios. Se um arquivo estiver ausente ou se um comando falhar ao gerar uma saída, o build vai falhar. Os testes também são executados durante essa fase.

O Bazel usa o paralelismo para ler, analisar e avaliar os arquivos .bzl e BUILD. Um arquivo é lido no máximo uma vez por build, e o resultado da avaliação é armazenado em cache e reutilizado. Um arquivo só é avaliado depois que todas as dependências (instruções load()) são resolvidas. Por design, o carregamento de um arquivo .bzl não tem efeitos colaterais visíveis, apenas define valores e funções.

O Bazel tenta ser inteligente: usa a análise de dependências para saber quais arquivos precisam carregado, quais regras devem ser analisadas e quais ações devem ser executadas. Para Por exemplo, se uma regra gerar ações desnecessárias para o build atual, elas não serão executadas.

Como criar extensões

Os dois links abaixo serão muito úteis ao escrever suas próprias extensões. Mantenha-os ao alcance:

Mais informações

Além das macros e regras, você pode escrever aspectos e regras de repositório.