标签

7.3 · 7.2 · 7.1 · 7.0 · 6.5

build 目标标识符。

对于每个 Label 实例 l,无论 Label() 调用发生在何处,字符串表示法 str(l) 都具有 Label(str(l)) == l 属性。

当作为位置参数传递给 print()fail() 时,Label 会改为使用经过优化以提高人类可读性的字符串表示法。此表示法会尽可能使用主代码库的表面代码库名称

成员

标签

Label Label(input)

在调用 .bzl 源文件所在的软件包上下文中,将标签字符串转换为 Label 对象。如果指定的值已经是 Label,则原样返回。

对于宏,相关函数 native.package_relative_label() 会在当前正在构建的软件包的上下文中将输入转换为 Label。使用该函数可模拟由标签值规则属性自动执行的字符串转换。

参数

参数 说明
input string;或 Label; required
输入标签字符串或标签对象。如果传递 Label 对象,系统会原封不动地将其返回。

name

string Label.name

此标签引用的目标的名称。例如:
Label("@@foo//pkg/foo:abc").name == "abc"

包裹

string Label.package

包含此标签所引用目标的软件包的名称(不含代码库名称)。例如:
Label("@@repo//pkg/foo:abc").package == "pkg/foo"

相对

Label Label.relative(relName)

实验性。此 API 处于实验阶段,随时可能更改。请勿依赖它。您可以通过设置 --+incompatible_enable_deprecated_label_apis
以实验性方式启用此功能已废弃。此方法与包含明显代码库名称的参数一起使用时,行为会出乎意料。请改用 Label.same_package_label()native.package_relative_label()Label()

解析绝对标签(以 // 开头)或相对于当前软件包的标签。如果此标签位于远程代码库中,则相应参数将相对于该代码库解析。如果参数包含代码库名称,系统会忽略当前标签,并原样返回参数,但如果代码库名称在当前代码库映射中,则会重写该代码库名称。系统也会原封不动地返回预留标签。
例如:

Label("//foo/bar:baz").relative(":quux") == Label("//foo/bar:quux")
Label("//foo/bar:baz").relative("//wiz:quux") == Label("//wiz:quux")
Label("@repo//foo/bar:baz").relative("//wiz:quux") == Label("@repo//wiz:quux")
Label("@repo//foo/bar:baz").relative("//visibility:public") == Label("//visibility:public")
Label("@repo//foo/bar:baz").relative("@other//wiz:quux") == Label("@other//wiz:quux")

如果传入的代码库映射为 {'@other' : '@remapped'},则将发生以下重新映射:

Label("@repo//foo/bar:baz").relative("@other//wiz:quux") == Label("@remapped//wiz:quux")

参数

参数 说明
relName 必需
相对于此标签解析的标签。

repo_name

string Label.repo_name

包含此标签所引用目标的代码库的规范名称,不带任何前置的 @ 符号 (@)。例如,
Label("@@foo//bar:baz").repo_name == "foo"

same_package_label

Label Label.same_package_label(target_name)

在与此标签相同的软件包中创建一个具有指定目标名称的标签。

参数

参数 说明
target_name 必填
新标签的目标名称。

workspace_name

string Label.workspace_name

实验性。此 API 目前处于实验阶段,随时可能会发生变化。请勿依赖此功能。您可以通过将 --+incompatible_enable_deprecated_label_apis
设为已废弃,在实验阶段将其启用。字段名称“工作区名称”在这里是错误的用法;请改用具有相同行为的 Label.repo_name

包含此标签所引用目标的代码库的规范名称,不带任何前置的 @ 符号 (@)。例如,

Label("@@foo//bar:baz").workspace_name == "foo"

workspace_root

string Label.workspace_root

返回相对于 execroot 的包含此标签所引用目标的代码库的执行根目录。例如:
Label("@repo//pkg/foo:abc").workspace_root == "external/repo"