本頁提供 Starlark 的總覽,先前稱為 Skylark,後者是 Bazel 中使用的語言。如需函式和類型的完整清單,請參閱 Bazel API 參考資料。
如要進一步瞭解語言,請參閱 Starlark 的 GitHub 存放區。
如要瞭解 Starlark 語法和行為的權威規格,請參閱 Starlark 語言規範。
語法
Starlark 的語法是以 Python3 為靈感。以下是 Starlark 的有效語法:
def fizz_buzz(n):
"""Print Fizz Buzz numbers from 1 to n."""
for i in range(1, n + 1):
s = ""
if i % 3 == 0:
s += "Fizz"
if i % 5 == 0:
s += "Buzz"
print(s if s else i)
fizz_buzz(20)
Starlark 的語意與 Python 有所不同,但行為差異極少,但 Starlark 引發錯誤的情況除外。支援的 Python 類型如下:
可變動性
Starlark 重視不變性。有兩種可變動資料結構:清單和字典。對可變動資料結構所做的變更,例如將值附加至清單或刪除字典中的項目,僅適用於在目前情境中建立的物件。內容完成後,其值會變成不可變更。
這是因為 Bazel 建構作業使用的是平行執行功能。在建構期間,每個 .bzl
檔案和每個 BUILD
檔案都會取得自己的執行環境。每項規則也會在各自的結構定義中進行分析。
以下是 foo.bzl
檔案的範例:
# `foo.bzl`
var = [] # declare a list
def fct(): # declare a function
var.append(5) # append a value to the list
fct() # execute the fct function
Bazel 會在 foo.bzl
載入時建立 var
。因此,var
是 foo.bzl
結構定義的一部分。當 fct()
執行時,它會在 foo.bzl
的環境中執行。foo.bzl
的評估完成後,環境會包含不可變更的項目 var
,其值為 [5]
。
當另一個 bar.bzl
從 foo.bzl
載入符號時,載入的值無法變更。因此,以下 bar.bzl
中的程式碼是無效的:
# `bar.bzl`
load(":foo.bzl", "var", "fct") # loads `var`, and `fct` from `./foo.bzl`
var.append(6) # runtime error, the list stored in var is frozen
fct() # runtime error, fct() attempts to modify a frozen list
在 bzl
檔案中定義的全域變數,無法在定義這些變數的 bzl
檔案以外變更。如同上述使用 bzl
檔案的範例,規則傳回的值不可變動。
BUILD 和 .bzl 檔案的差異
BUILD
檔案會透過呼叫規則來登錄目標。.bzl
檔案提供常數、規則、巨集和函式的定義。
原生函式和原生規則是 BUILD
檔案中的全域符號。bzl
檔案必須使用 native
模組載入。
BUILD
檔案有兩個語法限制:1) 宣告函式違法,以及 2) 不允許使用 *args
和 **kwargs
引數。
與 Python 的差異
全域變數無法變更。
頂層不允許使用
for
陳述式。請改為在函式中使用。在BUILD
檔案中,您可以使用清單理解功能。頂層不允許使用
if
陳述式。不過,您可以使用if
運算式:first = data[0] if len(data) > 0 else None
。用於疊代字典的確定性順序。
不允許遞迴。
Int 類型僅限 32 位元的正負號整數。溢位會導致錯誤。
在疊代期間修改集合會發生錯誤。
除了相等測試、比較運算子
<
、<=
、>=
、>
等,系統無法針對不同值類型定義。簡單來說:5 < 'foo'
會擲回錯誤,5 == "5"
則會傳回 false。在元組中,只有當元組介於括號之間 (也就是您寫入
(1,)
而不是1,
時),結尾的逗號才算有效。字典常值不得包含重複的鍵。舉例來說,這是錯誤:
{"a": 4, "b": 7, "a": 1}
。字串會以雙引號表示 (例如當您呼叫 repr 時)。
字串無法疊代。
不支援下列 Python 功能: