Starlark 言語

問題を報告 ソースを表示 Nightly · 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

このページでは、Bazel で使用されている言語である Starlark(旧称 Skylark)の概要について説明します。関数とタイプの一覧については、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 は不変性を重視しています。変更可能なデータ構造には、リスト辞書の 2 つがあります。リストへの値の追加や辞書内のエントリの削除など、変更可能なデータ構造に対する変更は、現在のコンテキストで作成されたオブジェクトに対してのみ有効です。コンテキストが終了すると、その値は変更できなくなります。

これは、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 の評価が完了すると、環境に値 [5] の不変エントリ var が含まれます。

別の 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 引数が許可されないという 2 つの構文上の制限があります。

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 など)。
  • classstruct 関数を参照)。
  • importload ステートメントを参照)。
  • whileyield
  • 浮動小数点型とセット型。
  • ジェネレータとジェネレータ式。
  • is(代わりに == を使用)。
  • tryraiseexceptfinally(致命的なエラーについては fail をご覧ください)。
  • globalnonlocal
  • ほとんどの組み込み関数、ほとんどのメソッド。