这是一个顶级模块,用于定义规则或方面属性架构。每个函数都会返回一个对象,表示单个属性的架构。这些对象会用作 rule()
和 aspect()
的 attrs
字典参数的值。
成员
- bool
- int
- int_list
- 标签
- label_keyed_string_dict
- label_list
- 输出
- output_list
- 字符串
- string_dict
- string_list
- string_list_dict
bool
Attribute attr.bool(default=False, doc=None, mandatory=False)
ctx.attr
属性的类型为 bool
。
参数
参数 | 说明 |
---|---|
default
|
default 是 False 在实例化规则时,如果没有为此属性提供任何值,则要使用的默认值。 |
doc
|
string;或 None ;默认值为 None 可由文档生成工具提取的属性的说明。 |
mandatory
|
默认值为 False 如果为 true,则必须明确指定值(即使它具有 default )。
|
int
Attribute attr.int(default=0, doc=None, mandatory=False, values=[])
ctx.attr
属性将为 int
类型。
参数
参数 | 说明 |
---|---|
default
|
default 是 0 在实例化规则时,如果没有为此属性提供任何值,则要使用的默认值。 |
doc
|
字符串;或 None ;
默认为 None 可由文档生成工具提取的属性说明。 |
mandatory
|
默认值为 False 如果为 true,则必须明确指定该值(即使该值为 default )。
|
values
|
int 类型的 sequence;默认值为 [] 属性允许使用的值的列表。如果指定了任何其他值,则会引发错误。 |
int_list
Attribute attr.int_list(mandatory=False, allow_empty=True, *, default=[], doc=None)
参数
参数 | 说明 |
---|---|
mandatory
|
默认值为 False 如果为 true,则必须明确指定值(即使它具有 default )。
|
allow_empty
|
默认值为 True 如果属性可以为空,则为 true。 |
default
|
int 的序列;
默认为 [] 如果在实例化规则时未为此属性指定值,则使用此默认值。 |
doc
|
字符串;或 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
|
Label、string、LateBoundDefault、NativeComputedDefault、function;或 None ;默认值为 None 在实例化规则时,如果未为此属性提供任何值,则要使用的默认值。请使用字符串或 Label 函数指定默认值,例如 attr.label(default = "//a:b") 。
|
doc
|
string;或 None ;默认值为 None 可由文档生成工具提取的属性的说明。 |
executable
|
默认值为 False 如果依赖项必须可执行,则值为 True。这意味着标签必须引用可执行文件,或者引用输出可执行文件的规则。使用 ctx.executable.<attribute_name> 访问标签。 |
allow_files
|
布尔值;或字符串的序列;或 None ;
默认为 None 是否允许 File 目标。可以是 True 、False (默认)或允许的文件扩展名列表(例如 [".cc", ".cpp"] )。
|
allow_single_file
|
默认值为 None 这与 allow_files 类似,但不同之处在于标签必须对应于单个 File。通过 ctx.file.<attribute_name> 访问它。
|
mandatory
|
默认值为 False 如果为 true,则必须明确指定值(即使它具有 default )。
|
providers
|
默认值为 [] 此属性中显示的任何依赖项都必须提供的提供程序。 此参数的格式为提供程序列表的列表,即 |
allow_rules
|
字符串的序列;或 None ;
默认为 None 允许的规则目标(类的名称)。此方法已废弃(仅出于兼容性目的而保留),请改用提供程序。 |
cfg
|
默认值为 None 配置。它可以是 "exec" ,表示依赖项是为 execution platform 构建的,也可以是 "target" ,表示依赖项是为 target platform 构建的。一个典型的区别示例是,在构建移动应用时,target platform 为 Android 或 iOS ,而 execution platform 为 Linux 、macOS 或 Windows 。如果 executable 为 True,则必须使用此参数,以防止在目标配置中意外构建主机工具。"target" 没有语义影响,因此当 executable 为 False 时,除非它确实有助于阐明您的意图,否则请不要设置它。 |
aspects
|
Aspect 的序列;默认为 [] 应应用于此属性指定的依赖项的 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;或 function;默认值为 {} 在实例化规则时,如果未为此属性提供任何值,则要使用的默认值。请使用字符串或 Label 函数指定默认值,例如 attr.label_keyed_string_dict(default = {"//a:b": "value", "//a:c": "string"}) 。
|
doc
|
string;或 None ;默认值为 None 可由文档生成工具提取的属性的说明。 |
allow_files
|
布尔值;或字符串的序列;或 None ;
默认为 None 是否允许 File 目标。可以是 True 、False (默认值)或允许的文件扩展名列表(例如 [".cc", ".cpp"] )。
|
allow_rules
|
string 的序列;或 None ;默认值为 None 允许哪个规则目标(类的名称)。此方法已废弃(仅出于兼容性目的而保留),请改用提供程序。 |
providers
|
默认值为 [] 此属性中出现的依赖项必须由其提供的提供程序。 此参数的格式为提供程序列表的列表,即 |
flags
|
字符串的序列;默认为 [] 已废弃,将被移除。 |
mandatory
|
默认值为 False 如果为 true,则必须明确指定值(即使它具有 default )。
|
cfg
|
默认值为 None 配置。它可以是 "exec" (表示依赖项是针对 execution platform 构建的),也可以是 "target" (表示依赖项是针对 target platform 构建的)。一个典型的区别示例是,在构建移动应用时,target platform 为 Android 或 iOS ,而 execution platform 为 Linux 、macOS 或 Windows 。
|
aspects
|
Aspect 的序列;默认为 [] 应应用于此属性指定的依赖项的 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
属性的类型为 Target
列表。
此属性包含唯一的 Label
值。如果提供字符串来替代 Label
,系统会使用标签构造函数进行转换。标签路径的相对部分(包括可能已重命名的代码库)会相对于实例化的目标的软件包进行解析。
在分析时(在规则的实现函数内),从 ctx.attr
检索属性值时,标签会被相应的 Target
替换。这样,您就可以访问当前目标的依赖项的提供程序。
参数
参数 | 说明 |
---|---|
allow_empty
|
默认值为 True 如果属性可以为空,则返回 True。 |
default
|
标签或函数的序列;默认值为 [] 在实例化规则时,如果没有为此属性提供任何值,则要使用的默认值。请使用字符串或 Label 函数指定默认值,例如 attr.label_list(default = ["//a:b", "//a:c"]) 。 |
doc
|
字符串;或 None ;
默认为 None 可由文档生成工具提取的属性说明。 |
allow_files
|
布尔值;或字符串的序列;或 None ;
默认为 None 是否允许 File 目标。可以是 True 、False (默认)或允许的文件扩展名列表(例如 [".cc", ".cpp"] )。
|
allow_rules
|
string 的序列;或 None ;默认值为 None 允许哪个规则目标(类的名称)。此属性已废弃(仅出于兼容性考虑),请改用提供程序。 |
providers
|
默认值为 [] 此属性中出现的依赖项必须由其提供的提供程序。 此参数的格式为提供程序列表的列表,即 |
flags
|
字符串的序列;默认为 [] 已废弃,将被移除。 |
mandatory
|
默认值为 False 如果为 true,则必须明确指定值(即使它具有 default )。
|
cfg
|
默认值为 None 属性的配置。它可以是 "exec" (表示依赖项是针对 execution platform 构建的),也可以是 "target" (表示依赖项是针对 target platform 构建的)。一个典型的区别示例是,在构建移动应用时,target platform 为 Android 或 iOS ,而 execution platform 为 Linux 、macOS 或 Windows 。
|
aspects
|
Aspect 的序列;默认为 [] 应应用于此属性指定的依赖项的 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 )。
|
字符串
Attribute attr.string(default='', doc=None, mandatory=False, values=[])
参数
参数 | 说明 |
---|---|
default
|
string;或 NativeComputedDefault;默认值为 '' 在实例化规则时,如果未为此属性提供任何值,将使用默认值。 |
doc
|
字符串;或 None ;
默认为 None 可由文档生成工具提取的属性说明。 |
mandatory
|
默认值为 False 如果值为 true,则必须明确指定值(即使该值为 default )。
|
values
|
string 的 sequence;默认值为 [] 属性允许使用的值的列表。如果指定了任何其他值,则会引发错误。 |
string_dict
Attribute attr.string_dict(allow_empty=True, *, default={}, doc=None, mandatory=False)
参数
参数 | 说明 |
---|---|
allow_empty
|
默认值为 True 如果属性可以为空,则为 true。 |
default
|
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
|
default 是 {} 在实例化规则时,如果没有为此属性提供任何值,则要使用的默认值。 |
doc
|
string;或 None ;默认值为 None 可由文档生成工具提取的属性的说明。 |
mandatory
|
默认值为 False 如果为 true,则必须明确指定该值(即使该值为 default )。
|