nativa

Um módulo integrado para oferecer suporte a regras nativas e outras funções auxiliares de pacote. Todas as regras nativas aparecem como funções neste módulo, por exemplo, native.cc_library. O módulo nativo só está disponível na fase de carregamento (ou seja, para macros, não para implementações de regras). Os atributos vão ignorar os valores None e os tratarão como se o atributo não estivesse definido.
As seguintes funções também estão disponíveis:

Participantes

existing_rule

unknown native.existing_rule(name)

Retorna um objeto imutável semelhante a um dict que descreve os atributos de uma regra instanciada no pacote dessa linha de execução, ou None se não existir uma instância de regra com esse nome.

Aqui, um objeto imutável do tipo dict significa um objeto x profundamente imutável, que oferece suporte a iteração semelhante a ditado, len(x), name in x, x[name], x.get(name), x.items(), x.keys() e x.values().

Se a sinalização --noincompatible_existing_rules_immutable_view estiver definida, um novo dict mutável será retornado com o mesmo conteúdo.

O resultado contém uma entrada para cada atributo, exceto os privados (cujos nomes não começam com uma letra) e alguns tipos de atributos legados que não podem ser representados. Além disso, o dict contém entradas para o name e o kind da instância da regra (por exemplo, 'cc_binary').

Os valores do resultado representam os valores do atributo da seguinte forma:

  • Os atributos de tipo str, int e bool são representados no estado em que se encontram.
  • Os rótulos são convertidos em strings no formato ':foo' para destinos no mesmo pacote ou '//pkg:name' para destinos em um pacote diferente.
  • As listas são representadas como tuplas, e os dicts são convertidos em dicts novos e mutáveis. Os elementos deles são convertidos recursivamente da mesma maneira.
  • Os valores select são retornados com os conteúdos transformados conforme descrito acima.
  • Os atributos para os quais nenhum valor foi especificado durante a instanciação da regra e cujo valor padrão é calculado são excluídos do resultado. Os padrões calculados não podem ser calculados até a fase de análise.

Se possível, evite usar essa função. Isso torna os arquivos BUILD frágeis e dependem da ordem. Além disso, saiba que ela é sutilmente diferente das duas outras conversões de valores de atributo de regra do formato interno para Starlark: uma usada por padrões computados e outra usada por ctx.attr.foo.

Parâmetros

Parâmetro Descrição
name obrigatório
O nome do destino.

existing_rules

unknown native.existing_rules()

Retorna um objeto imutável do tipo dict que descreve as regras instanciadas até o momento no pacote dessa linha de execução. Cada entrada do objeto semelhante a um dicionário mapeia o nome da instância da regra para o resultado que seria retornado por existing_rule(name).

Aqui, um objeto imutável do tipo dict significa um objeto x profundamente imutável, que oferece suporte a iteração semelhante a ditado, len(x), name in x, x[name], x.get(name), x.items(), x.keys() e x.values().

Se a sinalização --noincompatible_existing_rules_immutable_view estiver definida, um novo dict mutável será retornado com o mesmo conteúdo.

Observação: se possível, evite usar essa função. Isso torna os arquivos BUILD frágeis e dependem da ordem. Além disso, se a flag --noincompatible_existing_rules_immutable_view estiver definida, essa função poderá ser muito cara, especialmente se for chamada dentro de um loop.

exports_files

None native.exports_files(srcs, visibility=None, licenses=None)

Especifica uma lista de arquivos pertencentes a este pacote que são exportados para outros pacotes.

Parâmetros

Parâmetro Descrição
srcs sequence of strings; obrigatório
Lista de arquivos a serem exportados.
visibility sequence; or None; default = None
Uma declaração de visibilidade pode ser especificada. Os arquivos ficarão visíveis para os destinos especificados. Se nenhuma visibilidade for especificada, os arquivos ficarão visíveis para todos os pacotes.
licenses sequence of strings; or None; padrão = Nenhuma
Licenças a serem especificadas.

Globo

sequence native.glob(include=[], exclude=[], exclude_directories=1, allow_empty=unbound)

O Glob retorna uma nova lista mutável e ordenada de cada arquivo no pacote atual que:
  • Corresponde a pelo menos um padrão em include.
  • Não corresponde a nenhum dos padrões em exclude (o padrão é []).
Se o argumento exclude_directories estiver ativado (definido como 1), os arquivos do tipo diretório serão omitidos dos resultados (padrão 1).

Parâmetros

Parâmetro Descrição
include sequence of strings; default = []
A lista de padrões glob a serem incluídos.
exclude sequence of strings; default = []
A lista de padrões glob a serem excluídos.
exclude_directories default = 1
Uma sinalização para excluir diretórios ou não.
allow_empty default = unbound
Define se os padrões glob não correspondem a nada. Se "allow_empty" for definido como "False", cada padrão de inclusão individual vai precisar corresponder a algo. Além disso, o resultado final não pode estar vazio (depois que as correspondências dos padrões de "excluir" forem excluídas).

package_group

None native.package_group(name, packages=[], includes=[])

Define um conjunto de pacotes e atribui um rótulo ao grupo. O rótulo pode ser referenciado nos atributos visibility.

Parâmetros

Parâmetro Descrição
name obrigatório
O nome exclusivo da regra.
packages sequence of strings; default = []
Uma enumeração completa de pacotes neste grupo.
includes sequence of strings; default = []
Outros grupos de pacotes incluídos neste.

package_name

string native.package_name()

O nome do pacote que está sendo avaliado. Por exemplo, no arquivo BUILD some/package/BUILD, o valor dele será some/package. Se o arquivo BUILD chamar uma função definida em um arquivo .bzl, package_name() corresponderá ao pacote de arquivos BUILD do autor da chamada. Essa função é equivalente à variável descontinuada PACKAGE_NAME.

repository_name

string native.repository_name()

O nome do repositório em que a regra ou a extensão de build é chamada. Por exemplo, em pacotes chamados para existência pela estrofe local_repository(name='local', path=...) do WORKSPACE, ela é definida como @local. Nos pacotes no repositório principal, ele estará definido como @. Essa função é equivalente à variável descontinuada REPOSITORY_NAME.

subpacotes

sequence native.subpackages(include, exclude=[], allow_empty=False)

Retorna uma nova lista mutável de cada subpacote direto do pacote atual, independentemente da profundidade do diretório do sistema de arquivos. A lista retornada é classificada e contém os nomes dos subpacotes relativos ao pacote atual. É recomendável usar os métodos no módulo bazel_skylib.subpackages em vez de chamar essa função diretamente.

Parâmetros

Parâmetro Descrição
include sequence of strings; obrigatório
A lista de padrões glob a serem incluídos na verificação de subpacotes.
exclude sequence of strings; default = []
A lista de padrões glob a serem excluídos da verificação de subpacotes.
allow_empty default = False
Indica se vamos falhar se a chamada retornar uma lista vazia. Por padrão, uma lista vazia indica um possível erro no arquivo BUILD em que a chamada para subpackages() é supérflua. Se ela for definida como verdadeira, ela será bem-sucedida nesse caso.