Conteúdo
pacote
package(default_deprecation, default_package_metadata, default_testonly, default_visibility, features)
Essa função declara metadados que se aplicam a todas as regras no pacote. Ele é usado no máximo uma vez em um pacote (arquivo BUILD).
Para a contraparte que declara os metadados aplicáveis a todas as regras no todo
repositório, use a função repo()
na
arquivo REPO.bazel
na raiz do seu repositório.
A função repo()
usa exatamente os mesmos argumentos que package()
.
A função package() precisa ser chamada logo após todas as instruções load() na parte de cima do arquivo, antes de qualquer regra.
Argumentos
Atributo | Descrição |
---|---|
default_applicable_licenses |
Alias para |
default_visibility |
Lista de rótulos; o padrão é A visibilidade padrão das regras neste pacote. Todas as regras neste pacote têm a visibilidade especificada neste
atributo, a menos que seja especificado de outra forma no atributo
|
default_deprecation |
String; o padrão é Define o padrão
|
default_package_metadata |
Lista de rótulos o padrão é Define uma lista padrão de destinos de metadados que se aplicam a todos os outros destinos no pacote. Geralmente, são destinos relacionados a declarações de licença e pacotes de OSS. Consulte exemplos em rules_license. |
default_testonly |
Booleano; o padrão é Define o padrão
a propriedade Em pacotes em |
features |
Lista de strings. O padrão é Define várias sinalizações que afetam a semântica deste arquivo BUILD. Esse recurso é usado principalmente por pessoas que trabalham no sistema de build para marcar pacotes que precisam de algum tipo de tratamento especial. Não use essa opção, a menos que seja explicitamente solicitada por alguém que esteja trabalhando no sistema de build. |
Exemplos
A declaração abaixo declara que as regras do pacote são visível apenas para os membros do pacote grupo//foo:target
. Declarações de visibilidade individual
em uma regra, se presente, substitui esta especificação.
package(default_visibility = ["//foo:target"])
package_group
package_group(name, packages, includes)
Essa função define um conjunto de pacotes
e associa um rótulo ao conjunto. O rótulo pode ser referenciado nos
atributos visibility
.
Os grupos de pacotes são usados principalmente para controle de visibilidade. Um destino visível publicamente pode ser referenciado em todos os pacotes da árvore de origem. Um destino privado só pode ser referenciado no próprio pacote (não em subpacotes). Entre esses extremos, um destino pode permitir o acesso ao próprio pacote e a qualquer um dos pacotes descritos por um ou mais grupos de pacotes. Para uma visão mais detalhada sobre o sistema de visibilidade, consulte a visibilidade .
Um determinado pacote é considerado como estando no grupo se corresponder ao
atributo packages
ou já estiver contido em um dos outros
grupos de pacotes mencionados no atributo includes
.
Tecnicamente, os grupos de pacotes são alvos, mas não são criados por regras, e não têm nenhuma proteção de visibilidade.
Argumentos
Atributo | Descrição |
---|---|
name |
Nome: obrigatório Um nome exclusivo para essa segmentação. |
packages |
Lista de strings o padrão é Uma lista de zero ou mais especificações de pacote. Cada string de especificação de pacote pode ter uma das seguintes formas:
Além disso, os dois primeiros tipos de especificações de pacote também podem
ter o prefixo O grupo de pacotes contém qualquer pacote que corresponda a pelo menos um
suas especificações positivas e nenhuma de suas especificações negativas
Por exemplo, o valor Além da visibilidade pública, não há como especificar diretamente pacotes fora do repositório atual. Se esse atributo estiver ausente, será o mesmo que defini-lo como um
lista vazia, o que também é o mesmo de defini-la como uma lista que contém
somente Observação:antes do Bazel 6.0, a especificação Observação:antes do Bazel 6.0, quando esse atributo é serializado como
parte de |
includes |
Lista de rótulos o padrão é Outros grupos de pacotes incluídos neste. Os rótulos deste atributo precisam se referir a outros grupos de pacotes.
Os pacotes em grupos de pacotes referenciados são considerados parte deste
grupo de pacotes. Isso é transitivo. Se o grupo de pacotes
Quando usado com especificações de pacote negadas, observe que o de pacotes para cada grupo é calculado de forma independente, e o e os resultados são reunidos. Isso significa que as especificações negadas em um grupo não têm efeito sobre as especificações em outro grupo. |
Exemplos
A declaração package_group
a seguir especifica um
grupo de pacotes chamado "tropical" que contém frutas tropicais.
package_group( name = "tropical", packages = [ "//fruits/mango", "//fruits/orange", "//fruits/papaya/...", ], )
As declarações a seguir especificam os grupos de pacotes de um aplicativo:
package_group( name = "fooapp", includes = [ ":controller", ":model", ":view", ], ) package_group( name = "model", packages = ["//fooapp/database"], ) package_group( name = "view", packages = [ "//fooapp/swingui", "//fooapp/webui", ], ) package_group( name = "controller", packages = ["//fooapp/algorithm"], )
exports_files
exports_files([label, ...], visibility, licenses)
exports_files()
especifica uma lista de arquivos que pertencem a
desse pacote que são exportados para outros pacotes.
O arquivo BUILD de um pacote só pode se referir diretamente a arquivos de origem pertencentes
a outro pacote se eles forem exportados explicitamente com uma
instrução exports_files()
. Leia mais sobre
visibilidade dos arquivos.
Por ser um comportamento legado, também são exportados os arquivos mencionados como entrada para uma regra
com a visibilidade padrão até que a sinalização
--incompatible_no_implicit_file_export
é invertido. No entanto, esse comportamento não deve ser confiável
que migraram para o Google.
Argumentos
O argumento é uma lista de nomes de arquivos dentro do pacote atual. Uma
declaração de visibilidade também pode ser especificada. Nesse caso, os arquivos vão ficar
visíveis para os destinos especificados. Se nenhuma visibilidade for especificada, os arquivos
vão ficar visíveis para todos os pacotes, mesmo que uma visibilidade padrão de pacote tenha sido
especificada na função
package
. As licenças
também podem ser especificadas.
Exemplo
O exemplo a seguir exporta golden.txt
, um
arquivo de texto do pacote test_data
, para que outros
pacotes possam usá-lo, por exemplo, no atributo data
dos testes.
# from //test_data/BUILD exports_files(["golden.txt"])
massa
glob(include, exclude=[], exclude_directories=1, allow_empty=True)
Glob é uma função auxiliar que encontra todos os arquivos que correspondem a determinados padrões de caminho, e retorna uma nova lista mutável e classificada dos caminhos. O Glob só pesquisa arquivos em seu próprio pacote e procura apenas por arquivos de origem (não arquivos gerados nem outros destinos).
O rótulo de um arquivo de origem é incluído no resultado se o caminho relativo ao pacote
do arquivo corresponder a um dos padrões include
e a nenhum dos
padrões exclude
.
As listas include
e exclude
contêm padrões de caminho
relativos ao pacote atual. Cada padrão pode consistir em um ou
mais segmentos de caminho. Como de costume com caminhos Unix, esses segmentos são separados por
/
: Os segmentos podem conter o caractere curinga *
: ele corresponde
a qualquer substring no segmento de caminho (até mesmo a substring vazia), excluindo o
separador de diretório /
. Esse caractere curinga pode ser usado várias vezes
em um segmento de caminho. Além disso, o caractere curinga **
pode corresponder
a zero ou mais segmentos de caminho completos, mas precisa ser declarado como um segmento
de caminho independente.
foo/bar.txt
corresponde exatamente ao arquivofoo/bar.txt
neste pacotefoo/*.txt
corresponde a todos os arquivos no diretóriofoo/
. se o arquivo termina com.txt
(a menos quefoo/
seja um subpacote)foo/a*.htm*
corresponde a todos os arquivos emfoo/
. diretório que começa coma
e tem uma string arbitrária (pode vazio), tem.htm
e termina com outra string arbitrária; comofoo/axx.htm
efoo/a.html
oufoo/axxx.html
**/a.txt
corresponde a todos os arquivosa.txt
em cada subdiretório deste pacote**/bar/**/*.txt
corresponde a todos os arquivos.txt
em todos os subdiretórios desse pacote, se pelo menos um diretório no caminho resultante for chamado debar
, comoxxx/bar/yyy/zzz/a.txt
oubar/a.txt
(lembre-se de que**
também corresponde a zero segmentos) oubar/zzz/a.txt
.**
corresponde a todos os arquivos em todos os subdiretórios deste pacotefoo**/a.txt
é um padrão inválido, porque**
precisa ser um segmento independente
Se o argumento exclude_directories
estiver ativado (definido como 1), os arquivos do
tipo diretório serão omitidos dos resultados (padrão 1).
Se o argumento allow_empty
for definido como False
, a
função glob
vai gerar um erro se o resultado for a
lista vazia.
Há várias limitações e ressalvas importantes:
-
Como
glob()
é executado durante a avaliação de arquivos BUILD,glob()
corresponde apenas a arquivos na árvore de origem, nunca a arquivos gerados. Se você está criando um destino que exige origem e arquivos gerados, você deve anexar uma lista explícita de arquivos no glob. Veja o exemplo abaixo com:mylib
e:gen_java_srcs
. -
Se uma regra tiver o mesmo nome que um arquivo de origem correspondente, ela "obscurecerá" o arquivo.
Para entender isso, lembre-se de que
glob()
retorna uma lista de caminhos. Portanto, usarglob()
nas outras regras (por exemplo,srcs = glob(["*.cc"])
) tem o mesmo efeito que listar os caminhos correspondentes de forma explícita. Se, por exemplo,glob()
produzir["Foo.java", "bar/Baz.java"]
, mas também existe uma regra na pacote chamado "Foo.java" (o que é permitido, mas o Bazel avisa sobre isso), o consumidor doglob()
vai usar a classe "Foo.java" regra (suas saídas) em vez do arquivo "Foo.java" . Consulte o problema #10395 do GitHub para mais detalhes. - Os globs podem corresponder a arquivos em subdiretórios. E nomes de subdiretórios pode ser curinga. No entanto...
-
Os rótulos não podem cruzar os limites do pacote, e o glob não correspondem a arquivos em subpacotes.
Por exemplo, a expressão glob
**/*.cc
no pacotex
não vai incluirx/y/z.cc
sex/y
existe como um pacote (comox/y/BUILD
ou em outro lugar no package-path). Isso significa que o resultado da expressão glob realmente depende da de arquivos BUILD, ou seja, a mesma expressão glob incluirx/y/z.cc
se não houver um pacote chamadox/y
ou ela foi marcada como excluída usando o --deleted_packages . - A restrição acima se aplica a todas as expressões glob, sejam quais forem os caracteres curinga.
-
A correspondência total de um arquivo oculto com nome começando com
.
é: os caracteres curinga**
e*
. Se você quiser fazer a correspondência com um arquivo oculto com um padrão composto, ele precisa começar com uma.
. Por exemplo,*
e.*.txt
corresponderão a.foo.txt
, mas*.txt
não. A correspondência dos diretórios ocultos é feita da mesma maneira. Diretórios ocultos pode incluir arquivos que não são necessários como entradas e pode aumentar número de arquivos globulares desnecessariamente e consumo de memória. Para excluir os diretórios ocultos, adicione-os ao diretório "excluir" argumento list. -
O "**" o caractere curinga tem uma primeira letra maiúscula: o padrão
"**"
não corresponde ao caminho do diretório do pacote. Ou seja, Por exemplo,glob(["**"], exclude_directories = 0)
corresponde a todos os arquivos e diretórios de maneira transitiva estritamente sob o diretório do pacote atual (mas sem entrar em diretórios de subpacotes. Consulte os sobre isso).
Em geral, tente fornecer uma extensão adequada (por exemplo, *.html) em vez de usar um '*' vazio para um padrão de glob. O nome mais explícito é autodocumentado e garante que você não corresponda acidentalmente ao backup ou arquivos emacs/vi/... salvos automaticamente.
Ao escrever regras de build, você pode enumerar os elementos do glob. Isso permite gerar regras individuais para cada entrada, por exemplo. Consulte a seção exemplo de glob expandido abaixo.
Exemplos da Glob
Criar uma biblioteca Java compilada com base em todos os arquivos java deste diretório
e todos os arquivos gerados pela regra :gen_java_srcs
.
java_library( name = "mylib", srcs = glob(["*.java"]) + [":gen_java_srcs"], deps = "...", ) genrule( name = "gen_java_srcs", outs = [ "Foo.java", "Bar.java", ], ... )
Inclua todos os arquivos txt no diretório testdata, exceto experimental.txt. Os arquivos em subdiretórios de testdata não serão incluídos. Se você quiser que esses arquivos sejam incluídos, use um glob recursivo (**).
sh_test( name = "mytest", srcs = ["mytest.sh"], data = glob( ["testdata/*.txt"], exclude = ["testdata/experimental.txt"], ), )
Exemplos de globo recursivo
Faça com que o teste dependa de todos os arquivos txt no diretório de dados de teste e de todos os subdiretórios (e subdiretórios deles e assim por diante). Os subdiretórios que contêm um arquivo BUILD são ignorados. Consulte as limitações e ressalvas acima.
sh_test( name = "mytest", srcs = ["mytest.sh"], data = glob(["testdata/**/*.txt"]), )
Criar uma biblioteca compilada a partir de todos os arquivos java deste diretório e todos subdiretórios, exceto aqueles cujo caminho inclui um diretório chamado "testing". Evite esse padrão, se possível, porque ele pode reduzir a incrementalidade do build e, portanto, aumentar os tempos de build.
java_library( name = "mylib", srcs = glob( ["**/*.java"], exclude = ["**/testing/**"], ), )
Exemplos de globs expandidos
Crie uma genrule individual para *_test.cc no diretório atual que conte o número de linhas no arquivo.
# Conveniently, the build language supports list comprehensions. [genrule( name = "count_lines_" + f[:-3], # strip ".cc" srcs = [f], outs = ["%s-linecount.txt" % f[:-3]], cmd = "wc -l $< >$@", ) for f in glob(["*_test.cc"])]
Se o arquivo BUILD acima estiver no pacote //foo e o pacote contiver três
arquivos correspondentes, a_test.cc, b_test.cc e c_test.cc, a execução de
bazel query '//foo:all'
listará todas as regras que foram geradas:
$ bazel query '//foo:all' | sort //foo:count_lines_a_test //foo:count_lines_b_test //foo:count_lines_c_test
select
select( {conditionA: valuesA, conditionB: valuesB, ...}, no_match_error = "custom message" )
select()
é a função auxiliar que torna um atributo de regra
configurável.
Ele pode substituir o lado direito de
quase
qualquer atribuição de atributo, de modo que o valor depende das flags do Bazel na linha de comando.
É possível usar isso, por exemplo, para definir dependências específicas da plataforma ou
incorporar diferentes recursos, dependendo se uma regra foi criada no modo "desenvolvedor"
ou "liberação".
O uso básico é o seguinte:
sh_binary( name = "mytarget", srcs = select({ ":conditionA": ["mytarget_a.sh"], ":conditionB": ["mytarget_b.sh"], "//conditions:default": ["mytarget_default.sh"] }) )
Isso faz com que o atributo srcs
do
um sh_binary
configurável substituindo o rótulo normal
atribuição de lista com uma chamada select
que mapeia
das condições de configuração
aos valores correspondentes. Cada condição é um rótulo
referência a
um config_setting
ou
constraint_value
,
que "corresponde" se a configuração do destino corresponder a um conjunto esperado de
valores. O valor de mytarget#srcs
se torna o que
lista de rótulos corresponde à invocação atual.
Observações:
- Exatamente uma condição é selecionada em qualquer invocação.
- Se várias condições corresponderem e uma for especialização das outras, a especialização tem precedência. A condição B é considerada especialização da condição A se B tiver as mesmas flags e restrições valores como A mais algumas sinalizações ou valores de restrição adicionais. Isso também significa que a resolução de especialização não foi projetada para criar uma ordenação, conforme demonstrado no Exemplo 2 abaixo.
- Se várias condições corresponderem e uma não for uma especialização de todas outros, o Bazel falha com um erro, a menos que todas as condições sejam resolvidas com o mesmo valor.
- O pseudorótulo especial
//conditions:default
é considerado correspondente se nenhuma outra condição corresponder. Se essa condição for deixada de fora, alguma outra regra deverá corresponder para evitar um erro. select
pode ser incorporado dentro de uma atribuição de atributo maior. Portanto,srcs = ["common.sh"] + select({ ":conditionA": ["myrule_a.sh"], ...})
esrcs = select({ ":conditionA": ["a.sh"]}) + select({ ":conditionB": ["b.sh"]})
são expressões válidas.select
funciona com a maioria dos atributos, mas não com todos. Incompatível atributos estão marcados comononconfigurable
na documentação.subpacotes
subpackages(include, exclude=[], allow_empty=True)
subpackages()
é uma função auxiliar semelhante aglob()
que lista subpacotes em vez de arquivos e diretórios. Ele usa a mesma caminhos padrão comoglob()
e pode corresponder a qualquer subpacote que seja um descendente direto do arquivo BUILD que está sendo carregado. Consulte glob para uma explicação detalhada e exemplos de inclusão e excluir padrões.A lista resultante de subpacotes retornados está na ordem de classificação e contém caminhos relativos ao pacote de carregamento atual que correspondem aos padrões fornecidos em
include
e não aqueles emexclude
.Exemplo
O exemplo a seguir lista todos os subpacotes diretos do pacote
foo/BUILD
# The following BUILD files exist: # foo/BUILD # foo/bar/baz/BUILD # foo/sub/BUILD # foo/sub/deeper/BUILD # # In foo/BUILD a call to subs = subpackages(include = ["**"]) # results in subs == ["sub", "bar/baz"] # # 'sub/deeper' is not included because it is a subpackage of 'foo/sub' not of # 'foo'
Em geral, em vez de chamar essa função diretamente, é preferível que os usuários usem o módulo "subpackages" da skylib.