支持原生规则和其他软件包辅助函数的内置模块。所有原生规则在此模块中都显示为函数,例如native.cc_library
。请注意,原生模块仅在加载阶段可用(也就是说,对于宏,不适用于规则实施)。属性会忽略 None
值,并将其视为未设置的属性。
您还可以使用以下函数:
成员
- existing_rule
- existing_rules
- exports_files
- glob
- module_name
- module_version
- package_group
- package_name
- package_relative_label
- repository_name
- 子软件包
existing_rule
unknown native.existing_rule(name)
None
。在这里,“类字典的不可变对象”是指支持类似字典的迭代 x
、len(x)
、name in x
、x[name]
、x.get(name)
、x.items()
、x.keys()
和 x.values()
的深度不可变对象。
如果设置了 --noincompatible_existing_rules_immutable_view
标志,则改为返回具有相同内容的新可变字典。
结果包含每个属性的条目,但私有属性(其名称不以字母开头)和一些无法表示的旧版属性类型除外。此外,字典还包含规则实例的 name
和 kind
条目(例如 'cc_binary'
)。
结果的值表示属性值,如下所示:
- str、int 和 bool 类型的属性按原样表示。
- 对于同一软件包中的目标,标签转换为以下形式的字符串:
':foo'
;对于其他软件包中的目标,转换为'//pkg:name'
形式的字符串。 - 列表以元组表示,而字典会转换为新的可变字典。它们的元素以相同的方式进行递归转换。
- 系统会返回
select
值及其内容(如上所述)。 - 未在规则实例化期间指定任何值,并且已计算默认值的属性会从结果中排除。(直到分析阶段才能计算计算出的默认值。)
请尽可能避免使用此函数。这会使 BUILD 文件变得脆弱并且依赖于顺序。另请注意,它与规则属性值的其他两个从内部形式转换为 Starlark 存在细微区别:一个由计算默认值使用,另一个由 ctx.attr.foo
使用。
参数
参数 | 说明 |
---|---|
name
|
必需 目标的名称。 |
existing_rules
unknown native.existing_rules()
existing_rule(name)
将返回的结果。在这里,“类字典的不可变对象”是指支持类似字典的迭代 x
、len(x)
、name in x
、x[name]
、x.get(name)
、x.items()
、x.keys()
和 x.values()
的深度不可变对象。
如果设置了 --noincompatible_existing_rules_immutable_view
标志,则改为返回具有相同内容的新可变字典。
注意:请尽可能避免使用此函数。这会使 BUILD 文件变得脆弱并且依赖于顺序。此外,如果设置了 --noincompatible_existing_rules_immutable_view
标志,此函数的开销可能会很高,尤其是在循环中调用时。
exports_files
None
native.exports_files(srcs, visibility=None, licenses=None)
参数
参数 | 说明 |
---|---|
srcs
|
string 的序列;
必需 要导出的文件的列表。 |
visibility
|
sequence;或 None ;
默认值为 None 可以指定可见性声明。这些文件对指定目标可见。如果未指定可见性,则文件将对每个软件包可见。 |
licenses
|
string 的序列;或 None ;
默认值为 None 要指定的许可。 |
glob
sequence native.glob(include=[], exclude=[], exclude_directories=1, allow_empty=unbound)
- 匹配
include
中的至少一个模式。 - 与
exclude
中的任何模式都不匹配(默认值为[]
)。
exclude_directories
参数已启用(设为 1
),则结果中将忽略类型为“目录”的文件类型(默认为 1
)。
参数
参数 | 说明 |
---|---|
include
|
string 的序列;
默认值为 [] 要包含的 glob 模式的列表。 |
exclude
|
string 的序列;
默认值为 [] 要排除的 glob 模式的列表。 |
exclude_directories
|
默认值为 1 是否排除目录的标志。 |
allow_empty
|
默认值为 unbound 我们是否允许 glob 模式不进行任何匹配。如果 `allow_empty` 为 False,则每个 include 模式必须与某些内容匹配,并且最终结果必须非空(在排除 `exclude` 模式的匹配项之后)。 |
module_name
string native.module_name()
module_ctx.modules
中显示的 module.name
字段相同。
可能会返回 None
。
module_version
string native.module_version()
module_ctx.modules
中显示的 module.version
字段相同。
可能会返回 None
。
package_group
None
native.package_group(name, packages=[], includes=[])
visibility
属性中引用该标签。
参数
参数 | 说明 |
---|---|
name
|
必需 此规则的唯一名称。 |
packages
|
string 的序列;
默认值为 [] 此组中软件包的完整枚举。 |
includes
|
string 的序列;
默认值为 [] 此软件包中包含的其他软件包组。 |
package_name
string native.package_name()
some/package/BUILD
中,其值为 some/package
。如果 BUILD 文件调用 .bzl 文件中定义的函数,package_name()
将与调用方 BUILD 文件软件包匹配。此函数等效于已弃用的变量 PACKAGE_NAME
。
package_relative_label
Label native.package_relative_label(input)
BUILD
文件)的上下文中,将输入字符串转换为 Label 对象。如果输入已经是 Label
,则原样返回。此函数只能在评估 BUILD 文件及其直接或间接调用的宏时调用;例如,不能在规则实施函数中调用该函数。
此函数的结果与通过将给定字符串传递给 BUILD 文件中声明的目标的标签值属性而生成的 Label
值相同。
使用说明:此函数与 Label() 之间的区别在于,Label()
使用的是调用该函数的 .bzl
文件的上下文,而不是 BUILD
文件的软件包。如果您需要引用硬编码到宏中的固定目标(例如编译器),请使用 Label()
。如果您需要将 BUILD 文件提供的标签字符串标准化为 Label
对象,请使用 package_relative_label()
。(除了 BUILD 文件或调用 .bzl 文件外,无法在软件包上下文中将字符串转换为 Label
。因此,外部宏应始终优先将 Label 对象传递给内部宏,而不是标签字符串。)
参数
参数 | 说明 |
---|---|
input
|
string;或标签;
必需 输入标签字符串或标签对象。如果传递了 Label 对象,系统会按原样返回该对象。 |
repository_name
string native.repository_name()
local_repository(name='local', path=...)
调用的软件包中,它将被设置为 @local
。在主代码库的软件包中,此属性将设置为 @
。此函数等效于已弃用的变量 REPOSITORY_NAME
。
子软件包
sequence native.subpackages(include, exclude=[], allow_empty=False)
参数
参数 | 说明 |
---|---|
include
|
string 的序列;
必需 要包含在子软件包扫描中的 glob 模式的列表。 |
exclude
|
string 的序列;
默认值为 [] 要从子软件包扫描中排除的 glob 模式列表。 |
allow_empty
|
默认值为 False 调用是否失败(如果调用返回空列表)。默认情况下,空列表表示 BUILD 文件中对 subpackages() 的调用可能出错。在这种情况下,设置为 true 可让此函数成功。 |