関数

目次

• package
• package_group
• exports_files
• glob
• 選択
• サブパッケージ

パッケージ

package(default_deprecation, default_package_metadata, default_testonly, default_visibility, features)

この関数は、パッケージ内のすべてのルールに適用されるメタデータを宣言します。パッケージ（BUILD ファイル）内で最大 1 回使用されます。

package() 関数は、ファイルの先頭にあるすべての load() ステートメントの直後、ルールの前に呼び出す必要があります。

引数

例

package(default_visibility = ["//foo:target"])

package_group

package_group(name, packages, includes)

この関数は、パッケージのセットを定義し、そのセットにラベルを関連付けます。ラベルは visibility 属性で参照できます。

パッケージ グループは主に公開設定の制御に使用されます。公開されているターゲットは、ソースツリー内のすべてのパッケージから参照できます。非公開で公開されるターゲットは、独自のパッケージ（サブパッケージではない）内でのみ参照できます。これらの極端な例の間には、ターゲットが独自のパッケージと、1 つ以上のパッケージ グループで記述されたパッケージへのアクセスを許可する場合があります。公開設定システムの詳細については、公開設定属性をご覧ください。

特定のパッケージがグループに属すると見なされるのは、そのパッケージが packages 属性と一致する場合、または includes 属性で指定されている他のパッケージ グループのいずれかにすでに含まれている場合です。

パッケージ グループは技術的にはターゲットですが、ルールによって作成されず、それ自体に可視性保護はありません。

引数

例

次の package_group 宣言では、トロピカル フルーツを含む「tropical」というパッケージ グループを指定しています。

package_group(
    name = "tropical",
    packages = [
        "//fruits/mango",
        "//fruits/orange",
        "//fruits/papaya/...",
    ],
)

次の宣言では、架空のアプリケーションのパッケージ グループを指定します。

package_group(
    name = "fooapp",
    includes = [
        ":controller",
        ":model",
        ":view",
    ],
)

package_group(
    name = "model",
    packages = ["//fooapp/database"],
)

package_group(
    name = "view",
    packages = [
        "//fooapp/swingui",
        "//fooapp/webui",
    ],
)

package_group(
    name = "controller",
    packages = ["//fooapp/algorithm"],
)

exports_files

exports_files([label, ...], visibility, licenses)

exports_files() には、このパッケージに属するファイルのうち、他のパッケージにエクスポートされるファイルのリストを指定します。

パッケージの BUILD ファイルで、別のパッケージに属するソースファイルを直接参照できるのは、exports_files() ステートメントで明示的にエクスポートされている場合のみです。詳しくは、ファイルの公開設定をご覧ください。

以前の動作として、ルールへの入力として指定されたファイルも、フラグ --incompatible_no_implicit_file_export が反転されるまで、デフォルトの公開設定でエクスポートされます。ただし、この動作は信頼せず、積極的に移行する必要があります。

引数

引数は、現在のパッケージ内のファイル名のリストです。可視性の宣言を指定することもできます。この場合、ファイルは指定されたターゲットに表示されます。公開設定が指定されていない場合、パッケージのデフォルトの公開設定が package 関数で指定されている場合でも、すべてのパッケージにファイルが表示されます。ライセンスを指定することもできます。

例

次の例では、test_data パッケージのテキスト ファイルである golden.txt をエクスポートして、他のパッケージがテストの data 属性などで使用できるようにします。

# from //test_data/BUILD

exports_files(["golden.txt"])

glob

glob(include, exclude=[], exclude_directories=1, allow_empty=True)

Glob は、特定のパスパターンに一致するすべてのファイルを検索し、そのパスの新しい変更可能な並べ替え済みリストを返すヘルパー関数です。Glob は、独自のパッケージ内のファイルのみを検索し、ソースファイルのみを検索します（生成されたファイルや他のターゲットではありません）。

ファイルのパッケージ相対パスが include パターンのいずれかに一致し、exclude パターンのいずれにも一致しない場合、ソースファイルのラベルが結果に含まれます。

include リストと exclude リストには、現在のパッケージを基準とするパスパターンが含まれています。すべてのパターンは、1 つ以上のパスセグメントで構成されます。Unix パスと同様に、これらのセグメントは / で区切られます。セグメントには * ワイルドカードを含めることができます。これは、ディレクトリ区切り文字 / を除く、パスセグメント内の任意の部分文字列（空の部分文字列も含む）に一致します。このワイルドカードは、1 つのパスセグメント内で複数回使用できます。また、** ワイルドカードは 0 個以上の完全なパスセグメントに一致しますが、スタンドアロンのパスセグメントとして宣言する必要があります。

• foo/bar.txt は、このパッケージの foo/bar.txt ファイルと完全に一致します。
• foo/*.txt は、ファイルが .txt で終わっている場合、foo/ ディレクトリ内のすべてのファイルに一致します（foo/ がサブパッケージでない限り）。
• foo/a*.htm* は、foo/ ディレクトリ内の a で始まり、任意の文字列（空でも可）が続き、.htm が続き、別の任意の文字列（foo/axx.htm、foo/a.html、foo/axxx.html など）で終わるすべてのファイルに一致します。
• **/a.txt は、このパッケージのすべてのサブディレクトリ内のすべての a.txt ファイルに一致します。
• **/bar/**/*.txt は、結果パスのディレクトリの少なくとも 1 つが bar と呼ばれている場合（xxx/bar/yyy/zzz/a.txt、bar/a.txt、**（** はゼロ セグメントにも一致します）など）、このパッケージのすべてのサブディレクトリ内のすべての .txt ファイルに一致します。bar/zzz/a.txt
• ** は、このパッケージのすべてのサブディレクトリ内のすべてのファイルと一致します。
• foo**/a.txt は、** がセグメントとして単独で存在する必要があるため、無効なパターンです。

exclude_directories 引数が有効になっている（1 に設定されている）場合、ディレクトリ タイプのファイルは結果から除外されます（デフォルト 1）。

allow_empty 引数が False に設定されている場合、結果が空のリストになる場合は、glob 関数はエラーになります。

重要な制限と注意事項がいくつかあります。

1. glob() は BUILD ファイルの評価中に実行されるため、glob() はソースツリー内のファイルのみと一致し、生成されたファイルとは一致しません。ソースファイルと生成ファイルの両方を必要とするターゲットをビルドする場合は、生成ファイルの明示的なリストを glob に追加する必要があります。:mylib と :gen_java_srcs を使用した例をご覧ください。

2. ルールの名前が一致するソースファイルと同じ名前の場合、ルールはファイルを「シャドー」します。

   glob() はパスのリストを返すため、他のルールの属性（srcs = glob(["*.cc"]) など）で glob() を使用すると、一致したパスを明示的にリストする場合と同じ効果があります。たとえば、glob() が ["Foo.java", "bar/Baz.java"] を生成する場合でも、パッケージに「Foo.java」というルールがある場合（これは許可されていますが、Bazel は警告します）、glob() のコンシューマは「Foo.java」ファイルではなく「Foo.java」ルール（その出力）を使用します。詳しくは、GitHub の問題 #10395 をご覧ください。

3. glob は、サブディレクトリ内のファイルと一致する場合があります。サブディレクトリ名にはワイルドカードを使用できます。ただし...

4. ラベルはパッケージの境界を越えることはできません。glob はサブパッケージ内のファイルと一致しません。

   たとえば、パッケージ x の glob 式 **/*.cc には、x/y がパッケージ（x/y/BUILD または package-path の他の場所）として存在する場合、x/y/z.cc は含まれません。つまり、glob 式の結果は実際には BUILD ファイルの存在に依存します。つまり、x/y というパッケージが存在しない場合や、--deleted_packages フラグを使用して削除済みとしてマークされている場合、同じ glob 式に x/y/z.cc が含まれます。

5. 上記の制限は、使用するワイルドカードに関係なく、すべての glob 式に適用されます。
6. ファイル名が . で始まる隠しファイルは、** ワイルドカードと * ワイルドカードの両方に完全に一致します。非表示のファイルを複合パターンと照合するには、パターンを . で始める必要があります。たとえば、* と .*.txt は .foo.txt と一致しますが、*.txt は一致しません。非表示のディレクトリも同様に照合されます。非表示のディレクトリには、入力として必要のないファイルが含まれている可能性があります。また、不要なグルーピング ファイルの数とメモリ消費量が増加する可能性があります。非表示のディレクトリを除外するには、それらを「除外」リスト引数に追加します。
7. 「**」ワイルドカードには 1 つの特殊なケースがあります。パターン "**" がパッケージのディレクトリパスと一致しないケースです。つまり、glob(["**"], exclude_directories = 0) は、現在のパッケージのディレクトリの下にあるすべてのファイルとディレクトリと厳密に、転送で一致します（ただし、サブパッケージのディレクトリには入りません。この点については、前述の注記をご覧ください）。

一般に、グロブパターンに単なる「*」を使用するのではなく、適切な拡張子（*.html など）を指定するようにしてください。より明示的な名前は、自己ドキュメント化と、バックアップ ファイルや emacs/vi/... の自動保存ファイルと誤って一致しないようにする両方の目的を果たします。

ビルドルールを記述するときに、glob の要素を列挙できます。これにより、たとえば入力ごとに個別のルールを生成できます。下記の拡張された glob の例をご覧ください。

glob の例

このディレクトリ内のすべての Java ファイルと、:gen_java_srcs ルールによって生成されたすべてのファイルからビルドされた Java ライブラリを作成します。

java_library(
    name = "mylib",
    srcs = glob(["*.java"]) + [":gen_java_srcs"],
    deps = "...",
)

genrule(
    name = "gen_java_srcs",
    outs = [
        "Foo.java",
        "Bar.java",
    ],
    ...
)

ディレクトリ testdata 内のすべての txt ファイルを含めます（experimental.txt を除く）。testdata のサブディレクトリにあるファイルは含まれません。これらのファイルを含める場合は、再帰的な glob（**）を使用します。

sh_test(
    name = "mytest",
    srcs = ["mytest.sh"],
    data = glob(
        ["testdata/*.txt"],
        exclude = ["testdata/experimental.txt"],
    ),
)

再帰 glob の例

testdata ディレクトリとそのサブディレクトリ（およびそのサブディレクトリなど）内のすべての txt ファイルに依存します。BUILD ファイルを含むサブディレクトリは無視されます。（上記の制限事項と注意事項を参照）。

sh_test(
    name = "mytest",
    srcs = ["mytest.sh"],
    data = glob(["testdata/**/*.txt"]),
)

このディレクトリ内のすべての Java ファイルと、パスに testing というディレクトリが含まれていないすべてのサブディレクトリからビルドされたライブラリを作成します。このパターンは、ビルドの増分性を低下させ、ビルド時間を長くする可能性があるため、可能な限り回避する必要があります。

java_library(
    name = "mylib",
    srcs = glob(
        ["**/*.java"],
        exclude = ["**/testing/**"],
    ),
)

拡張された Glob の例

現在のディレクトリに *_test.cc の個別の genrule を作成し、ファイル内の行数をカウントします。

# Conveniently, the build language supports list comprehensions.
[genrule(
    name = "count_lines_" + f[:-3],  # strip ".cc"
    srcs = [f],
    outs = ["%s-linecount.txt" % f[:-3]],
    cmd = "wc -l $< >$@",
 ) for f in glob(["*_test.cc"])]

上記のビルド ファイルがパッケージ //foo にあり、そのパッケージに 3 つの一致するファイル（a_test.cc、b_test.cc、c_test.cc）が含まれている場合、bazel query '//foo:all' を実行すると、生成されたすべてのルールが一覧表示されます。

$ bazel query '//foo:all' | sort
//foo:count_lines_a_test
//foo:count_lines_b_test
//foo:count_lines_c_test

選択

select(
    {conditionA: valuesA, conditionB: valuesB, ...},
    no_match_error = "custom message"
)

select() は、ルール属性を構成可能にするヘルパー関数です。これは、ほぼすべての属性割り当ての右側を置き換えることができるため、その値はコマンドラインの Bazel フラグに依存します。 これを使用して、たとえば、プラットフォーム固有の依存関係を定義したり、ルールが「デベロッパー」モードと「リリース」モードのどちらでビルドされたかに応じて異なるリソースを埋め込むことができます。

基本的な使用方法は次のとおりです。

sh_binary(
    name = "mytarget",
    srcs = select({
        ":conditionA": ["mytarget_a.sh"],
        ":conditionB": ["mytarget_b.sh"],
        "//conditions:default": ["mytarget_default.sh"]
    })
)

これにより、通常のラベルリストの割り当てを、構成条件を一致する値にマッピングする select 呼び出しに置き換えることで、sh_binary の srcs 属性を構成可能にします。各条件は、config_setting または constraint_value を参照するラベルです。ターゲットの構成が期待される値のセットに一致する場合は「一致」します。mytarget#srcs の値は、現在の呼び出しに一致するラベルリストになります。

注:

• どの呼び出しでも、1 つの条件のみが選択されます。
• 複数の条件が一致し、そのうちの 1 つが他の条件の専門分野である場合、専門分野が優先されます。条件 B が条件 A と同じフラグと制約値をすべて持ち、さらにフラグまたは制約値が追加されている場合、条件 B は条件 A の特殊化と見なされます。また、以下の例 2 に示すような順序付けはスペシャライゼーション解決では設計されていません。
• 複数の条件が一致し、1 つが他のすべての条件の特殊化でない場合、すべての条件が同じ値に解決されない限り、Bazel はエラーで失敗します。
• 他の条件が一致しない場合、特別な疑似ラベル //conditions:default が一致と見なされます。この条件を省略した場合、エラーを回避するには他のルールが一致している必要があります。
• select は、より大きな属性割り当てに埋め込むことができます。したがって、srcs = ["common.sh"] + select({ ":conditionA": ["myrule_a.sh"], ...}) と srcs = select({ ":conditionA": ["a.sh"]}) + select({ ":conditionB": ["b.sh"]}) は有効な式です。
• select はほとんどの属性で動作しますが、すべてではありません。互換性のない属性は、ドキュメントで nonconfigurable とマークされています。

  サブパッケージ

  subpackages(include, exclude=[], allow_empty=True)

  subpackages() は、ファイルとディレクトリではなくサブパッケージを一覧表示する glob() に似たヘルパー関数です。glob() と同じパスパターンを使用し、現在読み込み中の BUILD ファイルの直接の子孫であるサブパッケージに一致します。包含パターンと除外パターンの詳細な説明と例については、glob をご覧ください。

  返されるサブパッケージのリストは昇順で並べられ、exclude ではなく include の指定されたパターンに一致する、現在の読み込みパッケージを基準としたパスが含まれます。

  例

  次の例では、パッケージ foo/BUILD の直接サブパッケージをすべて一覧表示します。

  # The following BUILD files exist:
  # foo/BUILD
  # foo/bar/baz/BUILD
  # foo/sub/BUILD
  # foo/sub/deeper/BUILD
  #
  # In foo/BUILD a call to
  subs = subpackages(include = ["**"])
  
  # results in subs == ["sub", "bar/baz"]
  #
  # 'sub/deeper' is not included because it is a subpackage of 'foo/sub' not of
  # 'foo'
  

  一般に、この関数を直接呼び出すのではなく、skylib の「subpackages」モジュールを使用することをおすすめします。