attrs
de rule()
e aspect()
.Consulte a página "Regras" para saber mais sobre como definir e usar atributos.
Participantes
- bool
- int
- int_list (em inglês)
- label
- label_keyed_string_dict.
- list_list
- saída
- output_list
- string
- string_dict.
- string_list;
- string_list_dict (em inglês)
bool
Attribute attr.bool(default=False, doc=None, mandatory=False)Cria um esquema para um atributo booleano. O atributo
ctx.attr
correspondente será do tipo bool
.
Parâmetros
Parâmetro | Descrição |
---|---|
default
|
default = False Um valor padrão a ser usado se nenhum valor para esse atributo for fornecido ao instanciar a regra. |
doc
|
string; or None ;
default = NoneUma descrição do atributo que pode ser extraída pelas ferramentas de geração de documentação. |
mandatory
|
default = False Se verdadeiro, o valor precisará ser especificado explicitamente (mesmo que tenha default ).
|
int
Attribute attr.int(default=0, doc=None, mandatory=False, values=[])Cria um esquema para um atributo inteiro. O valor precisa estar no intervalo assinado de 32 bits. O atributo
ctx.attr
correspondente será do tipo int
.
Parâmetros
Parâmetro | Descrição |
---|---|
default
|
default = 0 Um valor padrão a ser usado se nenhum valor para esse atributo for fornecido ao instanciar a regra. |
doc
|
string; or None ;
default = NoneUma descrição do atributo que pode ser extraída pelas ferramentas de geração de documentação. |
mandatory
|
default = False Se verdadeiro, o valor precisará ser especificado explicitamente (mesmo que tenha default ).
|
values
|
sequence of ints ;
default = []A lista de valores permitidos para o atributo. Um erro será gerado se outros valores forem fornecidos. |
int_list
Attribute attr.int_list(mandatory=False, allow_empty=True, *, default=[], doc=None)Cria um esquema para um atributo de lista de números inteiros. Cada elemento precisa estar no intervalo assinado de 32 bits.
Parâmetros
Parâmetro | Descrição |
---|---|
mandatory
|
default = False Se verdadeiro, o valor precisará ser especificado explicitamente (mesmo que tenha default ).
|
allow_empty
|
default = True Verdadeiro se o atributo puder estar vazio. |
default
|
sequence of ints ;
default = []Um valor padrão a ser usado se nenhum valor para esse atributo for fornecido ao instanciar a regra. |
doc
|
string; or None ;
default = NoneUma descrição do atributo que pode ser extraída pelas ferramentas de geração de documentação. |
Identificador
Attribute attr.label(default=None, doc=None, executable=False, allow_files=None, allow_single_file=None, mandatory=False, providers=[], allow_rules=None, cfg=None, aspects=[])
Cria um esquema para um atributo de rótulo. Este é um atributo de dependência.
Esse atributo contém valores exclusivos de Label
. Se uma string for fornecida no lugar de um Label
, ela será convertida usando o construtor de rótulos. As partes relativas do caminho do rótulo, incluindo o repositório (possivelmente renomeado), são resolvidas em relação ao pacote do destino instanciado.
No momento da análise (na função de implementação da regra), ao recuperar o valor do atributo de ctx.attr
, os rótulos são substituídos pelos Target
s correspondentes. Isso permite que você acesse os provedores das dependências do destino atual.
Além dos arquivos de origem comuns, esse tipo de atributo é frequentemente usado para se referir a uma ferramenta, por exemplo, um compilador. Essas ferramentas são consideradas dependências, assim como os arquivos de origem. Para evitar que os usuários especifiquem o rótulo da ferramenta sempre que usarem a regra nos arquivos BUILD, codifique o rótulo de uma ferramenta canônica como o valor default
desse atributo. Se também quiser impedir que os usuários substituam esse padrão, defina um nome que comece com um sublinhado. Consulte a página Regras para mais informações.
Parâmetros
Parâmetro | Descrição |
---|---|
default
|
Label; or string; or LateBoundDefault; or NativeComputedDefault; or function; or None ;
default = NoneUm valor padrão a ser usado se nenhum valor para esse atributo for fornecido ao instanciar a regra.Use uma string ou a função Label para especificar um valor padrão, por exemplo, attr.label(default = "//a:b") .
|
doc
|
string; or None ;
default = NoneUma descrição do atributo que pode ser extraída pelas ferramentas de geração de documentação. |
executable
|
default = False True se a dependência precisar ser executável. Isso significa que o rótulo deve se referir a um arquivo executável ou a uma regra que gera um arquivo executável. Acesse o rótulo com ctx.executable.<attribute_name> .
|
allow_files
|
bool; or sequence of strings; or None ;
default = NoneSe File são permitidos. Pode ser True , False (padrão) ou uma lista de extensões de arquivo permitidas (por exemplo, [".cc", ".cpp"] ).
|
allow_single_file
|
default = None É semelhante ao allow_files , com a restrição de que o rótulo precisa corresponder a um único arquivo. Acesse pelo ctx.file.<attribute_name> .
|
mandatory
|
default = False Se verdadeiro, o valor precisará ser especificado explicitamente (mesmo que tenha default ).
|
providers
|
default = [] Os provedores que precisam ser dados por qualquer dependência que apareça nesse atributo. O formato desse argumento é uma lista de provedores: objetos |
allow_rules
|
sequence of strings; or None ;
default = NoneQuais segmentações de regra (nome das classes) são permitidas. Ele foi descontinuado (apenas para compatibilidade). Em vez disso, use provedores. |
cfg
|
default = None Configuração do atributo. Pode ser "exec" , que indica que a dependência foi criada para execution platform , ou "target" , que indica que a dependência foi criada para target platform . Um exemplo típico da diferença é ao criar apps para dispositivos móveis, em que target platform é Android ou iOS enquanto execution platform é Linux , macOS ou Windows . Esse parâmetro será obrigatório se executable for verdadeiro para evitar a criação acidental de ferramentas de host na configuração de destino. "target" não tem efeito semântico. Portanto, não o defina quando executable for falso, a menos que isso realmente ajude a esclarecer suas intenções.
|
aspects
|
sequence of Aspects ;
default = []Aspectos que precisam ser aplicados às dependências especificadas por este atributo. |
marcador_chave_de_chave_etiqueta
Attribute attr.label_keyed_string_dict(allow_empty=True, *, default={}, doc=None, allow_files=None, allow_rules=None, providers=[], flags=[], mandatory=False, cfg=None, aspects=[])
Cria um esquema para um atributo que contém um dicionário, em que as chaves são rótulos e os valores são strings. Este é um atributo de dependência.
Esse atributo contém valores exclusivos de Label
. Se uma string for fornecida no lugar de um Label
, ela será convertida usando o construtor de rótulos. As partes relativas do caminho do rótulo, incluindo o repositório (possivelmente renomeado), são resolvidas em relação ao pacote do destino instanciado.
No momento da análise (na função de implementação da regra), ao recuperar o valor do atributo de ctx.attr
, os rótulos são substituídos pelos Target
s correspondentes. Isso permite que você acesse os provedores das dependências do destino atual.
Parâmetros
Parâmetro | Descrição |
---|---|
allow_empty
|
default = True Verdadeiro se o atributo puder estar vazio. |
default
|
dict; or function ;
default = {}Um valor padrão a ser usado se nenhum valor para esse atributo for fornecido ao instanciar a regra.Use strings ou a função Label para especificar valores padrão, por exemplo, attr.label_keyed_string_dict(default = {"//a:b": "value", "//a:c": "string"}) .
|
doc
|
string; or None ;
default = NoneUma descrição do atributo que pode ser extraída pelas ferramentas de geração de documentação. |
allow_files
|
bool; or sequence of strings; or None ;
default = NoneSe File são permitidos. Pode ser True , False (padrão) ou uma lista de extensões de arquivo permitidas (por exemplo, [".cc", ".cpp"] ).
|
allow_rules
|
sequence of strings; or None ;
default = NoneQuais segmentações de regra (nome das classes) são permitidas. Ele foi descontinuado (apenas para compatibilidade). Em vez disso, use provedores. |
providers
|
default = [] Os provedores que precisam ser dados por qualquer dependência que apareça nesse atributo. O formato desse argumento é uma lista de provedores: objetos |
flags
|
sequence of strings ;
default = []Obsoleto, será removido. |
mandatory
|
default = False Se verdadeiro, o valor precisará ser especificado explicitamente (mesmo que tenha default ).
|
cfg
|
default = None Configuração do atributo. Pode ser "exec" , que indica que a dependência foi criada para execution platform , ou "target" , que indica que a dependência foi criada para target platform . Um exemplo típico da diferença é ao criar apps para dispositivos móveis, em que target platform é Android ou iOS enquanto execution platform é Linux , macOS ou Windows .
|
aspects
|
sequence of Aspects ;
default = []Aspectos que precisam ser aplicados às dependências especificadas por este atributo. |
lista_de_rótulos
Attribute attr.label_list(allow_empty=True, *, default=[], doc=None, allow_files=None, allow_rules=None, providers=[], flags=[], mandatory=False, cfg=None, aspects=[])
Cria um esquema para um atributo de lista de rótulos. Este é um atributo de dependência. O atributo ctx.attr
correspondente será do tipo list de Target
s.
Esse atributo contém valores exclusivos de Label
. Se uma string for fornecida no lugar de um Label
, ela será convertida usando o construtor de rótulos. As partes relativas do caminho do rótulo, incluindo o repositório (possivelmente renomeado), são resolvidas em relação ao pacote do destino instanciado.
No momento da análise (na função de implementação da regra), ao recuperar o valor do atributo de ctx.attr
, os rótulos são substituídos pelos Target
s correspondentes. Isso permite que você acesse os provedores das dependências do destino atual.
Parâmetros
Parâmetro | Descrição |
---|---|
allow_empty
|
default = True Verdadeiro se o atributo puder estar vazio. |
default
|
sequence of Labels; or function ;
default = []Um valor padrão a ser usado se nenhum valor para esse atributo for fornecido ao instanciar a regra.Use strings ou a função Label para especificar valores padrão, por exemplo, attr.label_list(default = ["//a:b", "//a:c"]) .
|
doc
|
string; or None ;
default = NoneUma descrição do atributo que pode ser extraída pelas ferramentas de geração de documentação. |
allow_files
|
bool; or sequence of strings; or None ;
default = NoneSe File são permitidos. Pode ser True , False (padrão) ou uma lista de extensões de arquivo permitidas (por exemplo, [".cc", ".cpp"] ).
|
allow_rules
|
sequence of strings; or None ;
default = NoneQuais segmentações de regra (nome das classes) são permitidas. Ele foi descontinuado (apenas para compatibilidade). Em vez disso, use provedores. |
providers
|
default = [] Os provedores que precisam ser dados por qualquer dependência que apareça nesse atributo. O formato desse argumento é uma lista de provedores: objetos |
flags
|
sequence of strings ;
default = []Obsoleto, será removido. |
mandatory
|
default = False Se verdadeiro, o valor precisará ser especificado explicitamente (mesmo que tenha default ).
|
cfg
|
default = None Configuração do atributo. Pode ser "exec" , que indica que a dependência foi criada para execution platform , ou "target" , que indica que a dependência foi criada para target platform . Um exemplo típico da diferença é ao criar apps para dispositivos móveis, em que target platform é Android ou iOS enquanto execution platform é Linux , macOS ou Windows .
|
aspects
|
sequence of Aspects ;
default = []Aspectos que precisam ser aplicados às dependências especificadas por este atributo. |
saída
Attribute attr.output(doc=None, mandatory=False)
Cria um esquema para um atributo de saída (rótulo).
Esse atributo contém valores exclusivos de Label
. Se uma string for fornecida no lugar de um Label
, ela será convertida usando o construtor de rótulos. As partes relativas do caminho do rótulo, incluindo o repositório (possivelmente renomeado), são resolvidas em relação ao pacote do destino instanciado.
No momento da análise, o File
correspondente pode ser recuperado usando ctx.outputs
.
Parâmetros
Parâmetro | Descrição |
---|---|
doc
|
string; or None ;
default = NoneUma descrição do atributo que pode ser extraída pelas ferramentas de geração de documentação. |
mandatory
|
default = False Se verdadeiro, o valor precisará ser especificado explicitamente (mesmo que tenha default ).
|
lista_de_saída
Attribute attr.output_list(allow_empty=True, *, doc=None, mandatory=False)Cria um esquema para um atributo de lista de saídas.
Esse atributo contém valores exclusivos de Label
. Se uma string for fornecida no lugar de um Label
, ela será convertida usando o construtor de rótulos. As partes relativas do caminho do rótulo, incluindo o repositório (possivelmente renomeado), são resolvidas em relação ao pacote do destino instanciado.
No momento da análise, o File
correspondente pode ser recuperado usando ctx.outputs
.
Parâmetros
Parâmetro | Descrição |
---|---|
allow_empty
|
default = True Verdadeiro se o atributo puder estar vazio. |
doc
|
string; or None ;
default = NoneUma descrição do atributo que pode ser extraída pelas ferramentas de geração de documentação. |
mandatory
|
default = False Se verdadeiro, o valor precisará ser especificado explicitamente (mesmo que tenha default ).
|
string
Attribute attr.string(default='', doc=None, mandatory=False, values=[])Cria um esquema para um atributo string.
Parâmetros
Parâmetro | Descrição |
---|---|
default
|
string; or NativeComputedDefault ;
default = ''Um valor padrão a ser usado se nenhum valor para esse atributo for fornecido ao instanciar a regra. |
doc
|
string; or None ;
default = NoneUma descrição do atributo que pode ser extraída pelas ferramentas de geração de documentação. |
mandatory
|
default = False Se verdadeiro, o valor precisará ser especificado explicitamente (mesmo que tenha default ).
|
values
|
sequence of strings ;
default = []A lista de valores permitidos para o atributo. Um erro será gerado se outros valores forem fornecidos. |
string_dict
Attribute attr.string_dict(allow_empty=True, *, default={}, doc=None, mandatory=False)Cria um esquema para um atributo que contém um dicionário, em que as chaves e os valores são strings.
Parâmetros
Parâmetro | Descrição |
---|---|
allow_empty
|
default = True Verdadeiro se o atributo puder estar vazio. |
default
|
default = {} Um valor padrão a ser usado se nenhum valor para esse atributo for fornecido ao instanciar a regra. |
doc
|
string; or None ;
default = NoneUma descrição do atributo que pode ser extraída pelas ferramentas de geração de documentação. |
mandatory
|
default = False Se verdadeiro, o valor precisará ser especificado explicitamente (mesmo que tenha default ).
|
string_lista
Attribute attr.string_list(mandatory=False, allow_empty=True, *, default=[], doc=None)Cria um esquema para um atributo de lista de strings.
Parâmetros
Parâmetro | Descrição |
---|---|
mandatory
|
default = False Se verdadeiro, o valor precisará ser especificado explicitamente (mesmo que tenha default ).
|
allow_empty
|
default = True Verdadeiro se o atributo puder estar vazio. |
default
|
sequence of strings; or NativeComputedDefault ;
default = []Um valor padrão a ser usado se nenhum valor para esse atributo for fornecido ao instanciar a regra. |
doc
|
string; or None ;
default = NoneUma descrição do atributo que pode ser extraída pelas ferramentas de geração de documentação. |
string_list_dict
Attribute attr.string_list_dict(allow_empty=True, *, default={}, doc=None, mandatory=False)Cria um esquema para um atributo que contém um dicionário, em que as chaves são strings e os valores são listas de strings.
Parâmetros
Parâmetro | Descrição |
---|---|
allow_empty
|
default = True Verdadeiro se o atributo puder estar vazio. |
default
|
default = {} Um valor padrão a ser usado se nenhum valor para esse atributo for fornecido ao instanciar a regra. |
doc
|
string; or None ;
default = NoneUma descrição do atributo que pode ser extraída pelas ferramentas de geração de documentação. |
mandatory
|
default = False Se verdadeiro, o valor precisará ser especificado explicitamente (mesmo que tenha default ).
|