native.cc_library
。请注意,原生模块仅在加载阶段可用(即针对宏,不适用于规则实现)。属性会忽略 None
值,并将其视为未设置该属性。您还可以使用以下函数:
成员
- existing_rule
- existing_rules
- exports_files
- glob
- module_namemodule_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()返回一个不可变的类似 dict 的对象,用于描述到目前为止此线程的软件包中已实例化的规则。类似字典的对象的每个条目都会将规则实例的名称映射到
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
|
sequence of strings ;必需要导出的文件的列表。 |
visibility
|
sequence; or None ;
default = None可以指定可见性声明。这些文件将对指定的目标可见。如果未指定可见性,则文件将对所有软件包可见。 |
licenses
|
sequence of strings; or None ;
default = None要指定的许可。 |
glob
sequence native.glob(include=[], exclude=[], exclude_directories=1, allow_empty=unbound)Glob 会针对当前软件包中的每个文件返回一个可变且已排序的新列表,其中包含:
- 与
include
中的至少一个模式匹配。 - 与
exclude
中的任何模式都不匹配(默认值为[]
)。
exclude_directories
参数(设置为 1
),结果中将会省略目录类型的文件(默认为 1
)。
参数
参数 | 说明 |
---|---|
include
|
sequence of strings ;
default = []要包含的 glob 模式列表。 |
exclude
|
sequence of strings ;
默认值 = []要排除的 glob 模式列表。 |
exclude_directories
|
default = 1 用于指明是否要排除目录的标志。 |
allow_empty
|
default = unbound 我们是否允许 glob 模式不匹配任何内容。如果“allow_empty”为 False,则每个包含模式都必须匹配某些内容,并且最终结果必须为非空(在排除“excluded”模式的匹配项之后)。 |
module_name
string native.module_name()与此软件包所在的代码库关联的 Bazel 模块的名称。如果此软件包来自在 WORKSPACE(而非 MODULE.bazel)中定义的代码库,则为空。对于模块扩展程序生成的代码库,这是托管扩展程序的模块的名称。它与
module_ctx.modules
中的 module.name
字段相同。
可能会返回 None
。
module_version
string native.module_version()与此软件包所在的代码库关联的 Bazel 模块版本。如果此软件包来自在 WORKSPACE(而非 MODULE.bazel)中定义的代码库,则为空。对于模块扩展程序生成的代码库,这是托管扩展程序的模块的版本。它与
module_ctx.modules
中的 module.version
字段相同。
可能会返回 None
。
package_group
None native.package_group(name, packages=[], includes=[])此函数会定义一组软件包,并为组分配标签。可以在
visibility
属性中引用该标签。
参数
参数 | 说明 |
---|---|
name
|
必需 此规则的唯一名称。 |
packages
|
sequence of strings ;
default = []此组中软件包的完整枚举。 |
includes
|
sequence of strings ;
default = []此软件包中包含的其他软件包组。 |
package_name
string native.package_name()要评估的软件包的名称。例如,在 BUILD 文件
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; or Label ;必需输入标签字符串或 Label 对象。如果传递了 Label 对象,它将按原样返回。 |
repository_name
string native.repository_name()从中调用规则或 build 扩展的代码库的名称。例如,在 WORKSPACE 节
local_repository(name='local', path=...)
调用存在的软件包中,该变量将设置为 @local
。在主代码库的软件包中,该参数将设置为 @
。此函数等效于已废弃的变量 REPOSITORY_NAME
。
子文件包
sequence native.subpackages(include, exclude=[], allow_empty=False)返回当前软件包的每个直接子软件包的新可变列表,而不考虑文件系统目录深度。返回的列表已经过排序,并且包含相对于当前软件包的子软件包的名称。建议您优先使用 bazel_skylib.subpackages 模块中的方法,而不是直接调用此函数。
参数
参数 | 说明 |
---|---|
include
|
sequence of strings ;必需要包含在子软件包扫描中的 glob 模式列表。 |
exclude
|
sequence of strings ;
default = []要从子软件包扫描中排除的 glob 模式列表。 |
allow_empty
|
default = False 调用返回空列表时是否失败。默认情况下,空列表表示 BUILD 文件中存在对 subpackages() 的调用过于冗长的潜在错误。如果设置为 true,则此函数可在这种情况下成功运行。 |