Starlark 语言

<ph type="x-smartling-placeholder"></ph> 报告问题 查看来源 敬上 每晚 · 7.3。 · 7.2 条 · 7.1敬上 · 7.0。 · 6.5

本页面简要介绍了 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 注重不可变性。有两种可变的数据结构: listsdicts。更改可变 数据结构,例如将值附加到列表中或删除 字典只对在当前上下文中创建的对象有效。在 上下文完成,其值将不可变。

这是因为 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。因此,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

  • 迭代字典的确定性顺序。

  • 不允许递归。

  • 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
  • float 和 set 类型。
  • 生成器和生成器表达式。
  • is(改用 ==)。
  • tryraiseexceptfinally(如需了解严重错误,请参阅 fail)。
  • globalnonlocal
  • 大多数内置函数和方法。