所有 Bazel 檔案

回報問題 Nightly · 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 intfloat; 必填
(int 或 float)

全部

bool all(elements)

如果所有元素的評估結果為 True,或集合為空白,則傳回 true。系統會透過 bool 函式將元素轉換為布林值。
all(["hello", 3, True]) == True
all([-1, 0, 1]) == False

參數

參數 說明
elements required
A 字串或元素集合。

不限

bool any(elements)

如果至少有一個元素評估為 True,則傳回 true。系統會透過 bool 函式將元素轉換為布林值。
any([-1, 0, 1]) == True
any([False, 0, ""]) == False

參數

參數 說明
elements 必要
字串或元素集合。

bool

bool bool(x=False)

布林值類型的建構函式。如果物件是 NoneFalse、空白字串 ("")、數字 0 或空白集合 (例如 ()[]),就會傳回 False。如果沒有,則會傳回 True

參數

參數 說明
x 預設值為 False
要轉換的變數。

dict

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

根據選用的位置引數和選用關鍵字引數集合,建立字典。如果有多個同一個鍵,系統會採用最後一個值。凡是透過位置引數提供的項目,由關鍵字引數提供的項目都會視為來自。

參數

參數 說明
pairs 預設值為 []
dict 或可疊代且元素每個長度為 2 (鍵、值) 的元素。
kwargs required
Additional 字典項目。

dir

list dir(x)

傳回字串清單:參數物件的屬性和方法名稱。

參數

參數 說明
x 必要
要檢查的物件。

enumerate

list enumerate(list, start=0)

傳回一組成對項目 (兩個元素的元組) 清單,其中包含索引 (int) 和輸入序列中的項目。
enumerate([24, 21, 84]) == [(0, 24), (1, 21), (2, 84)]

參數

參數 說明
list 必須
input sequence。
start int; 預設值為 0
起始索引。

失敗

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

導致執行作業失敗並發生錯誤。

參數

參數 說明
msg 預設值為 None
已淘汰:改用位置引數。這個引數會做為隱含的領先位置引數。
attr string;或 None; 預設值為 None
已淘汰。導致包含此字串的選用前置字串會新增至錯誤訊息。
sep 字串; 預設為 " "
。 物件之間的分隔字串,預設為空格 (" ")。
args required
值清單,以 debugPrint 格式 (預設為 str) 顯示,並與 sep 連結 (預設為 " "),顯示在錯誤訊息中。

float

float float(x=unbound)

以浮點值傳回 x。
  • 如果 x 已經是浮點值,float 會傳回不變。
  • 如果 x 是布林值,float 會傳回 1.0 代表 True,然後傳回 0.0 代表 False。
  • 如果 x 是 int,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 必要
存取其屬性的結構。
name string; 必要
結構體屬性的名稱。
default 預設為 unbound
如果結構體沒有指定名稱的屬性,則會傳回預設值。

哈斯塔爾

bool hasattr(x, name)

如果物件 x 具有指定 name 的屬性或方法,則傳回 True,否則傳回 False。示例:
hasattr(ctx.attr, "myattr")

參數

參數 說明
x 必要
要檢查的物件。
name string; 必要
屬性的名稱。

hash

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)

傳回 x 做為 int 值。
  • 如果 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 時,會選擇其中一個底數 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 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(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 required
要檢查的元素。

分鐘

unknown min(key=None, *args)

傳回所有指定引數中的最小一個。如果只提供一個位置引數,該引數必須是可枚舉的非空白值。如果元素無法比較 (例如 int 與字串),或未設定引數時就會發生錯誤。
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 required
要檢查的元素。

列印

None print(sep=" ", *args)

args 列印為偵錯輸出內容。並在前面加上 "DEBUG" 字串和這個呼叫的位置 (檔案和行號)。未指定引數轉換為字串的確切方式,而且可能隨時變更。特別是,這可能與 str()repr() 所執行的格式不同 (且更詳細)。

我們不建議在正式版程式碼中使用 print,因為這個程式碼會向使用者顯示垃圾內容。針對淘汰項目,請盡可能使用 fail() 產生嚴重錯誤。

參數

參數 說明
sep string; 預設值為 " "
物件之間的分隔符字串,預設值為空格 (「 」)。
args 必要
要列印的物件。

範圍

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

建立清單,其中項目從 startstop,並以 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; 必要
如果提供停止,起始元素的值,否則為停靠站,實際開始值則為 0
stop_or_none int;或 None; 預設為 None
(選用) 第一個項目的索引,不會納入結果清單;清單產生作業會在 stop 之前停止。
step int;預設為 1
。增量值 (預設為 1)。但可能是負值。

Repr

string repr(x)

將任何物件轉換為字串表示。很適合用於偵錯。
repr("ab") == '"ab"'

參數

參數 說明
x 必填
要轉換的物件。

已撤銷

list reversed(sequence)

傳回新的未凍結清單,其中包含原始可枚舉序列的元素,並以相反順序排序。
reversed([3, 5, 4]) == [4, 5, 3]

參數

參數 說明
sequence iterable; required
要反轉的可枚舉序列 (例如清單)。

sorted

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

傳回新的排序清單,其中包含提供的可疊代序列的所有元素。如果任何一組元素 x、y 無法使用 x < y 進行比較,就可能發生錯誤。除非反向引數為 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 iterable; required
要排序的可迭代序列。
key 可呼叫;或 None; 預設為 None
在比較前套用至每個元素的選用函式。
reverse bool; 預設為 False
。 以遞減順序傳回結果。

str

string str(x)

將任何物件轉換成字串。這對偵錯作業相當實用。
str("ab") == "ab"
str(8) == "8"

參數

參數 說明
x 必填
要轉換的物件。

元組

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
The object to check type of.

zip

list zip(*args)

傳回 tuplelist,其中 i-th tuple 包含每個引數序列或可疊代項目中的 i-th 元素。清單的大小與最短輸入內容相同。使用單一可枚舉引數時,會傳回 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 必要
將清單轉換為 ZIP 檔案