Starlark は、Bazel で使用するために開発され、他のツールに採用されて以来、Python に似た構成言語です。Bazel の BUILD ファイルと .bzl ファイルは Starlark のダイアレクト言語として適切に記述されていますが、Bazel の組み込みまたはネイティブ部分ではなく、特に Build 言語で表現されている場合には、単に「Starlark」と表記されることが多くあります。Bazel は、glob、genrule、java_binary など、ビルド関連のさまざまな関数によってコア言語を拡張します。
詳細については、Bazel と Starlark のドキュメントをご覧ください。新しいルールセットの出発点として、ルール SIG テンプレートをご覧ください。
空のルール
最初のルールを作成するには、foo.bzl ファイルを作成します。
def _foo_binary_impl(ctx):
pass
foo_binary = rule(
implementation = _foo_binary_impl,
)
rule 関数を呼び出すときは、コールバック関数を定義する必要があります。ここにロジックが表示されますが、今は関数を空のままにしてかまいません。ctx 引数は、ターゲットに関する情報を提供します。
ルールを読み込み、BUILD ファイルから使用できます。
同じディレクトリに BUILD ファイルを作成します。
load(":foo.bzl", "foo_binary")
foo_binary(name = "bin")
これで、ターゲットをビルドできます。
$ bazel build bin
INFO: Analyzed target //:bin (2 packages loaded, 17 targets configured).
INFO: Found 1 target...
Target //:bin up-to-date (nothing to build)
このルールは何もしませんが、他のルールと同様に動作します。名前は必須です。visibility、testonly、tags などの一般的な属性がサポートされています。
評価モデル
先に進む前に、コードの評価方法を理解しておくことが重要です。
print ステートメントを指定して foo.bzl を更新します。
def _foo_binary_impl(ctx):
print("analyzing", ctx.label)
foo_binary = rule(
implementation = _foo_binary_impl,
)
print("bzl file evaluation")
ビルド:
load(":foo.bzl", "foo_binary")
print("BUILD file")
foo_binary(name = "bin1")
foo_binary(name = "bin2")
ctx.label は、分析対象のターゲットのラベルに対応します。ctx オブジェクトには有用なフィールドとメソッドが多数含まれています。全一覧については、API リファレンスをご覧ください。
コードに対してクエリを実行します。
$ bazel query :all
DEBUG: /usr/home/bazel-codelab/foo.bzl:8:1: bzl file evaluation
DEBUG: /usr/home/bazel-codelab/BUILD:2:1: BUILD file
//:bin2
//:bin1
いくつか観察してみましょう。
- 「bzl file evaluation」が最初に出力される。
BUILDファイルを評価する前に、Bazel は読み込むすべてのファイルを評価します。複数のBUILDファイルが foo.bzl を読み込んでいる場合、Bazel は評価の結果をキャッシュに保存するため、「bzl file evaluation」が 1 回だけ表示されます。 - コールバック関数
_foo_binary_implが呼び出されません。Bazel クエリはBUILDファイルを読み込みますが、ターゲットは分析しません。
ターゲットを分析するには、cquery（「構成済みクエリ」）または build コマンドを使用します。
$ bazel build :all
DEBUG: /usr/home/bazel-codelab/foo.bzl:2:5: analyzing //:bin1
DEBUG: /usr/home/bazel-codelab/foo.bzl:2:5: analyzing //:bin2
INFO: Analyzed 2 targets (0 packages loaded, 0 targets configured).
INFO: Found 2 targets...
ご覧のとおり、_foo_binary_impl はターゲットごとに 1 回ずつ、2 回呼び出されるようになりました。
「bzl file evaluation」も「BUILD file」も再出力されません。これは、foo.bzl の評価は bazel query の呼び出し後にキャッシュに保存されるためです。Bazel は、実際に実行されている場合にのみ print ステートメントを出力します。
ファイルの作成
ルールをより有用にするには、ファイルを生成するようにルールを更新してください。まず、ファイルを宣言して名前を付けます。この例では、ターゲットと同じ名前のファイルを作成します。
ctx.actions.declare_file(ctx.label.name)
bazel build :all を実行すると、次のエラーが発生します。
The following files have no generating action:
bin2
ファイルを宣言するたびに、アクションを作成してファイルを生成する方法を Bazel に指示する必要があります。ctx.actions.write を使用して、指定されたコンテンツを含むファイルを作成します。
def _foo_binary_impl(ctx):
out = ctx.actions.declare_file(ctx.label.name)
ctx.actions.write(
output = out,
content = "Hello\n",
)
コードは有効ですが、何も実行しません。
$ bazel build bin1
Target //:bin1 up-to-date (nothing to build)
ctx.actions.write 関数は、Bazel にファイルの生成方法を教えるアクションを登録しました。ただし、Bazel は実際にリクエストされるまでファイルを作成しません。最後に、ファイルがルールの出力であること、ルール実装で使用される一時ファイルではないことを Bazel に伝えます。
def _foo_binary_impl(ctx):
out = ctx.actions.declare_file(ctx.label.name)
ctx.actions.write(
output = out,
content = "Hello!\n",
)
return [DefaultInfo(files = depset([out]))]
後で、DefaultInfo 関数と depset 関数を確認します。ここでは、最後の行でルールの出力を選択するとします。
Bazel を実行します。
$ bazel build bin1
INFO: Found 1 target...
Target //:bin1 up-to-date:
bazel-bin/bin1
$ cat bazel-bin/bin1
Hello!
ファイルが正常に生成されました。
属性
ルールをより有用なものにするには、attr モジュールを使用して新しい属性を追加し、ルール定義を更新します。
username という文字列属性を追加します。
foo_binary = rule(
implementation = _foo_binary_impl,
attrs = {
"username": attr.string(),
},
)
次に、これを BUILD ファイルに設定します。
foo_binary(
name = "bin",
username = "Alice",
)
コールバック関数で値にアクセスするには、ctx.attr.username を使用します。たとえば、以下の場合です。
def _foo_binary_impl(ctx):
out = ctx.actions.declare_file(ctx.label.name)
ctx.actions.write(
output = out,
content = "Hello {}!\n".format(ctx.attr.username),
)
return [DefaultInfo(files = depset([out]))]
この属性は必須にすることも、デフォルト値を設定することもできます。attr.string のドキュメントをご覧ください。ブール値や整数のリストなど、他のタイプの属性を使用することもできます。
依存関係
attr.label や attr.label_list などの依存関係属性は、属性を所有するターゲットから、属性の値にラベルが表示されるターゲットへの依存関係を宣言します。この種の属性は、ターゲット グラフの基礎を形成します。
BUILD ファイルでは、ターゲット ラベルは //pkg:name などの文字列オブジェクトとして表示されます。実装関数では、ターゲットは Target オブジェクトとしてアクセスできます。たとえば、Target.files を使用して、ターゲットによって返されたファイルを表示します。
複数のファイル
デフォルトでは、ルールによって作成されたターゲットのみが依存関係として表示されることがあります（foo_library() ターゲットなど）。この属性を使用して、入力ファイルであるターゲット（リポジトリ内のソースファイルなど）を受け入れる場合は、allow_files を使用して、受け入れ可能なファイル拡張子のリスト（または任意のファイル拡張子を許可する True）を指定できます。
"srcs": attr.label_list(allow_files = [".java"]),
ファイルのリストには ctx.files.<attribute name> でアクセスできます。たとえば、srcs 属性のファイルリストにアクセスするには、次のようにします。
ctx.files.srcs
1 つのファイル
必要なファイルが 1 つだけの場合は、allow_single_file を使用します。
"src": attr.label(allow_single_file = [".java"])
このファイルは ctx.file.<attribute name> からアクセスできます。
ctx.file.src
テンプレートを使用してファイルを作成する
テンプレートに基づいて .cc ファイルを生成するルールを作成できます。また、ctx.actions.write を使用してルールの実装関数で作成した文字列を出力することもできますが、これには 2 つの問題があります。第 1 に、テンプレートが大きくなるにつれ、テンプレートを別のファイルにまとめ、分析フェーズで大きな文字列を作成しないようにすることで、メモリ効率が向上します。次に、別のファイルを使用するほうがユーザーにとって便利です。代わりに、ctx.actions.expand_template を使用します。これにより、テンプレート ファイルに対して置換が実行されます。
template ファイルを作成して、テンプレート ファイルへの依存関係を宣言します。
def _hello_world_impl(ctx):
out = ctx.actions.declare_file(ctx.label.name + ".cc")
ctx.actions.expand_template(
output = out,
template = ctx.file.template,
substitutions = {"{NAME}": ctx.attr.username},
)
return [DefaultInfo(files = depset([out]))]
hello_world = rule(
implementation = _hello_world_impl,
attrs = {
"username": attr.string(default = "unknown person"),
"template": attr.label(
allow_single_file = [".cc.tpl"],
mandatory = True,
),
},
)
ユーザーは次のようなルールを使用できます。
hello_world(
name = "hello",
username = "Alice",
template = "file.cc.tpl",
)
cc_binary(
name = "hello_bin",
srcs = [":hello"],
)
テンプレートをエンドユーザーに公開せず、常に同じテンプレートを使用する場合は、デフォルト値を設定して属性を非公開にできます。
"_template": attr.label(
allow_single_file = True,
default = "file.cc.tpl",
),
アンダースコアで始まる属性は非公開であり、BUILD ファイル内で設定することはできません。テンプレートは暗黙的な依存関係になりました。すべての hello_world ターゲットは、このファイルと依存関係があります。忘れずに BUILD ファイルを更新して exports_files を使用し、他のパッケージがこのファイルを閲覧できるようにしてください。
exports_files(["file.cc.tpl"])
詳しく見る
- ルールのリファレンス ドキュメントを確認する。
- desets について理解を深めます。
- 他のルールの例を含むサンプル リポジトリをご覧ください。