可在所有 Bazel 檔案中使用的函式,包括 .bzl 檔案、BUILD、MODULE.bazel 和 WORKSPACE。
成員
- abs
- 全部
- any
- bool
- dict
- dir
- enumerate
- 失敗
- float
- getattr
- hasattr
- 雜湊
- int
- 智慧鏡頭
- list
- max
- min
- range
- repr
- 已撤銷
- 已排序
- str
- tuple
- type
- zip
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
|
required A 字串或元素集合。 |
不限
bool any(elements)如果至少有一個元素的評估結果為 True,就會傳回 true。系統會使用 bool 函式將元素轉換為布林值。
any([-1, 0, 1]) == True any([False, 0, ""]) == False
參數
參數 | 說明 |
---|---|
elements
|
required A 字串或元素集合。 |
bool
bool bool(x=False)bool 類型的建構函式。如果物件為
None
、False
、空字串 (""
)、數字 0
或空集合 (例如 ()
、[]
),則會傳回 False
。否則,會傳回 True
。
參數
參數 | 說明 |
---|---|
x
|
預設值為 False 要轉換的變數。 |
dict
dict dict(pairs=[], **kwargs)使用選用的位置引數和選用關鍵字引數集合,建立字典。如果有多個同一個鍵,系統會採用最後一個值。凡是透過位置引數提供的項目,由關鍵字引數提供的項目都會視為來自。
參數
參數 | 說明 |
---|---|
pairs
|
預設值為 [] dict 或可疊代且元素每個長度為 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
|
預設為 0 start index。 |
失敗
None
fail(msg=None, attr=None, *args)
導致執行作業失敗,並顯示錯誤訊息。
參數
參數 | 說明 |
---|---|
msg
|
預設值為 None 已淘汰:改用位置引數。此引數如隱含的位置引數。 |
attr
|
string;或 None ;
預設值為 None 已淘汰。導致包含此字串的選用前置字串會加入錯誤訊息。 |
args
|
必要 顯示在錯誤訊息中的值清單,採用 debugPrint (預設等同於 str ) 格式並以空格彙整。 |
float
float float(x=unbound)以浮點值傳回 x。
- 如果
x
已經是浮點值,float
會傳回不變。 - 如果
x
是布林值,float
會傳回 1.0 代表 True,然後傳回 0.0 代表 False。 - 如果
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
|
必要 結構體屬性的名稱。 |
default
|
預設為 unbound 如果結構體沒有指定名稱的屬性,則會傳回預設值。 |
hasattr
bool hasattr(x, name)如果物件
x
具有指定 name
的屬性或方法,則傳回 True,否則傳回 False。範例:hasattr(ctx.attr, "myattr")
參數
參數 | 說明 |
---|---|
x
|
必要 要檢查的物件。 |
name
|
必要 屬性的名稱。 |
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)傳回 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 等其中一個基底。如果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(*args)傳回所有指定引數中最大的一個。如果只提供一個引數,就必須是不可空白的可疊代項目。如果元素無法比較 (例如 int 字串),或沒有提供引數,就會發生錯誤。
max(2, 5, 4) == 5 max([5, 6, 3]) == 6
參數
參數 | 說明 |
---|---|
args
|
required 要檢查的元素。 |
分鐘
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
|
必要 要列印的物件。 |
範圍
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
|
必要 如果提供停止,起始元素的值,否則為停靠站,實際開始值則為 0 |
stop_or_none
|
int;或 None ;
預設值為 None 「不」包含在結果清單中的第一個項目選用索引;並在到達 stop 前停止。
|
step
|
預設值為 1 遞增 (預設值為 1)。但可能是負值。 |
repr
string repr(x)將任何物件轉換為字串表示法。很適合用於偵錯。
repr("ab") == '"ab"'
參數
參數 | 說明 |
---|---|
x
|
必填 要轉換的物件。 |
已反轉
list reversed(sequence)傳回新的未凍結清單,其中包含原始可疊代序列的元素 (以反向順序排列)。
reversed([3, 5, 4]) == [4, 5, 3]
參數
參數 | 說明 |
---|---|
sequence
|
必要 要反轉的可疊代序列 (例如清單)。 |
sorted
list sorted(iterable, *, key=None, reverse=False)傳回新的排序清單,其中包含提供可迴圈序列的所有元素。如果任何一組元素 x、y 無法使用 x < y 進行比較,就可能發生錯誤。除非反向引數為 True,否則元素會依遞增順序排序,如果是遞減順序,則會傳回遞減順序。排序穩定:相等的元素會保留原始相對順序。
sorted([3, 5, 4]) == [3, 4, 5]
參數
參數 | 說明 |
---|---|
iterable
|
必要 要排序的可疊代序列。 |
key
|
預設值為 None 在比較前套用至每個元素的選用函式。 |
reverse
|
預設為 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
|
必要 要檢查類型的物件。 |
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
|
將必要的 清單壓縮成 ZIP 檔案。 |