É um módulo de nível superior para definir os esquemas de atributos de uma regra ou aspecto. Cada função retorna um objeto que representa o esquema de um único atributo. Esses objetos são usados como os valores do argumento do dicionário attrs
de rule()
e aspect()
.
Consulte a página "Regras" para mais informações sobre como definir e usar atributos.
Membros
- bool
- int
- int_list
- label
- label_keyed_string_dict
- label_list
- resultado
- output_list
- string
- string_dict
- string_list
- string_list_dict
bool
Attribute attr.bool(configurable=unbound, 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 |
---|---|
configurable
|
bool; ou ilimitados;
o padrão é unbound Esse argumento só pode ser especificado para um atributo de uma macro simbólica. Se Para um atributo de uma regra ou aspecto, |
default
|
bool;
o padrão é False Um valor padrão a ser usado se nenhum valor para esse atributo for fornecido ao instanciar a regra. |
doc
|
string; ou None
o padrão é None Uma descrição do atributo que pode ser extraída por ferramentas de geração de documentação. |
mandatory
|
bool;
o padrão é False Se verdadeiro, o valor precisa ser especificado explicitamente, mesmo que tenha um default .
|
int
Attribute attr.int(configurable=unbound, default=0, doc=None, mandatory=False, values=[])Cria um esquema para um atributo de número 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 |
---|---|
configurable
|
bool; ou ilimitados;
o padrão é unbound Esse argumento só pode ser especificado para um atributo de uma macro simbólica. Se Para um atributo de uma regra ou aspecto, |
default
|
int;
o padrão é 0 Um valor padrão a ser usado se nenhum valor para esse atributo for fornecido ao instanciar a regra. |
doc
|
string; ou None
o padrão é None Uma descrição do atributo que pode ser extraída por ferramentas de geração de documentação. |
mandatory
|
bool;
o padrão é False Se verdadeiro, o valor precisa ser especificado explicitamente, mesmo que tenha um default .
|
values
|
sequência de ints
o padrão é [] Lista de valores permitidos para o atributo. Um erro será gerado se outro valor for fornecido. |
int_list
Attribute attr.int_list(mandatory=False, allow_empty=True, *, configurable=unbound, 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
|
bool;
o padrão é False Se verdadeiro, o valor precisa ser especificado explicitamente, mesmo que tenha um default .
|
allow_empty
|
bool;
o padrão é True Verdadeiro se o atributo puder estar vazio. |
configurable
|
bool; ou ilimitados;
o padrão é unbound Esse argumento só pode ser especificado para um atributo de uma macro simbólica. Se Para um atributo de uma regra ou aspecto, |
default
|
sequência de ints
o padrão é [] Um valor padrão a ser usado se nenhum valor para esse atributo for fornecido ao instanciar a regra. |
doc
|
string; ou None
o padrão é None Uma descrição do atributo que pode ser extraída por ferramentas de geração de documentação. |
o rótulo.
Attribute attr.label(configurable=unbound, default=None, doc=None, executable=False, allow_files=None, allow_single_file=None, mandatory=False, skip_validations=False, providers=[], allow_rules=None, cfg=None, aspects=[], flags=[])
Cria um esquema para um atributo de rótulo. Esse é um atributo de dependência.
Esse atributo contém valores Label
exclusivos. 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 de destino instanciado.
No momento da análise (dentro da 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, como um compilador. Essas ferramentas são consideradas dependências, assim como os arquivos de origem. Para evitar exigir 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 você também quiser impedir que os usuários substituam esse padrão, torne o atributo privado atribuindo um nome que comece com um sublinhado. Consulte a página Regras para mais informações.
Parâmetros
Parâmetro | Descrição |
---|---|
configurable
|
bool; ou ilimitados;
o padrão é unbound Esse argumento só pode ser especificado para um atributo de uma macro simbólica. Se Para um atributo de uma regra ou aspecto, |
default
|
Rótulo ou string ou LateBoundDefault; ou NativeComputedDefault, ou função ou None ;
o padrão é None Um 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; ou None
o padrão é None Uma descrição do atributo que pode ser extraída por ferramentas de geração de documentação. |
executable
|
bool;
o padrão é False Verdadeiro se a dependência precisar ser executável. Isso significa que o rótulo precisa se referir a um arquivo executável ou a uma regra que gere um arquivo executável. Acesse o marcador com ctx.executable.<attribute_name> .
|
allow_files
|
bool; ou Sequence de stringss ou None ;
o padrão é None Define se as segmentações File são permitidas. Pode ser True , False (padrão) ou uma lista de extensões de arquivo permitidas (por exemplo, [".cc", ".cpp"] ).
|
allow_single_file
|
o padrão é None Esse processo é semelhante a allow_files , com a restrição de que o rótulo precisa corresponder a um único File. Acesse o recurso pelo ctx.file.<attribute_name> .
|
mandatory
|
bool;
o padrão é False Se verdadeiro, o valor precisa ser especificado explicitamente, mesmo que tenha um default .
|
skip_validations
|
bool;
o padrão é False Se verdadeiro, as ações de validação das dependências transitivas desse atributo não serão executadas. Essa é uma mitigação temporária e será removida no futuro. |
providers
|
sequência
o padrão é [] Os provedores que precisam ser fornecidos por qualquer dependência que apareça nesse atributo. O formato desse argumento é uma lista de listas de provedores: objetos |
allow_rules
|
sequência de strings ou None ;
o padrão é None Quais segmentações de regras (nomes das classes) são permitidas. Isso foi descontinuado (mantido apenas para compatibilidade). Em vez disso, use provedores. |
cfg
|
o padrão é None Configuração do atributo. Pode ser "exec" , que indica que a dependência foi criada para o execution platform , ou "target" , que indica que a dependência foi criada para o 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á necessário se executable for verdadeiro para evitar a criação acidental de ferramentas de host na configuração de destino. A "target" não tem efeito semântico. Portanto, não a defina quando executable for falsa, a menos que isso realmente ajude a esclarecer suas intenções.
|
aspects
|
sequência de aspectos;
o padrão é [] Aspectos que precisam ser aplicados à dependência ou às dependências especificadas por esse atributo. |
flags
|
sequência de strings
o padrão é [] Obsoleto e será removido. |
label_keyed_string_dict
Attribute attr.label_keyed_string_dict(allow_empty=True, *, configurable=unbound, 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, no qual as chaves são rótulos e os valores são strings. Esse é um atributo de dependência.
Esse atributo contém valores Label
exclusivos. 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 de destino instanciado.
No momento da análise (dentro da 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
|
bool;
o padrão é True Verdadeiro se o atributo puder estar vazio. |
configurable
|
bool; ou ilimitados;
o padrão é unbound Esse argumento só pode ser especificado para um atributo de uma macro simbólica. Se Para um atributo de uma regra ou aspecto, |
default
|
dict; ou função
o padrão é {} 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; ou None
o padrão é None Uma descrição do atributo que pode ser extraída por ferramentas de geração de documentação. |
allow_files
|
bool; ou Sequence de stringss ou None ;
o padrão é None Define se as segmentações File são permitidas. Pode ser True , False (padrão) ou uma lista de extensões de arquivo permitidas (por exemplo, [".cc", ".cpp"] ).
|
allow_rules
|
sequência de strings ou None ;
o padrão é None Quais segmentações de regras (nomes das classes) são permitidas. Isso foi descontinuado (mantido apenas para compatibilidade). Em vez disso, use provedores. |
providers
|
sequência
o padrão é [] Os provedores que precisam ser fornecidos por qualquer dependência que apareça nesse atributo. O formato desse argumento é uma lista de listas de provedores: objetos |
flags
|
sequência de strings
o padrão é [] Obsoleto e será removido. |
mandatory
|
bool;
o padrão é False Se verdadeiro, o valor precisa ser especificado explicitamente, mesmo que tenha um default .
|
cfg
|
o padrão é None Configuração do atributo. Pode ser "exec" , que indica que a dependência foi criada para o execution platform , ou "target" , que indica que a dependência foi criada para o 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
|
sequência de aspectos;
o padrão é [] Aspectos que precisam ser aplicados à dependência ou às dependências especificadas por esse atributo. |
label_list
Attribute attr.label_list(allow_empty=True, *, configurable=unbound, default=[], doc=None, allow_files=None, allow_rules=None, providers=[], flags=[], mandatory=False, skip_validations=False, cfg=None, aspects=[])
Cria um esquema para um atributo de lista de rótulos. Esse é um atributo de dependência. O atributo ctx.attr
correspondente será do tipo lista de Target
s.
Esse atributo contém valores Label
exclusivos. 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 de destino instanciado.
No momento da análise (dentro da 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
|
bool;
o padrão é True Verdadeiro se o atributo puder estar vazio. |
configurable
|
bool; ou ilimitados;
o padrão é unbound Esse argumento só pode ser especificado para um atributo de uma macro simbólica. Se Para um atributo de uma regra ou aspecto, |
default
|
sequência de rótulos; ou função
o padrão é [] Um valor padrão a ser usado se nenhum valor for fornecido para esse atributo 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; ou None
o padrão é None Uma descrição do atributo que pode ser extraída por ferramentas de geração de documentação. |
allow_files
|
bool; ou Sequence de stringss ou None ;
o padrão é None Define se as segmentações File são permitidas. Pode ser True , False (padrão) ou uma lista de extensões de arquivo permitidas (por exemplo, [".cc", ".cpp"] ).
|
allow_rules
|
sequência de strings ou None ;
o padrão é None Quais segmentações de regras (nomes das classes) são permitidas. Isso foi descontinuado (mantido apenas para compatibilidade). Em vez disso, use provedores. |
providers
|
sequência
o padrão é [] Os provedores que precisam ser fornecidos por qualquer dependência que apareça nesse atributo. O formato desse argumento é uma lista de listas de provedores: objetos |
flags
|
sequência de strings
o padrão é [] Obsoleto e será removido. |
mandatory
|
bool;
o padrão é False Se verdadeiro, o valor precisa ser especificado explicitamente, mesmo que tenha um default .
|
skip_validations
|
bool;
o padrão é False Se verdadeiro, as ações de validação das dependências transitivas desse atributo não serão executadas. Essa é uma mitigação temporária e será removida no futuro. |
cfg
|
o padrão é None Configuração do atributo. Pode ser "exec" , que indica que a dependência foi criada para o execution platform , ou "target" , que indica que a dependência foi criada para o 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
|
sequência de aspectos;
o padrão é [] Aspectos que precisam ser aplicados à dependência ou às dependências especificadas por esse atributo. |
output
Attribute attr.output(doc=None, mandatory=False)
Cria um esquema para um atributo de saída (rótulo).
Esse atributo contém valores Label
exclusivos. 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 de destino instanciado.
No momento da análise, o File
correspondente pode ser recuperado usando ctx.outputs
.
Parâmetros
Parâmetro | Descrição |
---|---|
doc
|
string; ou None
o padrão é None Uma descrição do atributo que pode ser extraída por ferramentas de geração de documentação. |
mandatory
|
bool;
o padrão é False Se verdadeiro, o valor precisa ser especificado explicitamente, mesmo que tenha um default .
|
output_list
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 Label
exclusivos. 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 de destino instanciado.
No momento da análise, o File
correspondente pode ser recuperado usando ctx.outputs
.
Parâmetros
Parâmetro | Descrição |
---|---|
allow_empty
|
bool;
o padrão é True Verdadeiro se o atributo puder estar vazio. |
doc
|
string; ou None
o padrão é None Uma descrição do atributo que pode ser extraída por ferramentas de geração de documentação. |
mandatory
|
bool;
o padrão é False Se verdadeiro, o valor precisa ser especificado explicitamente, mesmo que tenha um default .
|
string
Attribute attr.string(configurable=unbound, default='', doc=None, mandatory=False, values=[])Cria um esquema para um atributo string.
Parâmetros
Parâmetro | Descrição |
---|---|
configurable
|
bool; ou ilimitados;
o padrão é unbound Esse argumento só pode ser especificado para um atributo de uma macro simbólica. Se Para um atributo de uma regra ou aspecto, |
default
|
string; ou NativeComputedDefault,
o padrão é '' Um valor padrão a ser usado se nenhum valor para esse atributo for fornecido ao instanciar a regra. |
doc
|
string; ou None
o padrão é None Uma descrição do atributo que pode ser extraída por ferramentas de geração de documentação. |
mandatory
|
bool;
o padrão é False Se verdadeiro, o valor precisa ser especificado explicitamente, mesmo que tenha um default .
|
values
|
sequência de strings
o padrão é [] Lista de valores permitidos para o atributo. Um erro será gerado se outro valor for fornecido. |
string_dict
Attribute attr.string_dict(allow_empty=True, *, configurable=unbound, default={}, doc=None, mandatory=False)Cria um esquema para um atributo contendo um dicionário em que as chaves e os valores são strings.
Parâmetros
Parâmetro | Descrição |
---|---|
allow_empty
|
bool;
o padrão é True Verdadeiro se o atributo puder estar vazio. |
configurable
|
bool; ou ilimitados;
o padrão é unbound Esse argumento só pode ser especificado para um atributo de uma macro simbólica. Se Para um atributo de uma regra ou aspecto, |
default
|
dict;
o padrão é {} Um valor padrão a ser usado se nenhum valor para esse atributo for fornecido ao instanciar a regra. |
doc
|
string; ou None
o padrão é None Uma descrição do atributo que pode ser extraída por ferramentas de geração de documentação. |
mandatory
|
bool;
o padrão é False Se verdadeiro, o valor precisa ser especificado explicitamente, mesmo que tenha um default .
|
string_list
Attribute attr.string_list(mandatory=False, allow_empty=True, *, configurable=unbound, default=[], doc=None)Cria um esquema para um atributo de lista de strings.
Parâmetros
Parâmetro | Descrição |
---|---|
mandatory
|
bool;
o padrão é False Se verdadeiro, o valor precisa ser especificado explicitamente, mesmo que tenha um default .
|
allow_empty
|
bool;
o padrão é True Verdadeiro se o atributo puder estar vazio. |
configurable
|
bool; ou ilimitados;
o padrão é unbound Esse argumento só pode ser especificado para um atributo de uma macro simbólica. Se Para um atributo de uma regra ou aspecto, |
default
|
sequência de strings ou NativeComputedDefault,
o padrão é [] Um valor padrão a ser usado se nenhum valor para esse atributo for fornecido ao instanciar a regra. |
doc
|
string; ou None
o padrão é None Uma descrição do atributo que pode ser extraída por ferramentas de geração de documentação. |
string_list_dict
Attribute attr.string_list_dict(allow_empty=True, *, configurable=unbound, 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
|
bool;
o padrão é True Verdadeiro se o atributo puder estar vazio. |
configurable
|
bool; ou ilimitados;
o padrão é unbound Esse argumento só pode ser especificado para um atributo de uma macro simbólica. Se Para um atributo de uma regra ou aspecto, |
default
|
dict;
o padrão é {} Um valor padrão a ser usado se nenhum valor para esse atributo for fornecido ao instanciar a regra. |
doc
|
string; ou None
o padrão é None Uma descrição do atributo que pode ser extraída por ferramentas de geração de documentação. |
mandatory
|
bool;
o padrão é False Se verdadeiro, o valor precisa ser especificado explicitamente, mesmo que tenha um default .
|