所有 Bazel 文件

报告问题 每夜 build · 8.0 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

所有 Bazel 文件（包括 .bzl 文件、BUILD、MODULE.bazel、VENDOR.bazel 和 WORKSPACE）中提供的方法。

成员

abs

unknown abs(x)

返回数字的绝对值（一个大小相同的非负数）。
abs(-2.3) == 2.3

参数

参数 说明
x int；或 float； 必需
一个数字（int 或 float）

全部

bool all(elements)

如果所有元素的求值结果均为 True 或集合为空，则返回 true。系统会使用 bool 函数将元素转换为布尔值。
all(["hello", 3, True]) == True
all([-1, 0, 1]) == False

参数

参数 说明
elements 必需
一个字符串或元素集合。

任意

bool any(elements)

如果至少有一个元素的计算结果为 True，则返回 true。系统会使用 bool 函数将元素转换为布尔值。
any([-1, 0, 1]) == True
any([False, 0, ""]) == False

参数

参数 说明
elements 必需
一个字符串或元素集合。

bool

bool bool(x=False)

bool 类型的构造函数。如果对象为 None、False、空字符串 ("")、数字 0 或空集合（例如 ()、[]），则返回 False；否则，返回 True。

参数

参数 说明
x 默认值为 False
要转换的变量。

字典

dict dict(pairs=[], **kwargs)

使用可选的位置参数和可选的一组关键字参数创建字典。如果多次提供相同的键，则系统会使用最后一个值。系统会将通过关键字参数提供的条目视为在通过位置参数提供的条目之后。

参数

参数 说明
pairs 默认值为 []
字典，或每个元素长度为 2（键、值）的可迭代对象。
kwargs 必需
额外条目的字典。

dir

list dir(x)

返回一个字符串列表：参数对象的属性和方法的名称。

参数

参数 说明
x 必需
要检查的对象。

枚举

list enumerate(list, start=0)

返回一个包含对（两个元素的元组）的列表，其中包含输入序列中的索引 (int) 和项。 
enumerate([24, 21, 84]) == [(0, 24), (1, 21), (2, 84)]

参数

参数 说明
list 所需的
输入序列。
start int； 默认值为 0
起始索引。

fail

None fail(msg=None, attr=None, sep=" ", *args)

会导致执行失败并出现错误。

参数

参数 说明
msg 默认值为 None
已废弃：请改用位置参数。此参数的作用类似于隐式前置位置参数。
attr 字符串；或 None； 默认为 None
已废弃。会导致在错误消息中添加包含此字符串的可选前缀。
sep 字符串； 默认为 " "
对象之间的分隔符字符串，默认为空格（“ ”）。
args 必需
一个值列表，使用 debugPrint（默认等同于 str）进行格式化，并使用 sep（默认为“"”）连接，显示在错误消息中。

float

float float(x=unbound)

以浮点值的形式返回 x。
  • 如果 x 已是浮点值，float 会按原样返回它。
  • 如果 x 是布尔值，float 会针对 True 返回 1.0，针对 False 返回 0.0。
  • 如果 x 是 int，则 float 会返回最接近 x 的有限浮点值；如果幅度过大，则会返回错误。
  • 如果 x 是字符串，则必须是有效的浮点字面量，或者等于（忽略大小写）NaN、Inf 或 Infinity，可选择在前面加上 + 或 - 符号。
任何其他值都会导致错误。如果不指定参数，float() 会返回 0.0。

参数

参数 说明
x 默认值为 unbound
要转换的值。

getattr

unknown getattr(x, name, default=unbound)

返回结构体中具有给定名称的字段（如果存在）。如果未设置，则返回 default（如果已指定）或引发错误。getattr(x, "foobar") 等效于 x.foobar。
getattr(ctx.attr, "myattr")
getattr(ctx.attr, "myattr", "mydefault")

参数

参数 说明
x 必需
要访问其属性的结构体。
name string; 必需
结构体属性的名称。
default 默认值为 unbound
如果结构体没有给定名称的属性，则返回的默认值。

hasattr

bool hasattr(x, name)

如果对象 x 具有给定 name 的属性或方法，则返回 True，否则返回 False。示例：
hasattr(ctx.attr, "myattr")

参数

参数 说明
x 必需
要检查的对象。
name string; 必需
属性的名称。

哈希

int hash(value)

返回字符串的哈希值。此值使用与 Java 的 String.hashCode() 相同的算法进行确定性计算，即：
s[0] * (31^(n-1)) + s[1] * (31^(n-2)) + ... + s[n-1]
 目前不支持对字符串以外的值进行哈希处理。

参数

参数 说明
value string； 必需
要哈希的字符串值。

int

int int(x, base=unbound)

以 int 值的形式返回 x。
  • 如果 x 已是 int，则 int 会将其按原样返回。
  • 如果 x 是布尔值，int 会针对 True 返回 1，针对 False 返回 0。
  • 如果 x 是字符串，则必须采用 <sign><prefix><digits> 格式。<sign> 是 "+"、"-" 或空（解释为正值）。<digits> 是从 0 到 base-1 的数字序列，其中字母 a-z（或等效的 A-Z）用作数字 10-35。如果 base 为 2/8/16，<prefix> 为可选项，可以分别为 0b/0o/0x（或等效的 0B/0O/0X）；如果 base 是除这些基数或特殊值 0 之外的任何其他值，则前缀必须为空。如果 base 为 0，系统会将字符串解释为整数字面量，也就是说，系统会根据使用的前缀（如果有）选择 2/8/10/16 基数之一。如果 base 为 0，则不使用前缀；如果有多个数字，则前导数字不能为 0；这是为了避免八进制和十进制之间的混淆。字符串表示的数字的大小必须在 int 类型的允许范围内。
  • 如果 x 是浮点值，int 会返回该浮点值的整数值，并向零舍入。如果 x 为非有限值（NaN 或无穷大），则会出错。
如果 x 是任何其他类型，或者值是字符串且不符合上述格式，则此函数会失败。与 Python 的 int 函数不同，此函数不允许零个参数，也不允许字符串参数包含多余的空格。

示例：

int("123") == 123
int("-123") == -123
int("+123") == 123
int("FF", 16) == 255
int("0xFF", 16) == 255
int("10", 0) == 10
int("-0x10", 0) == -16
int("-0x10", 0) == -16
int("123.456") == 123

参数

参数 说明
x 必需
要转换的字符串。
base 默认值为 unbound
用于解读字符串值的底数；默认为 10。必须介于 2 到 36（包括这两个数值）之间，或者为 0，以便将基数检测为 x 是整数字面量。如果值不是字符串，则不得提供此参数。

len

int len(x)

返回字符串、序列（例如列表或元组）、字典、集或其他可迭代的长度。

参数

参数 说明
x 必需
要报告其长度的值。

list

list list(x=[])

返回与给定可迭代值具有相同元素的新列表。
list([1, 2]) == [1, 2]
list((2, 3, 2)) == [2, 3, 2]
list({5: "a", 2: "b", 4: "c"}) == [5, 2, 4]

参数

参数 说明
x 可迭代对象； 默认为 []
要转换的对象。

max

unknown max(key=None, *args)

返回所有给定参数中的最大值。如果只提供一个位置参数，则该参数必须是非空可迭代对象。如果元素不可比较（例如整数与字符串），或者未提供任何参数，则会出错。
max(2, 5, 4) == 5
max([5, 6, 3]) == 6
max("two", "three", "four", key = len) =="three"  # the longest
max([1, -1, -2, 2], key = abs) == -2  # the first encountered with maximal key value

参数

参数 说明
key 可调用函数；或 None； 默认为 None
在比较之前应用于每个元素的可选函数。
args 必需
要检查的元素。

分钟

unknown min(key=None, *args)

返回所有给定参数中最小的一个。如果仅提供了一个位置参数，则该参数必须是非空可迭代对象。如果元素不可比较（例如整数与字符串），或者未提供任何参数，则会引发错误。
min(2, 5, 4) == 2
min([5, 6, 3]) == 3
min("six", "three", "four", key = len) == "six"  # the shortest
min([2, -2, -1, 1], key = abs) == -1  # the first encountered with minimal key value

参数

参数 说明
key 可调用函数；或 None； 默认为 None
在比较之前应用于每个元素的可选函数。
args 必需
要检查的元素。

输出

None print(sep=" ", *args)

将 args 输出为调试输出。其前缀将是字符串 "DEBUG" 和此调用的调用位置（文件和行号）。参数转换为字符串的确切方式未指定，并且可能会随时更改。具体而言，它可能与 str() 和 repr() 执行的格式设置不同（并且更详细）。

由于 print 会为用户创建垃圾内容，因此不建议在生产代码中使用 print。对于废弃项，请尽可能使用 fail() 报告严重错误。

参数

参数 说明
sep 字符串； 默认为 " "
对象之间的分隔符字符串，默认为空格（“ ”）。
args 必需
要输出的对象。

范围

sequence range(start_or_stop, stop_or_none=None, step=1)

创建一个列表，其中项从 start 递增到 stop，增量为 step。如果只提供了一个参数，则元素的范围将从 0 到该元素。
range(4) == [0, 1, 2, 3]
range(3, 9, 2) == [3, 5, 7]
range(3, 0, -1) == [3, 2, 1]

参数

参数 说明
start_or_stop int； 必需
如果提供了 stop，则为 start 元素的值；否则为 stop 的值，实际的开始时间为 0
stop_or_none int；或 None； 默认为 None
第一个不要包含在生成的列表中的项的可选索引；在达到 stop 之前，列表的生成会停止。
step int； 默认值为 1
增量（默认值为 1）。此值可以为负数。

repr

string repr(x)

将任何对象转换为字符串表示法。这对于调试很有用。
repr("ab") == '"ab"'

参数

参数 说明
x 必需
要转换的对象。

reversed

list reversed(sequence)

返回一个新的未冻结列表，其中包含原始可迭代序列的元素，且按倒序排列。
reversed([3, 5, 4]) == [4, 5, 3]

参数

参数 说明
sequence 可迭代对象； 必需
要反转的可迭代序列（例如列表）。

set

set set(elements=[])

实验性。此 API 目前处于实验阶段，随时可能会发生变化。请勿依赖此功能。您可以通过设置 --experimental_enable_starlark_set 以实验性方式启用此功能。

创建一个新的集，可选择初始化为包含给定可迭代对象中的元素。

参数

参数 说明
elements 默认值为 []
集合、序列或字典。

已排序

list sorted(iterable, key=None, *, reverse=False)

返回一个包含所提供可迭代序列的所有元素的新排序列表。如果无法使用 x < y 比较任何一对元素 x、y，则可能会发生错误。元素会按升序排序，除非 reverse 参数为 True，在这种情况下，排序方式为降序。 排序是稳定的：比较结果为相等的元素会保留其原始相对顺序。
sorted([3, 5, 4]) == [3, 4, 5]
sorted([3, 5, 4], reverse = True) == [5, 4, 3]
sorted(["two", "three", "four"], key = len) == ["two", "four", "three"]  # sort by length

参数

参数 说明
iterable 可迭代； 必需
要排序的可迭代序列。
key 可调用函数；或 None； 默认为 None
在比较之前应用于每个元素的可选函数。
reverse bool； 默认为 False
按降序返回结果。

str

string str(x)

将任何对象转换为字符串。这在调试时很有用。
str("ab") == "ab"
str(8) == "8"

参数

参数 说明
x 必需
要转换的对象。

tuple

tuple tuple(x=())

返回与给定可迭代值具有相同元素的元组。
tuple([1, 2]) == (1, 2)
tuple((2, 3, 2)) == (2, 3, 2)
tuple({5: "a", 2: "b", 4: "c"}) == (5, 2, 4)

参数

参数 说明
x 可迭代对象； 默认为 ()
要转换的对象。

类型

string type(x)

返回其参数的类型名称。这对于调试和类型检查非常有用。示例：
type(2) == "int"
type([1]) == "list"
type(struct(a = 2)) == "struct"
此函数将来可能会发生变化。为了编写与 Python 兼容且面向未来的代码，请仅将其用于比较返回值：
if type(x) == type([]):  # if x is a list

参数

参数 说明
x 必需
要检查类型的对象。

zip

list zip(*args)

返回一个由 tuple 组成的 list，其中第 i 个元组包含每个实参序列或可迭代对象中的第 i 个元素。列表的大小与最短输入相同。如果只有一个可迭代参数，则会返回一个包含 1 个元组的列表。如果没有参数，则会返回空列表。示例：
zip()  # == []
zip([1, 2])  # == [(1,), (2,)]
zip([1, 2], [3, 4])  # == [(1, 3), (2, 4)]
zip([1, 2], [3, 4, 5])  # == [(1, 3), (2, 4)]

参数

参数 说明
args 必需
列出要压缩的文件。