Starlark 言語

問題を報告 ソースを表示

このページでは、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 は不変性を優先します。変更可能なデータ構造として、リストdicts の 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

foo.bzl が読み込まれると、Bazel は 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 ファイルには、構文上の制限事項が 2 つあります。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 など)。
  • classstruct 関数を参照)。
  • importload ステートメントを参照)。
  • whileyield
  • float 型と set 型で使用できます。
  • 生成できます。
  • is(代わりに == を使用してください)。
  • tryraiseexceptfinally(致命的なエラーについては fail をご覧ください)。
  • globalnonlocal
  • ほとんどの組み込み関数、ほとんどのメソッドなどです。