Starlark 語言

回報問題 查看來源

本頁面將介紹 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 載入時建立 varvar 因此是 foo.bzl 內容的一部分。fct() 執行時,會在 foo.bzl 的環境中執行。完成 foo.bzl 的評估後,環境會包含不可變的項目 var,其值為 [5]

當另一個 bar.bzlfoo.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 功能:

  • 隱含字串串連 (使用明確的 + 運算子)。
  • 鏈結比較 (例如 1 < x < 5)。
  • class (請參閱 struct 函式)。
  • import (請參閱 load 陳述式)。
  • whileyield
  • 浮點值和設定型別。
  • 產生器和產生器運算式
  • is (改為使用 ==)。
  • tryraiseexceptfinally (請參閱 fail 以瞭解嚴重錯誤)。
  • globalnonlocal
  • 大部分的內建函式和大部分的方法