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

foo.bzl 加载时,Bazel 会创建 var。因此,varfoo.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

  • 遍历字典的确定性顺序。

  • 不允许使用递归。

  • 整数类型最多只能有 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
  • 大多数内置函数和大多数方法