Esta página foi traduzida pela API Cloud Translation.

atribuição

Este é um módulo de nível superior para definir os esquemas de atributos de uma regra ou um 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 saber mais sobre como definir e usar atributos.

bool

Attribute attr.bool(default=False, doc='', mandatory=False)

Cria um esquema para um atributo booleano.

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`	default = '' Uma descrição do atributo que pode ser extraída por ferramentas geradoras de documentação.
`mandatory`	default = False Se verdadeiro, o valor precisa ser especificado explicitamente, mesmo que tenha um `default`.

int

Attribute attr.int(default=0, doc='', mandatory=False, values=[])

Cria um esquema para um atributo de número inteiro. O valor precisa estar no intervalo de 32 bits assinado.

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`	default = '' Uma descrição do atributo que pode ser extraída por ferramentas geradoras de documentação.
`mandatory`	default = False Se verdadeiro, o valor precisa ser especificado explicitamente, mesmo que tenha um `default`.
`values`	`sequence of ints`; default = [] Lista de valores permitidos para o atributo. Um erro será gerado se qualquer outro valor for informado.

int_list

Attribute attr.int_list(mandatory=False, allow_empty=True, *, default=[], doc='')

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 precisa ser especificado explicitamente, mesmo que tenha um `default`.
`allow_empty`	default = True True 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`	default = '' Uma descrição do atributo que pode ser extraída por ferramentas geradoras de documentação.

Identificador

Attribute attr.label(default=None, doc='', 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. 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ótulo. As partes relativas do caminho do marcador, 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 Targets correspondentes. Isso permite acessar os provedores das dependências do destino atual.

Além dos arquivos de origem comuns, esse tipo de atributo geralmente é 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 não exigir que os usuários especifiquem o identificador da ferramenta sempre que usarem a regra nos arquivos BUILD, você pode codificar 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 particular atribuindo a ele um nome que comece com um sublinhado. Veja 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 = 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`	default = '' Uma descrição do atributo que pode ser extraída por ferramentas geradoras de documentação.
`executable`	default = False Verdadeiro se a dependência tiver que ser executável. Isso significa que o rótulo precisa 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`; padrão = None Define se os destinos `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 a `allow_files`, com a restrição de que o rótulo precisa corresponder a um único File. Acesse pelo `ctx.file.<attribute_name>`.
`mandatory`	default = False Se verdadeiro, o valor precisa ser especificado explicitamente, mesmo que tenha um `default`.
`providers`	default = [] São os provedores que precisam ser fornecidos por qualquer dependência exibida nesse atributo. O formato desse argumento é uma lista de listas de provedores: objetos `*Info` retornados por `provider()` (ou, no caso de um provedor legado, o nome da string dele). A dependência precisa retornar TODOS os provedores mencionados em pelo menos UMA das listas internas. Por conveniência, esse argumento também pode ser uma lista de provedores de nível único. Nesse caso, ele é unido em uma lista externa com um elemento.
`allow_rules`	`sequence of strings; or None`; default = None Quais segmentações de regra (nome das classes) são permitidas. Como o uso foi descontinuado (mantido apenas para compatibilidade), use provedores.
`cfg`	default = nenhum Configuração do atributo. Pode ser `"exec"`, que indica que a dependência é criada para o `execution platform`, ou `"target"`, que indica que a dependência é criada para o `target platform`. Um exemplo típico da diferença é na criação de 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. A `"target"` não tem efeito semântico. Portanto, não a defina quando `executable` for falsa, a menos que isso ajude a esclarecer suas intenções.
`aspects`	`sequence of Aspects`; default = [] Aspectos que precisam ser aplicados à dependência ou às dependências especificadas por esse atributo.

label_keyed_string_dict

Attribute attr.label_keyed_string_dict(allow_empty=True, *, default={}, doc='', 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. Esse é um atributo de dependência.

Parâmetros

Parâmetro	Descrição
`allow_empty`	default = True True 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`	default = '' Uma descrição do atributo que pode ser extraída por ferramentas geradoras de documentação.
`allow_files`	`bool; or sequence of strings; or None`; padrão = None Define se os destinos `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 = None Quais segmentações de regra (nome das classes) são permitidas. Como o uso foi descontinuado (mantido apenas para compatibilidade), use provedores.
`providers`	default = [] São os provedores que precisam ser fornecidos por qualquer dependência exibida nesse atributo. O formato desse argumento é uma lista de listas de provedores: objetos `*Info` retornados por `provider()` (ou, no caso de um provedor legado, o nome da string dele). A dependência precisa retornar TODOS os provedores mencionados em pelo menos UMA das listas internas. Por conveniência, esse argumento também pode ser uma lista de provedores de nível único. Nesse caso, ele é unido em uma lista externa com um elemento.
`flags`	`sequence of strings`; default = [] Descontinuado e removido.
`mandatory`	default = False Se verdadeiro, o valor precisa ser especificado explicitamente, mesmo que tenha um `default`.
`cfg`	default = nenhum Configuração do atributo. Pode ser `"exec"`, que indica que a dependência é criada para o `execution platform`, ou `"target"`, que indica que a dependência é criada para o `target platform`. Um exemplo típico da diferença é na criação de 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 à dependência ou às dependências especificadas por esse atributo.

label_list

Attribute attr.label_list(allow_empty=True, *, default=[], doc='', allow_files=None, allow_rules=None, providers=[], flags=[], mandatory=False, cfg=None, aspects=[])

Cria um esquema para um atributo de lista de rótulos. Esse é um atributo de dependência.

Parâmetros

Parâmetro	Descrição
`allow_empty`	default = True True 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`	default = '' Uma descrição do atributo que pode ser extraída por ferramentas geradoras de documentação.
`allow_files`	`bool; or sequence of strings; or None`; padrão = None Define se os destinos `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 = None Quais segmentações de regra (nome das classes) são permitidas. Como o uso foi descontinuado (mantido apenas para compatibilidade), use provedores.
`providers`	default = [] São os provedores que precisam ser fornecidos por qualquer dependência exibida nesse atributo. O formato desse argumento é uma lista de listas de provedores: objetos `*Info` retornados por `provider()` (ou, no caso de um provedor legado, o nome da string dele). A dependência precisa retornar TODOS os provedores mencionados em pelo menos UMA das listas internas. Por conveniência, esse argumento também pode ser uma lista de provedores de nível único. Nesse caso, ele é unido em uma lista externa com um elemento.
`flags`	`sequence of strings`; default = [] Descontinuado e removido.
`mandatory`	default = False Se verdadeiro, o valor precisa ser especificado explicitamente, mesmo que tenha um `default`.
`cfg`	default = nenhum Configuração do atributo. Pode ser `"exec"`, que indica que a dependência é criada para o `execution platform`, ou `"target"`, que indica que a dependência é criada para o `target platform`. Um exemplo típico da diferença é na criação de 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 à dependência ou às dependências especificadas por esse atributo.

saída

Attribute attr.output(doc='', mandatory=False)

Cria um esquema para um atributo de saída (rótulo).

No momento da análise, o File correspondente pode ser recuperado usando ctx.outputs.

Parâmetros

Parâmetro	Descrição
`doc`	default = '' Uma descrição do atributo que pode ser extraída por ferramentas geradoras de documentação.
`mandatory`	default = False Se verdadeiro, o valor precisa ser especificado explicitamente, mesmo que tenha um `default`.

output_list

Attribute attr.output_list(allow_empty=True, *, doc='', mandatory=False)

Cria um esquema para um atributo de lista de saídas.

No momento da análise, o File correspondente pode ser recuperado usando ctx.outputs.

Parâmetros

Parâmetro	Descrição
`allow_empty`	default = True True se o atributo puder estar vazio.
`doc`	default = '' Uma descrição do atributo que pode ser extraída por ferramentas geradoras de documentação.
`mandatory`	default = False Se verdadeiro, o valor precisa ser especificado explicitamente, mesmo que tenha um `default`.

string

Attribute attr.string(default='', doc='', mandatory=False, values=[])

Cria um esquema para um atributo de 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`	default = '' Uma descrição do atributo que pode ser extraída por ferramentas geradoras de documentação.
`mandatory`	default = False Se verdadeiro, o valor precisa ser especificado explicitamente, mesmo que tenha um `default`.
`values`	`sequence of strings`; default = [] Lista de valores permitidos para o atributo. Um erro será gerado se qualquer outro valor for informado.

string_dict

Attribute attr.string_dict(allow_empty=True, *, default={}, doc='', 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 True 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`	default = '' Uma descrição do atributo que pode ser extraída por ferramentas geradoras de documentação.
`mandatory`	default = 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, *, default=[], doc='')

Cria um esquema para um atributo de lista de strings.

Parâmetros

Parâmetro	Descrição
`mandatory`	default = False Se verdadeiro, o valor precisa ser especificado explicitamente, mesmo que tenha um `default`.
`allow_empty`	default = True True 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`	default = '' Uma descrição do atributo que pode ser extraída por ferramentas geradoras de documentação.

string_list_dict

Attribute attr.string_list_dict(allow_empty=True, *, default={}, doc='', 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 True 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`	default = '' Uma descrição do atributo que pode ser extraída por ferramentas geradoras de documentação.
`mandatory`	default = False Se verdadeiro, o valor precisa ser especificado explicitamente, mesmo que tenha um `default`.