所有 Bazel 文件

报告问题

所有 Bazel 文件(包括 .bzl 文件、BUILD、MODULE.bazel 和工作区)中都提供的方法。

成员

abs

unknown abs(x)

返回数值(震级相同的非负数)的绝对值。
abs(-2.3) == 2.3

参数

参数 说明
x 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 类型的构造函数。如果对象为 NoneFalse、空字符串 ("")、数字 0 或空集合(例如 ()[]),该方法会返回 False。否则,它会返回 True

参数

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

dict

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

根据一个可选的位置参数和一组可选的关键字参数创建字典。如果多次指定同一个键,系统将使用最后一个值。通过关键字参数提供的条目会被视为位于通过位置参数提供的条目之后。

参数

参数 说明
pairs 默认值为 []
字典或 iterable,其元素的长度均为 2(键、值)。
kwargs 必需
其他条目的字典。

dir

list dir(x)

返回字符串列表:相应参数对象的属性和方法的名称。

参数

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

枚举

list enumerate(list, start=0)

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

参数

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

fail

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

会导致执行失败并报错。

参数

参数 说明
msg 默认值为 None
已废弃:请改用位置参数。此参数充当隐式前导位置参数。
attr string;或 None;默认值为 None
已废弃。用于在错误消息中添加包含此字符串的可选前缀。
args required
错误消息中显示的值列表,采用 debugPrint 的格式(默认情况下等同于 str)格式,并以空格连接。

float

float float(x=unbound)

以浮点值返回 x。
  • 如果 x 已经是浮点数,则 float 原样返回它。
  • 如果 x 是布尔值,float 会针对 True 返回 1.0,对 False 返回 0.0。
  • 如果 x 是一个整数,float 会返回与 x 最接近的有限浮点值;如果幅度过大,则返回错误。
  • 如果 x 是一个字符串,它必须是有效的浮点字面量,或者等于 NaNInfInfinity(不区分大小写),前面加上 +- 符号。
任何其他值都会导致错误。如果没有参数,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 required
需要访问其属性的结构体。
name required
结构体属性的名称。
default 默认值为 unbound
如果结构体没有给定名称的属性,则返回的默认值。

Hasattr

bool hasattr(x, name)

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

参数

参数 说明
x required
要检查的对象。
name required
属性的名称。

hash

int hash(value)

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

参数

参数 说明
value 必需
要进行哈希处理的字符串值。

int

int int(x, base=unbound)

以 int 值返回 x。
  • 如果 x 已经是 int,int 会原样返回它。
  • 如果 x 为布尔值,int 会返回 1 表示 True,0 表示 False。
  • 如果 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 required
要转换的字符串。
base 默认值为 unbound
用于解译字符串值的基数;默认值为 10。必须介于 2 到 36(含)之间,如果为 0,则检测底数,就好像 x 是整数字面量一样。如果值不是字符串,则不得提供此参数。

len

int len(x)

返回字符串、序列(例如列表或元组)、字典或其他可迭代对象的长度。

参数

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

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 默认值为 []
要转换的对象。

最大值

unknown max(*args)

返回所有给定参数中最大的一个。如果仅提供一个实参,它必须是非空 iterable。如果元素不可比较(例如 int 和字符串),或者没有指定任何实参,就会报错。
max(2, 5, 4) == 5
max([5, 6, 3]) == 6

参数

参数 说明
args 必需
要检查的元素。

分钟

unknown min(*args)

返回所有给定参数中的最小参数。如果仅提供一个参数,则该参数必须是非空可迭代对象。如果元素不可比较(例如 int 和字符串),或者没有指定任何参数,就会出错。
min(2, 5, 4) == 2
min([5, 6, 3]) == 3

参数

参数 说明
args 必需
要检查的元素。

输出

None print(sep=" ", *args)

args 作为调试输出输出。其前缀为字符串 "DEBUG" 以及此调用的位置(文件和行号)。将参数转换为字符串的具体方式未指定,可能随时发生变化。需要特别指出的是,它可能与 str()repr() 进行的格式设置不同(并且比该格式更详细)。

不建议在正式版代码中使用 print,因为它会为用户造成垃圾内容。对于废弃,请尽可能使用 fail() 来报告硬错误。

参数

参数 说明
sep 默认值为 " "
对象之间的分隔符字符串,默认为空格 (" ")。
args required
要输出的对象。

范围

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

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

参数

参数 说明
start_or_stop 必需
如果提供了停止值,则为起始元素的值,否则,停止值和实际起始值为 0
stop_or_none intNone;默认值为 None
,不在结果列表中包含的第一项的可选索引;在达到 stop 前停止生成列表。
step 默认值为 1
增量(默认值为 1)。此值可能为负数。

回复

string repr(x)

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

参数

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

reversed

list reversed(sequence)

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

参数

参数 说明
sequence required
要反转的可迭代序列(例如 list)。

已排序

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

返回一个新的已排序列表,其中包含所提供的可迭代序列的所有元素。如果无法使用 x < y 比较任何一对元素 x、y,则可能会出错。元素按升序排序,除非反向参数为 True,在这种情况下,顺序是降序。排序稳定:比较结果相等的元素会保留其原始的相对顺序。
sorted([3, 5, 4]) == [3, 4, 5]

参数

参数 说明
iterable required
要排序的可迭代序列。
key 默认值为 None
比较前会为每个元素应用的可选函数。
reverse 默认值为 False
按降序返回结果。

str

string str(x)

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

参数

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

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 required
要检查其类型的对象。

zip

list zip(*args)

返回 tuplelist,其中第 i 个元组包含每个参数序列或可迭代对象的第 i 个元素。该列表具有最短输入的大小。使用一个 iterable 参数时,它会返回一元组的列表。在不使用任何参数的情况下,它会返回一个空列表。示例:
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 压缩的
列表。