属性

报告问题 查看源代码

这是一个顶级模块,用于定义规则或切面的属性架构。每个函数都会返回一个对象,表示单个属性的架构。这些对象用作 rule()aspect()attrs 字典参数的值。

如需详细了解如何定义使用属性,请参阅“规则”页面。

成员

bool

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

为布尔值属性创建架构。对应的 ctx.attr 属性的类型为 bool

参数

参数 说明
default 默认值为 False
在实例化规则时,如果未为此属性指定值,则使用默认值。
doc string;或 None;默认值为 None
可以由文档生成工具提取的属性说明。
mandatory 默认值为 False
如果值为 true,则必须明确指定该值(即使该值具有 default 也是如此)。

int

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

为整数属性创建架构。值必须在有符号的 32 位范围内。对应的 ctx.attr 属性的类型为 int

参数

参数 说明
default 默认值为 0
在实例化规则时,如果未为此属性指定值,则使用默认值。
doc string;或 None;默认值为 None
可以由文档生成工具提取的属性说明。
mandatory 默认值为 False
如果值为 true,则必须明确指定该值(即使该值具有 default 也是如此)。
values int 的序列;默认值为 []
属性允许使用的值的列表。如果指定任何其他值,则会引发错误。

int_list

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

为整数列表属性创建架构。每个元素都必须在有符号的 32 位范围内。

参数

参数 说明
mandatory 默认值为 False
如果值为 true,则必须明确指定该值(即使该值具有 default 也是如此)。
allow_empty 默认值为 True
如果属性可以为空,则为 true。
default 序列(共 ints);默认值为[]
在实例化规则时未指定此属性的值时使用的默认值。
doc string;或 None;默认值为 None
可以由文档生成工具提取的属性说明。

标签

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=[])

为标签属性创建架构。这是一个依赖项属性。

此属性包含唯一的 Label 值。如果提供了字符串来代替 Label,则将使用标签构造函数进行转换。标签路径的相对部分(包括代码库(可能更名))会根据实例化的目标的软件包进行解析。

在分析时(在规则的实现函数内),从 ctx.attr 检索属性值时,标签将被替换为相应的 Target。这样,您就可以访问当前目标依赖项的提供程序。

除了普通的源文件之外,这种属性通常也用于指代工具,例如编译器。与源文件一样,此类工具也被视为依赖项。为避免在每次用户在 BUILD 文件中使用规则时都要求用户指定该工具的标签,您可以将规范工具的标签硬编码为此属性的 default 值。如果您还想阻止用户覆盖此默认设置,则可将该属性设为不公开,只需为其指定以下划线开头的名称即可。如需了解详情,请参阅规则页面。

参数

参数 说明
default Labelstring;或 LateBoundDefault;或 NativeComputedDefault;或 function;或 None; 默认值为 None
在实例化规则时未指定此属性的值时要使用的默认值。使用字符串或 Label 函数指定默认值,例如 attr.label(default = "//a:b")
doc string;或 None;默认值为 None
可以由文档生成工具提取的属性说明。
executable 默认值为 False
如果依赖项必须可执行,则为 true。也就是说,标签必须引用可执行文件或输出可执行文件的规则。使用 ctx.executable.<attribute_name> 访问标签。
allow_files bool;或字符串序列;或 None;默认值为 None
是否允许使用 File 目标。可以是 TrueFalse(默认),也可以是允许使用的文件扩展名列表(例如 [".cc", ".cpp"])。
allow_single_file 默认值为 None
类似于 allow_files,但标签必须对应于单个 File。可通过 ctx.file.<attribute_name> 访问它。
mandatory 默认值为 False
如果值为 true,则必须明确指定该值(即使该值具有 default 也是如此)。
providers 默认值为 []
此属性中出现的任何依赖项都必须提供的提供程序。

此参数的格式是提供程序列表,即由 provider() 返回的 *Info 对象(如果是旧版提供程序,则为其字符串名称)。依赖项必须返回至少一个内部列表中提到的所有提供程序。为方便起见,该参数也可能是单级提供程序列表,在这种情况下,该参数会封装在带有一个元素的外部列表中。依赖项规则并非要求在其 provides 参数中通告这些提供程序,但这被视为最佳实践。

allow_rules string 组成的序列;或 None;默认值为 None
允许使用哪些规则目标(类的名称)。此 API 已废弃(仅用于确保兼容性),请改用提供程序。
cfg 默认值为 None
属性的配置。它可以是 "exec"(表示依赖项是针对 execution platform 构建的)或 "target"(表示依赖项是为 target platform 构建的)。这种差异的一个典型示例是构建移动应用时,target platformAndroidiOS,而 execution platformLinuxmacOSWindows。如果 executable 为 True,则必须使用此参数,以防止在目标配置中意外构建主机工具。"target" 没有语义影响,因此当 executable 为 False 时不要设置该属性,除非这确实有助于确认您的意图。
aspects Aspect 的序列;默认值为 []
应应用于此属性指定的一个或多个依赖项的方面。

label_keyed_string_dict

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=[])

为保存字典的属性创建架构,其中键是标签,值是字符串。这是一个依赖项属性。

此属性包含唯一的 Label 值。如果提供了字符串来代替 Label,则将使用标签构造函数进行转换。标签路径的相对部分(包括代码库(可能更名))会根据实例化的目标的软件包进行解析。

在分析时(在规则的实现函数内),从 ctx.attr 检索属性值时,标签将被替换为相应的 Target。这样,您就可以访问当前目标依赖项的提供程序。

参数

参数 说明
allow_empty 默认值为 True
如果属性可以为空,则为 true。
default dict;或函数;默认值为 {}
如果在实例化规则时未提供此属性的值,则使用默认值。使用字符串或 Label 函数指定默认值,例如 attr.label_keyed_string_dict(default = {"//a:b": "value", "//a:c": "string"})
doc string;或 None;默认值为 None
可以由文档生成工具提取的属性说明。
allow_files bool;或字符串序列;或 None;默认值为 None
是否允许使用 File 目标。可以是 TrueFalse(默认),也可以是允许使用的文件扩展名列表(例如 [".cc", ".cpp"])。
allow_rules string 组成的序列;或 None;默认值为 None
允许使用哪些规则目标(类的名称)。此 API 已废弃(仅用于确保兼容性),请改用提供程序。
providers 默认值为 []
此属性中出现的任何依赖项都必须提供的提供程序。

此参数的格式是提供程序列表,即由 provider() 返回的 *Info 对象(如果是旧版提供程序,则为其字符串名称)。依赖项必须返回至少一个内部列表中提到的所有提供程序。为方便起见,该参数也可能是单级提供程序列表,在这种情况下,该参数会封装在带有一个元素的外部列表中。依赖项规则并非要求在其 provides 参数中通告这些提供程序,但这被视为最佳实践。

flags string 序列;默认值为 []
已弃用,将被移除。
mandatory 默认值为 False
如果值为 true,则必须明确指定该值(即使该值具有 default 也是如此)。
cfg 默认值为 None
属性的配置。它可以是 "exec"(表示依赖项是针对 execution platform 构建的)或 "target"(表示依赖项是为 target platform 构建的)。这种差异的一个典型示例是构建移动应用时,target platformAndroidiOS,而 execution platformLinuxmacOSWindows
aspects Aspect 的序列;默认值为 []
应应用于此属性指定的一个或多个依赖项的方面。

label_list

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

为标签列表属性创建架构。这是一个依赖项属性。对应的 ctx.attr 属性的类型为 list,共 Target

此属性包含唯一的 Label 值。如果提供了字符串来代替 Label,则将使用标签构造函数进行转换。标签路径的相对部分(包括代码库(可能更名))会根据实例化的目标的软件包进行解析。

在分析时(在规则的实现函数内),从 ctx.attr 检索属性值时,标签将被替换为相应的 Target。这样,您就可以访问当前目标依赖项的提供程序。

参数

参数 说明
allow_empty 默认值为 True
如果属性可以为空,则为 true。
default 标签序列;或函数;默认值为 []
在实例化规则时,如果未为此属性指定任何值,则使用默认值。使用字符串或 Label 函数指定默认值,例如 attr.label_list(default = ["//a:b", "//a:c"])
doc string;或 None;默认值为 None
可以由文档生成工具提取的属性说明。
allow_files bool;或字符串序列;或 None;默认值为 None
是否允许使用 File 目标。可以是 TrueFalse(默认),也可以是允许使用的文件扩展名列表(例如 [".cc", ".cpp"])。
allow_rules string 组成的序列;或 None;默认值为 None
允许使用哪些规则目标(类的名称)。此 API 已废弃(仅用于确保兼容性),请改用提供程序。
providers 默认值为 []
此属性中出现的任何依赖项都必须提供的提供程序。

此参数的格式是提供程序列表,即由 provider() 返回的 *Info 对象(如果是旧版提供程序,则为其字符串名称)。依赖项必须返回至少一个内部列表中提到的所有提供程序。为方便起见,该参数也可能是单级提供程序列表,在这种情况下,该参数会封装在带有一个元素的外部列表中。依赖项规则并非要求在其 provides 参数中通告这些提供程序,但这被视为最佳实践。

flags string 序列;默认值为 []
已弃用,将被移除。
mandatory 默认值为 False
如果值为 true,则必须明确指定该值(即使该值具有 default 也是如此)。
cfg 默认值为 None
属性的配置。它可以是 "exec"(表示依赖项是针对 execution platform 构建的)或 "target"(表示依赖项是为 target platform 构建的)。这种差异的一个典型示例是构建移动应用时,target platformAndroidiOS,而 execution platformLinuxmacOSWindows
aspects Aspect 的序列;默认值为 []
应应用于此属性指定的一个或多个依赖项的方面。

output

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

为输出(标签)属性创建架构。

此属性包含唯一的 Label 值。如果提供了字符串来代替 Label,则将使用标签构造函数进行转换。标签路径的相对部分(包括代码库(可能更名))会根据实例化的目标的软件包进行解析。

在分析时,可以使用 ctx.outputs 检索相应的 File

参数

参数 说明
doc string;或 None;默认值为 None
可以由文档生成工具提取的属性说明。
mandatory 默认值为 False
如果值为 true,则必须明确指定该值(即使该值具有 default 也是如此)。

output_list

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

为输出列表属性创建架构。

此属性包含唯一的 Label 值。如果提供了字符串来代替 Label,则将使用标签构造函数进行转换。标签路径的相对部分(包括代码库(可能更名))会根据实例化的目标的软件包进行解析。

在分析时,可以使用 ctx.outputs 检索相应的 File

参数

参数 说明
allow_empty 默认值为 True
如果属性可以为空,则为 true。
doc string;或 None;默认值为 None
可以由文档生成工具提取的属性说明。
mandatory 默认值为 False
如果值为 true,则必须明确指定该值(即使该值具有 default 也是如此)。

string

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

string 属性创建架构。

参数

参数 说明
default string;或 NativeComputedDefault;默认值为 ''
在实例化规则时未指定此属性的值时使用的默认值。
doc string;或 None;默认值为 None
可以由文档生成工具提取的属性说明。
mandatory 默认值为 False
如果值为 true,则必须明确指定该值(即使该值具有 default 也是如此)。
values string序列;默认值为 []
属性的允许值列表。如果指定任何其他值,则会引发错误。

string_dict

Attribute attr.string_dict(allow_empty=True, *, default={}, doc=None, mandatory=False)

为包含字典的属性创建架构,其中键和值是字符串。

参数

参数 说明
allow_empty 默认值为 True
如果属性可以为空,则为 true。
default 默认值为 {}
在实例化规则时,如果未为此属性指定值,则使用默认值。
doc string;或 None;默认值为 None
可以由文档生成工具提取的属性说明。
mandatory 默认值为 False
如果值为 true,则必须明确指定该值(即使该值具有 default 也是如此)。

string_list

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

为字符串列表属性创建架构。

参数

参数 说明
mandatory 默认值为 False
如果值为 true,则必须明确指定该值(即使该值具有 default 也是如此)。
allow_empty 默认值为 True
如果属性可以为空,则为 true。
default 由字符串组成的序列;或 NativeComputedDefault;默认值为 []
如果在实例化规则时未指定此属性的值,则使用默认值。
doc string;或 None;默认值为 None
可以由文档生成工具提取的属性说明。

string_list_dict

Attribute attr.string_list_dict(allow_empty=True, *, default={}, doc=None, mandatory=False)

为保存字典的属性创建架构,其中键为字符串,值为字符串列表。

参数

参数 说明
allow_empty 默认值为 True
如果属性可以为空,则为 true。
default 默认值为 {}
在实例化规则时,如果未为此属性指定值,则使用默认值。
doc string;或 None;默认值为 None
可以由文档生成工具提取的属性说明。
mandatory 默认值为 False
如果值为 true,则必须明确指定该值(即使该值具有 default 也是如此)。