MODULE.bazel ファイル

問題を報告

MODULE.bazel ファイルで使用できるメソッド。

メンバー

archive_override

None archive_override(module_name, urls, integrity='', strip_prefix='', patches=[], patch_cmds=[], patch_strip=0)

この依存関係が、レジストリではなく、特定の場所にあるアーカイブ ファイル（zip、gzip など）から取得されるように指定します。このディレクティブはルート モジュールでのみ有効になります。つまり、あるモジュールが他のユーザーによって依存関係として使用されている場合、そのモジュール自体のオーバーライドは無視されます。

パラメータ

パラメータ 説明
module_name required
このオーバーライドを適用する Bazel モジュール依存関係の名前。
urls string、または string のイテラブル。 必須
アーカイブの URL。http(s):// または file:// の URL を使用できます。
integrity デフォルトは ''
アーカイブ ファイルで想定されるチェックサム（サブリソースの整合性形式）。
strip_prefix デフォルトは '' です。
抽出されたファイルから削除するディレクトリ接頭辞。
patches 文字列のイテラブル。デフォルトは [] です。
このモジュールに適用するパッチファイルを指すラベルのリスト。パッチファイルは、最上位プロジェクトのソースツリーに存在している必要があります。リスト順に適用されます。
patch_cmds 文字列のイテラブル。デフォルトは [] です。
パッチ適用後に Linux/macOS に適用される Bash コマンドのシーケンス。
patch_strip デフォルトは 0 です。
Unix パッチの --strip 引数と同じです。

bazel_dep

None bazel_dep(name, version='', max_compatibility_level=-1, repo_name='', dev_dependency=False)

別の Bazel モジュールへの直接依存関係を宣言します。

パラメータ

パラメータ 説明
name required
直接的な依存関係として追加するモジュールの名前。
version デフォルトは '' です。
直接的な依存関係として追加されるモジュールのバージョン。
max_compatibility_level デフォルトは -1 です。
直接依存関係として追加されるモジュールでサポートされる最大 compatibility_level。モジュールのバージョンは、サポートされている最小の compatibility_level を意味し、この属性が指定されていない場合は、最大値が暗黙的に指定されます。
repo_name デフォルトは '' です。
この依存関係を表す外部リポジトリの名前。デフォルトはモジュールの名前です。
dev_dependency デフォルトは False です。
true の場合、現在のモジュールがルート モジュールでない場合、または「--ignore_dev_dependency」が有効になっている場合、この依存関係は無視されます。

git_override

None git_override(module_name, remote, commit='', patches=[], patch_cmds=[], patch_strip=0)

依存関係が Git リポジトリの特定の commit から得られるように指定します。このディレクティブはルート モジュールでのみ有効になります。つまり、あるモジュールが他のユーザーによって依存関係として使用されている場合、そのモジュール自体のオーバーライドは無視されます。

パラメータ

パラメータ 説明
module_name required
このオーバーライドを適用する Bazel モジュール依存関係の名前。
remote required
リモート Git リポジトリの URL。
commit デフォルトは '' です。
チェックアウトする commit。
patches 文字列のイテラブル。デフォルトは [] です。
このモジュールに適用するパッチファイルを指すラベルのリスト。パッチファイルは、最上位プロジェクトのソースツリーに存在している必要があります。リスト順に適用されます。
patch_cmds 文字列のイテラブル。デフォルトは [] です。
パッチ適用後に Linux/macOS に適用される Bash コマンドのシーケンス。
patch_strip デフォルトは 0 です。
Unix パッチの --strip 引数と同じです。

local_path_override

None local_path_override(module_name, path)

依存関係がローカル ディスク上の特定のディレクトリから取得されることを指定します。このディレクティブはルート モジュールでのみ有効になります。つまり、あるモジュールが他のユーザーによって依存関係として使用されている場合、そのモジュール自体のオーバーライドは無視されます。

パラメータ

パラメータ 説明
module_name required
このオーバーライドを適用する Bazel モジュール依存関係の名前。
path required
このモジュールがあるディレクトリのパス。

モジュール

None module(name='', version='', compatibility_level=0, repo_name='', bazel_compatibility=[])

現在の Bazel リポジトリで表される Bazel モジュールの特定のプロパティを宣言します。これらのプロパティは、モジュールの重要なメタデータ（名前やバージョンなど）か、現在のモジュールとその依存関係の動作に影響します。

1 回だけ呼び出す必要があります。このモジュールは、このモジュールがルート モジュールである場合にのみ省略できます（他のモジュールに依存しない場合）。

パラメータ

パラメータ 説明
name デフォルトは '' です。
モジュールの名前。このモジュールがルート モジュールである場合にのみ省略できます（別のモジュールに依存しない場合と同様です）。有効なモジュール名は、1）小文字（a ～ z）、数字（0 ～ 9）、ドット（.）、ハイフン（-）、アンダースコア（_）のみを含む。2）先頭は小文字、3）末尾は小文字または数字にする必要があります。
version デフォルトは '' です。
モジュールのバージョン。このモジュールがルート モジュールである場合にのみ省略できます（別のモジュールに依存しない場合と同様です）。バージョンは、緩和した SemVer 形式にする必要があります。詳しくは、ドキュメントをご覧ください。
compatibility_level デフォルトは 0 です。
モジュールの互換性レベル。互換性のない大きな変更が行われるたびに変更する必要があります。SemVer の観点から見ると、これは基本的にモジュールの「メジャー バージョン」です。ただし、バージョンの文字列自体に埋め込まれるのではなく、別のフィールドとして存在します。互換性レベルが異なるモジュールは、名前の異なるモジュールであるかのようにバージョン解決に関与しますが、最終的な依存関係グラフに、名前が同じで互換性レベルが異なる複数のモジュールを含めることはできません（multiple_version_override が有効になっている場合を除く）。詳しくは、こちらのドキュメントをご覧ください。
repo_name デフォルトは '' です。
モジュール自体から見た、このモジュールを表すリポジトリの名前。デフォルトでは、リポジトリの名前はモジュールの名前です。これを指定すると、モジュール名とは異なるリポジトリ名を使用しているプロジェクトの移行が容易になります。
bazel_compatibility 文字列のイテラブル。デフォルトは [] です。
このモジュールと互換性のある Bazel バージョンをユーザーが宣言できる Bazel バージョンのリスト。依存関係の解決には影響しませんが、bzlmod はこの情報を使用して、現在の Bazel バージョンに互換性があるかどうかを確認します。この値の形式は、制約値をカンマで区切った文字列です。次の 3 つの制約がサポートされています。<=X.X.X: Bazel のバージョンは X.X.X 以降である必要があります。新しいバージョンで互換性のない変更が確認されている場合に使用されます。>=X.X.X: Bazel のバージョンは X.X.X 以降である必要があります。X.X.X からのみ使用可能な機能に依存している場合に使用します。-X.X.X: Bazel バージョン X.X.X に互換性がありません。不具合が生じるバグが X.X.X にあり、それ以降のバージョンで修正された場合に使用します。

multiple_version_override

None multiple_version_override(module_name, versions, registry='')

依存関係は引き続きレジストリから取得されるべきだが、その依存関係の複数のバージョンの共存を許可することを指定します。詳しくは、こちらのドキュメントをご覧ください。このディレクティブはルート モジュールでのみ有効になります。つまり、あるモジュールが他のユーザーによって依存関係として使用されている場合、そのモジュール自体のオーバーライドは無視されます。

パラメータ

パラメータ 説明
module_name required
このオーバーライドを適用する Bazel モジュール依存関係の名前。
versions 文字列のイテラブル。 必須
共存を許可するバージョンを明示的に指定します。これらのバージョンは、依存関係グラフの事前選択にすでに存在している必要があります。このモジュールに対する依存関係は、同じ互換性レベルで許容される、最も近いバージョンに「アップグレード」されます。一方、依存関係が同じ互換性レベルで許可されているバージョンよりも高いバージョンである場合、エラーが発生します。
registry デフォルトは ''
このモジュールのレジストリをオーバーライドします。デフォルトのレジストリ リストからこのモジュールを見つける代わりに、指定されたレジストリを使用する必要があります。

register_execution_platforms

None register_execution_platforms(dev_dependency=False, *platform_labels)

このモジュールが選択されたときに登録する、定義済みの実行プラットフォームを指定します。絶対ターゲット パターン（@ または // で始まる）にする必要があります。詳細については、ツールチェーンの解決をご覧ください。

パラメータ

パラメータ 説明
dev_dependency デフォルトは False です。
true の場合、現在のモジュールがルート モジュールでない場合、または「--ignore_dev_dependency」が有効になっている場合、実行プラットフォームは登録されません。
platform_labels 文字列のシーケンス。 必須
登録するプラットフォームのラベル。

register_toolchains

None register_toolchains(dev_dependency=False, *toolchain_labels)

このモジュールが選択されたときに登録する、定義済みツールチェーンを指定します。絶対ターゲット パターン（@ または // で始まる）にする必要があります。詳細については、ツールチェーンの解決をご覧ください。

パラメータ

パラメータ 説明
dev_dependency デフォルトは False です。
true の場合、現在のモジュールがルート モジュールでない場合、または「--ignore_dev_dependency」が有効になっている場合、ツールチェーンは登録されません。
toolchain_labels 文字列のシーケンス。必須
登録するツールチェーンのラベル。ラベルには :all を含めることができます。この場合、パッケージ内のすべてのツールチェーンを提供するターゲットは名前の辞書順で登録されます。

single_version_override

None single_version_override(module_name, version='', registry='', patches=[], patch_cmds=[], patch_strip=0)

依存関係は引き続きレジストリから取得されるものの、そのバージョンを固定するか、レジストリがオーバーライドされるか、適用されるパッチのリストを指定するように指定します。このディレクティブはルート モジュールでのみ有効になります。つまり、あるモジュールが他のユーザーによって依存関係として使用されている場合、そのモジュール自体のオーバーライドは無視されます。

パラメータ

パラメータ 説明
module_name required
このオーバーライドを適用する Bazel モジュール依存関係の名前。
version デフォルトは '' です。
依存関係グラフでこのモジュールの宣言されたバージョンをオーバーライドします。つまり、このモジュールはオーバーライド バージョンに「固定」されます。オーバーライドする対象がレジストリまたはパッチの場合は、この属性を省略できます。
registry デフォルトは ''
このモジュールのレジストリをオーバーライドします。デフォルトのレジストリ リストからこのモジュールを見つける代わりに、指定されたレジストリを使用する必要があります。
patches 文字列のイテラブル。デフォルトは [] です。
このモジュールに適用するパッチファイルを指すラベルのリスト。パッチファイルは、最上位プロジェクトのソースツリーに存在している必要があります。リスト順に適用されます。
patch_cmds 文字列のイテラブル。デフォルトは [] です。
パッチ適用後に Linux/macOS に適用される Bash コマンドのシーケンス。
patch_strip デフォルトは 0 です。
Unix パッチの --strip 引数と同じです。

use_extension

module_extension_proxy use_extension(extension_bzl_file, extension_name, *, dev_dependency=False, isolate=False)

モジュール拡張機能を表すプロキシ オブジェクトを返します。そのメソッドを呼び出してモジュール拡張機能タグを作成できます。

パラメータ

パラメータ 説明
extension_bzl_file required
モジュール拡張子を定義する Starlark ファイルのラベル。
extension_name required
使用するモジュール拡張機能の名前。この名前のシンボルは、Starlark ファイルによってエクスポートする必要があります。
dev_dependency デフォルトは False です。
true の場合、現在のモジュールがルート モジュールでない場合、または「--ignore_dev_dependency」が有効になっている場合、モジュール拡張機能の使用は無視されます。
isolate デフォルトは False です。
試験運用版。このパラメータは試験運用版で、いつでも変更できます。これに依存しないでください。---experimental_isolated_extension_usages
を true に設定すると、試験運用版に基づいて有効にできます。true の場合、このモジュール拡張機能の使用は、このモジュールと他のモジュールの両方で他のすべての使用から分離されます。この用途用に作成されたタグは、他の用途には影響せず、この用途のために拡張機能によって生成されたリポジトリは、拡張機能によって生成された他のすべてのリポジトリとは区別されます。

このパラメータは現在試験運用版であり、--experimental_isolated_extension_usages フラグでのみ使用できます。

use_repo

None use_repo(extension_proxy, *args, **kwargs)

指定したモジュール拡張機能によって生成された 1 つ以上のリポジトリを、現在のモジュールのスコープにインポートします。

パラメータ

パラメータ 説明
extension_proxy required
use_extension 呼び出しによって返されるモジュール拡張プロキシ オブジェクト。
args required
インポートするリポジトリの名前。
kwargs required
現在のモジュールのスコープにインポートする特定のリポジトリを異なる名前で指定します。キーは現在のスコープで使用する名前にする必要がありますが、値はモジュール拡張機能によってエクスポートされた元の名前にする必要があります。

use_repo_rule

repo_rule_proxy use_repo_rule(repo_rule_bzl_file, repo_rule_name)

MODULE.bazel ファイルでリポジトリ ルールとして 1 回以上直接呼び出すことができるプロキシ値を返します。この方法で作成されたリポジトリは、プロキシの name 属性を使用して宣言された名前で、現在のモジュールにのみ公開されます。プロキシで暗黙的なブール値 dev_dependency 属性を使用して、現在のモジュールがルート モジュールである場合にのみ特定のリポジトリが作成されることを示すこともできます。

パラメータ

パラメータ 説明
repo_rule_bzl_file required
Repo ルールを定義する Starlark ファイルのラベル。
repo_rule_name required
使用するリポジトリ ルールの名前。この名前のシンボルは、Starlark ファイルによってエクスポートする必要があります。