Globals

グローバル環境に登録されたオブジェクト、関数、モジュール。

メンバー

すべて

bool all(elements)

すべての要素が True と評価された場合、またはコレクションが空の場合に true を返します。要素は bool 関数を使用してブール値に変換されます。
all(["hello", 3, True]) == True
all([-1, 0, 1]) == False

パラメータ

パラメータ 説明
elements required
文字列または要素のコレクション。

analysis_test_transition

transition analysis_test_transition(settings)

analytics-test ルールの依存関係に適用する構成移行を作成します。この移行は、analysis_test = True を含むルールの属性にのみ適用できます。このようなルールには機能上の制限があります(依存関係ツリーのサイズに制限があるなど)。そのため、この関数を使用して作成される遷移は、transition を使用して作成される遷移に比べると潜在的スコープは制限されます。

この関数は主に、分析テスト フレームワークのコアライブラリを容易にするように設計されています。ベスト プラクティスについては、ドキュメント(またはその実装)をご覧ください。

パラメータ

パラメータ 説明
settings required
この構成の移行によって設定される構成設定に関する情報を含む辞書。キーはビルド設定ラベルで、値は遷移後の新しい値です。その他の設定に変更はありません。これを使用して、分析テストに合格するために設定する必要がある特定の構成設定を宣言します。

任意

bool any(elements)

少なくとも 1 つの要素が True と評価された場合に true を返します。要素は bool 関数を使用してブール値に変換されます。
any([-1, 0, 1]) == True
any([False, 0, ""]) == False

パラメータ

パラメータ 説明
elements required
文字列または要素のコレクション。

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; or Iterable of strings(必須)
アーカイブの URL。http(s):// または file:// URL です。
integrity default = ''
アーカイブ ファイルの予想されるチェックサム(サブリソースの整合性形式)。
strip_prefix default = ''
抽出されたファイルから削除するディレクトリ接頭辞。
patches Iterable of strings; default = []
このモジュールに適用するパッチファイルを指すラベルのリスト。パッチファイルは、最上位プロジェクトのソースツリーに配置する必要があります。これらはリストの順序で適用されます。
patch_cmds Iterable of strings; default = []
パッチ適用後に Linux/Macos に適用される Bash コマンドのシーケンス。
patch_strip default = 0
Unix パッチの --strip 引数と同じです。

アスペクト

Aspect aspect(implementation, attr_aspects=[], attrs=None, required_providers=[], required_aspect_providers=[], provides=[], requires=[], fragments=[], host_fragments=[], toolchains=[], incompatible_use_toolchain_transition=False, doc='', *, apply_to_generating_rules=False, exec_compatible_with=[], exec_groups=None)

新しい側面を作成します。この関数の結果は、グローバル値で保存する必要があります。詳細については、アスペクトの概要をご覧ください。

パラメータ

パラメータ 説明
implementation 必須
この側面を実装する Starlark 関数。Target(アスペクトが適用されるターゲット)と ctx(ターゲットの作成元となったルール コンテキスト)の 2 つのパラメータを指定します。ターゲットの属性は ctx.rule フィールドで確認できます。この関数は、ターゲットに側面を適用するたびに、分析フェーズで評価されます。
attr_aspects sequence of strings; default = []
属性名のリスト。アスペクトは、これらの名前を持つターゲットの属性で指定された依存関係に沿って伝播します。ここで一般的な値は depsexports です。リストには、ターゲットのすべての依存関係に沿って伝播する単一の文字列 "*" を含めることもできます。
attrs dict; or None; default = None
アスペクトのすべての属性を宣言する辞書。これは属性名から「attr.label」や「attr.string」などの属性オブジェクトにマッピングされます(attr モジュールを参照)。アスペクト属性は、実装関数で ctx パラメータのフィールドとして利用できます。

_ で始まる暗黙的な属性は、デフォルト値を持ち、label 型または label_list 型である必要があります。

明示的な属性には string 型を指定し、values 制限を使用する必要があります。明示的な属性を使用すると、制限に従って、同じ名前、型、有効な値の属性を持つルールにのみ使用が制限されます。

required_providers default = []
この属性を使用すると、そのルールが必要なプロバイダをアドバタイズするターゲットのみに伝播を制限できます。値は、個々のプロバイダまたはプロバイダのリストのいずれかを含むリストである必要があります。両方を含めることはできません。たとえば、[[FooInfo], [BarInfo], [BazInfo, QuxInfo]] は有効な値ですが、[FooInfo, BarInfo, [BazInfo, QuxInfo]] は無効です。

ネストされたプロバイダのリストは、プロバイダの 1 つのリストを含むリストに自動的に変換されます。つまり、[FooInfo, BarInfo] は自動的に [[FooInfo, BarInfo]] に変換されます。

特定のルール(some_rule など)のターゲットを特定のアスペクトに表示するには、some_rule で、少なくとも 1 つの必須プロバイダ リストにあるすべてのプロバイダをアドバタイズする必要があります。たとえば、アスペクトの required_providers[[FooInfo], [BarInfo], [BazInfo, QuxInfo]] の場合、このアスペクトは、some_ruleFooInfo または BarInfo のいずれか、または BazInfoQuxInfo の両方を提供した場合にのみ、some_rule ターゲットを認識できます。

required_aspect_providers default = []
この属性を使用すると、他の側面を検査できます。値は、個々のプロバイダまたはプロバイダのリストのいずれかを含むリストである必要があります。両方を含めることはできません。たとえば、[[FooInfo], [BarInfo], [BazInfo, QuxInfo]] は有効な値ですが、[FooInfo, BarInfo, [BazInfo, QuxInfo]] は無効です。

ネストされたプロバイダのリストは、プロバイダの 1 つのリストを含むリストに自動的に変換されます。つまり、[FooInfo, BarInfo] は自動的に [[FooInfo, BarInfo]] に変換されます。

このアスペクトに別のアスペクト(other_aspect など)を可視化するには、other_aspect で、少なくとも 1 つのリストにあるすべてのプロバイダを指定する必要があります。[[FooInfo], [BarInfo], [BazInfo, QuxInfo]] の例では、このアスペクトが other_aspect を参照できるのは、other_aspectFooInfo または BarInfo、または BazInfoQuxInfo の両方または両方を提供している場合に限られます。

provides default = []
実装関数が返すプロバイダのリスト。

実装関数で、ここにリストされているいずれかのタイプのプロバイダが戻り値から除外されている場合、エラーになります。ただし、実装関数がここに記載されていない追加のプロバイダを返す場合があります。

リストの各要素は、provider() によって返される *Info オブジェクトです。ただし、以前のプロバイダは文字列名で表されます。

requires sequence of Aspects; default = []
このアスペクトの前に伝播する必要があるアスペクトのリスト。
fragments sequence of strings; default = []
ターゲット構成でアスペクトが要求する構成フラグメントの名前のリスト。
host_fragments sequence of strings; default = []
アスペクトがホスト構成で必要とする構成フラグメントの名前のリスト。
toolchains sequence; default = []
設定すると、このルールに必要なツールチェーンのセットです。リストには、String、Label、StarlarkToolchainTypeApi の各オブジェクトを任意の組み合わせで含めることができます。ツールチェーンは、現在のプラットフォームをチェックすることで検出され、ctx.toolchain を介してルール実装に提供されます。
incompatible_use_toolchain_transition default = False
非推奨。これは使用されなくなったため、削除する必要があります。
doc default = ''
ドキュメント生成ツールで抽出できる特徴の説明。
apply_to_generating_rules default = False
true の場合、アスペクトは出力ファイルに適用されるときに、代わりに出力ファイルの生成ルールに適用されます。

たとえば、アスペクトが属性「deps」を通じて推移的に伝播され、それがターゲットの「alpha」に適用されるとします。「alpha」に「deps = [':beta_output']」がある場合、「beta_output」はターゲットの「beta」の宣言された出力です。「beta」には、アスペクトの「alpha」が「alpha」から "charlie] が True に指定され、「alpha」が 「alpha」から 「charlie」が false に引き継がれます。

デフォルトは False です。

exec_compatible_with sequence of strings; default = []
この特徴のすべてのインスタンスに適用される実行プラットフォームの制約のリスト。
exec_groups dict; or None; default = なし
実行グループ名(文字列)の exec_group への辞書。設定すると、アスペクトが単一のインスタンス内の複数の実行プラットフォームでアクションを実行できるようになります。詳しくは、実行グループのドキュメントをご覧ください。

bazel_dep

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

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

パラメータ

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

bind

None bind(name, actual=None)

警告: bind() の使用はおすすめしません。問題とその代替手段に関する詳しい説明については、バインドの削除を検討するをご覧ください。

//external パッケージ内のターゲットにエイリアスを指定します。

パラメータ

パラメータ 説明
name 必須
エイリアス名として機能する「//external」以下のラベル
actual string; or None; default = None
エイリアスを設定する実際のラベル

bool

bool bool(x=False)

ブール値のコンストラクタ。オブジェクトが NoneFalse、空の文字列("")、数値 0、または空のコレクション(()[] など)である場合、False を返します。それ以外の場合は True を返します。

パラメータ

パラメータ 説明
x default = False
変換する変数。

configuration_field

LateBoundDefault configuration_field(fragment, name)

label タイプの属性の遅延バインドデフォルト値を参照します。値を決定する前に構成を作成する必要がある場合は、値「遅延制限」になります。この属性を値として使用する属性はすべて、非公開にする必要があります。

使用例:

ルール属性の定義:

'_foo': attr.label(default=configuration_field(fragment='java', name='toolchain'))

ルール実装内のアクセス:

  def _rule_impl(ctx):
    foo_info = ctx.attr._foo
    ...

パラメータ

パラメータ 説明
fragment required
遅延バインド値を含む構成フラグメントの名前。
name required
構成フラグメントから取得する値の名前。

依存関係

depset depset(direct=None, order="default", *, transitive=None)

depset を作成します。direct パラメータは、依存関係セットの直接要素のリストです。transitive パラメータは、その要素が、作成されたデプセットの間接要素になるデプセットのリストです。depset をリストに変換したときに要素が返される順序は、order パラメータで指定されます。詳細については、依存関係の概要をご覧ください。

依存関係のすべての要素(直接的および間接的)は、式 type(x) で取得される同じ型でなければなりません。

反復処理において重複を排除するためにハッシュベースのセットが使用されるため、depset のすべての要素をハッシュ可能にする必要があります。ただし、この不変条件は現在、すべてのコンストラクタで一貫してチェックされているわけではありません。整合性チェックを有効にするには、--compatible_always_check_depset_elements フラグを使用します。これは今後のリリースでのデフォルトの動作になります。問題 10313 をご覧ください。

また、現時点では要素を変更できない必要がありますが、今後この制限は緩和される予定です。

作成された依存関係の順序は、transitive 依存関係の順序と互換性が必要です。"default" の注文は他の注文と互換性があり、他のすべての注文は自身にのみ対応しています。

下位互換性/上位互換性に関する注意。この関数は現在、位置的な items パラメータを受け入れます。これは非推奨で、今後削除される予定です。削除後は、directdepset 関数の唯一の位置パラメータになります。したがって、次の呼び出しはどちらも同等であり、将来にわたって使用しても問題ありません。

depset(['a', 'b'], transitive = [...])
depset(direct = ['a', 'b'], transitive = [...])

パラメータ

パラメータ 説明
direct sequence; or None; default = None
依存関係の direct 要素のリスト。
order default = "default"
新しい依存関係の走査戦略。設定可能な値については、こちらをご覧ください。
transitive sequence of depsets; or None; default = None
その要素が depset の間接要素になる依存関係のリスト。

dict

dict dict(pairs=[], **kwargs)

オプションの位置引数とキーワード引数のセット(省略可)から辞書を作成します。同じキーが複数回指定された場合は、最後の値が使用されます。キーワード引数で指定したエントリは、位置引数で指定したエントリより後であると見なされます。

パラメータ

パラメータ 説明
pairs default = []
要素のそれぞれの長さが 2(key, value)である辞書またはイテラブル。
kwargs required
追加エントリの辞書。

dir

list dir(x)

パラメータ オブジェクトの属性とメソッドの名前で、文字列のリストを返します。

パラメータ

パラメータ 説明
x required
確認するオブジェクト。

列挙

list enumerate(list, start=0)

インデックス(int)と入力シーケンスのアイテムを含むペア(2 要素タプル)のリストを返します。
enumerate([24, 21, 84]) == [(0, 24), (1, 21), (2, 84)]

パラメータ

パラメータ 説明
list 必要な
入力シーケンス。
start default = 0
開始インデックス。

exec_group

exec_group exec_group(toolchains=[], exec_compatible_with=[], copy_from_rule=False)

ルールの実装時に特定の実行プラットフォーム用のアクションを作成するために使用できる実行グループを作成します。

パラメータ

パラメータ 説明
toolchains sequence; default = []
この実行グループに必要なツールチェーンのセット。リストには、String、Label、StarlarkToolchainTypeApi の各オブジェクトを任意の組み合わせで含めることができます。
exec_compatible_with sequence of strings; default = []
実行プラットフォームの制約のリスト。
copy_from_rule default = False
true に設定すると、この実行可能ファイルは、このグループが関連付けられているルールのツールチェーンと制約を継承します。他の文字列に設定すると、エラーがスローされます。

fail

None fail(msg=None, attr=None, *args)

実行がエラーで失敗します。

パラメータ

パラメータ 説明
msg default = None
非推奨: 代わりに位置引数を使用してください。この引数は、暗黙的な先頭の位置引数のように機能します。
attr string; or None; default = None
非推奨。この文字列を含むオプションの接頭辞がエラー メッセージに追加されます。
args required
エラー メッセージに表示される、str でフォーマットされ、スペースで結合された値のリスト。

float

float float(x=unbound)

x を浮動小数点値として返します。
  • x がすでに浮動小数点数である場合、float はその値を変更せずに返します。
  • x がブール値の場合、float は True に対して 1.0、False に対して 0.0 を返します。
  • x が int の場合、float は x に最も近い有限浮動小数点値を返します。大きさが大きすぎる場合はエラーを返します。
  • x が文字列の場合は、有効な浮動小数点リテラルであるか、NaNInf、または Infinity と等しい(大文字と小文字を区別しない)必要があります。必要に応じて、先頭に + または - 記号を付けることもできます。
その他の値を指定するとエラーになります。引数がない場合、float() は 0.0 を返します。

パラメータ

パラメータ 説明
x default = unbound
変換する値。

getattr

unknown getattr(x, name, default=unbound)

指定された名前の構造体のフィールドが存在する場合は、それを返します。それ以外の場合は、default を返すか(指定されている場合)、エラーをスローします。getattr(x, "foobar")x.foobar と同等です。
getattr(ctx.attr, "myattr")
getattr(ctx.attr, "myattr", "mydefault")

パラメータ

パラメータ 説明
x required
属性がアクセスされる構造体。
name required
構造体属性の名前。
default default = unbound
構造体に指定された名前の属性がない場合に返されるデフォルト値。

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 default = ''
チェックアウトする commit。
patches Iterable of strings; default = []
このモジュールに適用するパッチファイルを指すラベルのリスト。パッチファイルは、最上位プロジェクトのソースツリーに配置する必要があります。これらはリストの順序で適用されます。
patch_cmds Iterable of strings; default = []
パッチ適用後に Linux/Macos に適用される Bash コマンドのシーケンス。
patch_strip default = 0
Unix パッチの --strip 引数と同じです。

hasattr

bool hasattr(x, name)

オブジェクト x に指定された name の属性またはメソッドがある場合は True を返します。それ以外の場合は False を返します。以下に例を示します。
hasattr(ctx.attr, "myattr")

パラメータ

パラメータ 説明
x required
確認するオブジェクト。
name required
属性の名前。

ハッシュ

int hash(value)

文字列のハッシュ値を返します。これは、Java の String.hashCode() と同じアルゴリズムを使用して確定的に計算されます。つまり、
s[0] * (31^(n-1)) + s[1] * (31^(n-2)) + ... + s[n-1]
文字列以外の値のハッシュ化は現在サポートされていません。

パラメータ

パラメータ 説明
value required
ハッシュ化する文字列値。

int

int int(x, base=unbound)

x を int 値として返します。
  • x がすでに int になっている場合、int はその値を変更せずに返します。
  • x がブール値の場合、int は True に対して 1、False に対して 0 を返します。
  • x が文字列の場合は、<sign><prefix><digits> の形式にする必要があります。<sign> は、"+""-"、または空(正と解釈される)のいずれかです。<digits> は 0 から base - 1 までの数字です。10 ~ 35 の数字には a ~ z(または同等の A ~ Z)が使用されます。base が 2/8/16 の場合、<prefix> は省略可能で、それぞれ 0b/0o/0x(または同等の 0B/0O/0X)になります。base がこれらの基数以外の値または特別な値 0 の場合、接頭辞は空にする必要があります。base が 0 の場合、文字列は整数リテラルとして解釈されます。つまり、使用されているプレフィックスに応じて、基数 2/8/10/16 が選択されます。base が 0 で、接頭辞は使用されず、2 桁を超える場合、先頭の数字を 0 にすることはできません。これは、8 進数と 10 進数の混同を避けるためです。文字列で表される数値の大きさは、int 型の許容範囲内でなければなりません。
  • x が浮動小数点数の場合、int は 0 に向けて丸め、その浮動小数点数の整数値を返します。x が非有限(NaN または無限大)の場合は、エラーになります。
x が他の型の場合、または値が文字列の場合、この関数は失敗します。Python の int 関数とは異なり、この関数はゼロ引数を許可せず、文字列引数に余分な空白を使用することはできません。

例:

int("123") == 123
int("-123") == -123
int("+123") == 123
int("FF", 16) == 255
int("0xFF", 16) == 255
int("10", 0) == 10
int("-0x10", 0) == -16
int("-0x10", 0) == -16
int("123.456") == 123

パラメータ

パラメータ 説明
x required
変換する文字列。
base default = unbound
文字列値の解釈に使用されるベース。デフォルトは 10 です。2 ~ 36(両端を含む)、または x が整数リテラルであるかのように基数を検出するには、0 を指定する必要があります。値が文字列でない場合は、このパラメータを指定しないでください。

len

int len(x)

文字列、シーケンス(リストやタプルなど)、dict、その他のイテラブルの長さを返します。

パラメータ

パラメータ 説明
x required
報告する長さの値。

list

list list(x=[])

指定された反復可能な値と同じ要素を持つ新しいリストを返します。
list([1, 2]) == [1, 2]
list((2, 3, 2)) == [2, 3, 2]
list({5: "a", 2: "b", 4: "c"}) == [5, 2, 4]

パラメータ

パラメータ 説明
x default = []
変換するオブジェクト。

local_path_override

None local_path_override(module_name, path)

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

パラメータ

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

最高

unknown max(*args)

指定したすべての引数のうち、大きい方を返します。引数を 1 つだけ指定する場合は、空でない iterable にする必要があります。要素が比較可能でない場合(int と string など)、または引数を指定しない場合はエラーになります。
max(2, 5, 4) == 5
max([5, 6, 3]) == 6

パラメータ

パラメータ 説明
args 必須
チェックされる要素。

unknown min(*args)

指定したすべての引数のうち、最小の 1 つを返します。引数を 1 つだけ指定する場合は、空でないイテラブルにする必要があります。要素を比較できない場合(int と string など)や、引数が指定されていない場合はエラーとなります。
min(2, 5, 4) == 2
min([5, 6, 3]) == 3

パラメータ

パラメータ 説明
args 必須
チェックされる要素。

モジュール

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

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

最大 1 回呼び出す必要があります。このモジュールがルート モジュールである場合にのみ、省略できます(別のモジュールに依存しない場合など)。

パラメータ

パラメータ 説明
name default = ''
モジュールの名前。このモジュールがルート モジュールである場合にのみ省略できます(別のモジュールに依存しない場合は、のように省略できます)。有効なモジュール名は、1)小文字(a ~ z)、数字(0 ~ 9)、ドット(.)、ハイフン(-)、アンダースコア(_)のみを使用し、2)先頭は小文字、3)末尾は小文字または数字にする必要があります。
version default = ''
モジュールのバージョン。このモジュールがルート モジュールである場合にのみ省略できます(別のモジュールに依存しない場合は、のように省略できます)。
compatibility_level default = 0
モジュールの互換性レベル。これは、互換性のない重大な変更が行われるたびに変更する必要があります。これは、SemVer の観点から見ると、基本的にモジュールの「メジャー バージョン」です。ただし、バージョン文字列自体には埋め込まれず、別のフィールドとして存在します。互換性レベルが異なるモジュールは、あたかも名前が異なるモジュールであるかのようにバージョン解決に参加しますが、最終的な依存関係グラフには、名前が同じで互換性レベルが異なる複数のモジュールを含めることはできません(multiple_version_override が有効になっている場合。詳しくはこちらをご覧ください)。
repo_name default = ''
モジュール自体に表示される、このモジュールを表すリポジトリの名前。デフォルトでは、リポジトリの名前はモジュールの名前です。これは、モジュール名とは異なるリポジトリ名を使用しているプロジェクトの移行を容易にするために指定できます。
bazel_compatibility Iterable of strings; default = []
このモジュールと互換性のある 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 に互換性を破るバグがあるが、後のバージョンで修正される場合に使用します。

module_extension

unknown module_extension(implementation, *, tag_classes={}, doc='')

新しいモジュール拡張機能を作成します。グローバル値で保存し、エクスポートして MODULE.bazel ファイルで使用できるようにします。

パラメータ

パラメータ 説明
implementation required
このモジュール拡張機能を実装する関数。module_ctx という単一のパラメータを取ります。この関数は、ビルドの開始時に 1 回呼び出され、利用可能なリポジトリのセットを判定します。
tag_classes default = {}
拡張機能で使用するすべてのタグクラスを宣言するための辞書。タグクラスの名前から tag_class オブジェクトにマッピングされます。
doc default = ''
ドキュメント生成ツールで抽出できるモジュール拡張機能の説明。

multiple_version_override

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

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

パラメータ

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

プリント

None print(sep=" ", *args)

args をデバッグ出力として出力します。先頭に文字列 "DEBUG" と、この呼び出しの場所(ファイルと行番号)が付加されます。引数が文字列に変換される正確な方法は示されておらず、随時変更される可能性があります。特に、str()repr() による書式設定とは異なる(そして詳細な)場合があります。

本番環境のコードで print を使用することは、ユーザーに対するスパムが発生するためおすすめしません。非推奨に関しては、可能な限り fail() を使用してハードエラーを使用することをおすすめします。

パラメータ

パラメータ 説明
sep default = " "
オブジェクトの区切り文字列。デフォルトはスペース(" ")です。
args required
出力するオブジェクト。

provider

unknown provider(doc='', *, fields=None, init=None)

プロバイダ シンボルを定義します。プロバイダは、呼び出してインスタンス化することも、ターゲットからそのプロバイダのインスタンスを取得するためのキーとして直接使用することもできます。例:
MyInfo = provider()
...
def _my_library_impl(ctx):
    ...
    my_info = MyInfo(x = 2, y = 3)
    # my_info.x == 2
    # my_info.y == 3
    ...

プロバイダの使用方法に関する包括的なガイドについては、ルール(プロバイダ)をご覧ください。

init が指定されていない場合、Provider 呼び出し可能値を返します。

init を指定すると、Provider 呼び出し可能値と未加工のコンストラクタ呼び出し可能値の 2 つの要素のタプルが返されます。詳細については、ルール(カスタム プロバイダのカスタム初期化)と以下の init パラメータの説明をご覧ください。

パラメータ

パラメータ 説明
doc default = ''
ドキュメント生成ツールで抽出できるプロバイダの説明。
fields sequence of strings; or dict; or None; default = なし
指定すると、許可されるフィールドのセットが制限されます。
有効な値は次のとおりです。
  • フィールドのリスト:
    provider(fields = ['a', 'b'])

  • 辞書のフィールド名 -> ドキュメント:
    provider(
           fields = { 'a' : 'Documentation for a', 'b' : 'Documentation for b' })
すべてのフィールドは省略可能です。
init callable; or None; default = None
インスタンス化中にプロバイダのフィールド値を前処理して検証するためのコールバック(省略可)。init が指定された場合、provider() は 2 つの要素のタプル(通常のプロバイダ シンボルと未加工のコンストラクタ)を返します。

詳細な説明は次のとおりです。直感的な説明とユースケースについては、ルール(プロバイダのカスタム初期化)をご覧ください。

P を、provider() を呼び出して作成されたプロバイダ シンボルにします。概念的には、P のインスタンスはデフォルト コンストラクタ関数 c(*args, **kwargs) を呼び出して生成されます。この関数は次の処理を行います。

  • args が空でない場合、エラーが発生します。
  • provider() の呼び出し時に fields パラメータが指定されており、kwargsfields にリストされていないキーが含まれている場合、エラーが発生します。
  • それ以外の場合、c は、kwargsk: v エントリごとに、値が vk というフィールドを持つ新しいインスタンスを返します。
init コールバックが指定されていない場合、シンボル P 自体の呼び出しは、デフォルト コンストラクタ関数 c の呼び出しとして機能します。つまり、P(*args, **kwargs)c(*args, **kwargs) を返します。たとえば、
MyInfo = provider()
m = MyInfo(foo = 1)
は単純に mm.foo == 1 を持つ MyInfo インスタンスになるようにします。

ただし、init が指定されている場合、P(*args, **kwargs) の呼び出しでは代わりに次の処理が実行されます。

  1. コールバックは init(*args, **kwargs) として呼び出されます。つまり、P に渡された位置引数とキーワード引数とまったく同じです。
  2. init の戻り値は、キーがフィールド名の文字列である辞書 d である必要があります。有効になっていない場合はエラーが発生します。
  3. P の新しいインスタンスは、c(**d) のように、キーワード引数として d のエントリを使用してデフォルト コンストラクタを呼び出す場合と同様に生成されます。

注: 上記の手順は、*args または **kwargsinit のシグネチャと一致しない場合、init の本体の評価が失敗した場合(意図的に fail() の呼び出しによって)、または init の戻り値が想定されるスキーマの辞書ではない場合に発生することを意味します。

このように、init コールバックは位置引数と任意のロジックを前処理と検証に許可することで、通常のプロバイダ作成を一般化します。許可されている fields のリストを回避することはできません。

init が指定された場合、provider() の戻り値はタプル (P, r) になります。ここで、r は未加工のコンストラクタです。実際、r の動作は、前述のデフォルト コンストラクタ関数 c の動作とまったく同じです。通常、r は、名前の接頭辞がアンダースコアで始まる変数にバインドされているため、現在の .bzl ファイルのみが直接アクセスできます。

MyInfo, _new_myinfo = provider(init = ...)

range

sequence range(start_or_stop, stop_or_none=None, step=1)

step の増分を使用して、項目が start から stop になるリストを作成します。引数を 1 つだけ指定した場合、その要素の範囲は 0 です。
range(4) == [0, 1, 2, 3]
range(3, 9, 2) == [3, 5, 7]
range(3, 0, -1) == [3, 2, 1]

パラメータ

パラメータ 説明
start_or_stop 必須
停車場所が指定されている場合は開始要素の値。それ以外の場合は、停車地と実際の開始値は 0 になります
stop_or_none int; or None; default = なし
結果のリストに含めない最初のアイテムのオプション インデックス。リストの生成は、stop に達する前に停止します。
step default = 1
増分(デフォルトは 1)。負の場合もあります。

register_execution_platforms()

None register_execution_platforms(*platform_labels)

定義済みのプラットフォームを登録し、ツールチェーンの解決時に Bazel が実行プラットフォームとして使用できるようにします。

パラメータ

パラメータ 説明
platform_labels sequence of strings; 必須
登録するプラットフォームのラベル。

register_execution_platforms(dev_dependency)

None register_execution_platforms(dev_dependency=False, *platform_labels)

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

パラメータ

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

register_toolchains()

None register_toolchains(*toolchain_labels)

定義済みのツールチェーンを登録し、ツールチェーンの解決時に Bazel で使用できるようにします。ツールチェーンの定義と登録をご覧ください。

パラメータ

パラメータ 説明
toolchain_labels sequence of strings; 必須
登録するツールチェーンのラベル。

register_toolchains(dev_dependency)

None register_toolchains(dev_dependency=False, *toolchain_labels)

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

パラメータ

パラメータ 説明
dev_dependency default = False
true の場合、現在のモジュールがルート モジュールでない場合、または「--ignore_dev_dependency」が有効になっている場合、ツールチェーンは登録されません。
toolchain_labels sequence of strings; 必須
登録するツールチェーンのラベル。

repo_rule(implementation, attrs, ローカル, environ, 構成, remotable, doc)

callable repository_rule(implementation, *, attrs=None, local=False, environ=[], configure=False, remotable=False, doc='')

新しいリポジトリ ルールを作成します。グローバル値で保存し、WORKSPACE ファイルから読み込んで呼び出せるようにします。

パラメータ

パラメータ 説明
implementation required
このルールを実装する関数。repository_ctx という単一のパラメータが必要です。この関数は、ルールのインスタンスごとに読み込みフェーズで呼び出されます。
attrs dict; or None; default = None
ルールのすべての属性を宣言するための辞書。属性名から属性オブジェクトにマッピングされます(attr モジュールを参照)。_ で始まる属性は限定公開であり、ラベルへの暗黙的な依存関係をファイルに追加するために使用できます(リポジトリ ルールは、生成されたアーティファクトに依存できません)。属性 name は暗黙的に追加されており、指定することはできません。
local default = False
このルールはローカル システムからすべてを取得するため、フェッチごとに再評価する必要があることを示します。
environ sequence of strings; default = []
このリポジトリ ルールが依存する環境変数のリストを提供します。リスト内の環境変数が変更されると、リポジトリが再取得されます。
configure default = False
リポジトリが構成のためにシステムを検査することを示します。
remotable default = False
試験運用版。このパラメータは試験運用中であり、いつでも変更される可能性があります。頼りにしないでください。---experimental_repo_remote_exec を設定することで、試験運用版で有効にできます。
リモート実行に対応。
doc default = ''
ドキュメント生成ツールで抽出できるリポジトリ ルールの説明。

repo_rule(implementation, attrs, ローカル, environ, 構成, remotable, doc)

callable repository_rule(implementation, *, attrs=None, local=False, environ=[], configure=False, remotable=False, doc='')

新しいリポジトリ ルールを作成します。グローバル値で保存し、WORKSPACE ファイルから読み込んで呼び出せるようにします。

パラメータ

パラメータ 説明
implementation required
このルールを実装する関数。repository_ctx という単一のパラメータが必要です。この関数は、ルールのインスタンスごとに読み込みフェーズで呼び出されます。
attrs dict; or None; default = None
ルールのすべての属性を宣言するための辞書。属性名から属性オブジェクトにマッピングされます(attr モジュールを参照)。_ で始まる属性は限定公開であり、ラベルへの暗黙的な依存関係をファイルに追加するために使用できます(リポジトリ ルールは、生成されたアーティファクトに依存できません)。属性 name は暗黙的に追加されており、指定することはできません。
local default = False
このルールはローカル システムからすべてを取得するため、フェッチごとに再評価する必要があることを示します。
environ sequence of strings; default = []
このリポジトリ ルールが依存する環境変数のリストを提供します。リスト内の環境変数が変更されると、リポジトリが再取得されます。
configure default = False
リポジトリが構成のためにシステムを検査することを示します。
remotable default = False
試験運用版。このパラメータは試験運用中であり、いつでも変更される可能性があります。頼りにしないでください。---experimental_repo_remote_exec を設定することで、試験運用版で有効にできます。
リモート実行に対応。
doc default = ''
ドキュメント生成ツールで抽出できるリポジトリ ルールの説明。

反復

string repr(x)

任意のオブジェクトを文字列表現に変換します。これはデバッグに役立ちます。
repr("ab") == '"ab"'

パラメータ

パラメータ 説明
x required
変換するオブジェクト。

反転

list reversed(sequence)

元の反復可能なシーケンスの要素を逆順に含む、フリーズされていない新しいリストを返します。
reversed([3, 5, 4]) == [4, 5, 3]

パラメータ

パラメータ 説明
sequence 必須
反転させる反復可能なシーケンス(リストなど)。

ルール

callable rule(implementation, test=False, attrs=None, outputs=None, executable=False, output_to_genfiles=False, fragments=[], host_fragments=[], _skylark_testable=False, toolchains=[], incompatible_use_toolchain_transition=False, doc='', *, provides=[], exec_compatible_with=[], analysis_test=False, build_setting=None, cfg=None, exec_groups=None, compile_one_filetype=None, name=None)

新しいルールを作成します。このルールを BUILD ファイルまたはマクロから呼び出してターゲットを作成できます。

ルールは、.bzl ファイル内のグローバル変数に割り当てる必要があります。グローバル変数の名前はルールの名前です。

テストルールの名前の末尾は _test にする必要がありますが、他のすべてのルールにこのサフィックスを付けることはできません。(この制限はルールにのみ適用され、ターゲットには適用されません)。

パラメータ

パラメータ 説明
implementation 必須
このルールを実装する Starlark 関数。パラメータは 1 つのみ(ctx)である必要があります。この関数は、分析フェーズでルールのインスタンスごとに呼び出されます。ユーザーが指定した属性にアクセスできる。宣言されたすべての出力を生成するアクションを作成する必要があります。
test default = False
このルールがテストルールかどうか、つまり blaze test コマンドの対象となるかどうか。すべてのテストルールは、自動的に実行可能とみなされます。テストルールに executable = True を明示的に設定する必要はありません(推奨されません)。詳細については、 ルールページをご覧ください。
attrs dict; or None; default = None
ルールのすべての属性を宣言するための辞書。属性名から属性オブジェクトにマッピングされます(attr モジュールを参照)。_ で始まる属性は限定公開であり、ラベルに暗黙的な依存関係を追加するために使用できます。属性 name は暗黙的に追加されているため、指定することはできません。属性 visibilitydeprecationtagstestonlyfeatures は暗黙的に追加されており、オーバーライドできません。ほとんどのルールに必要な属性は、ほんの一握りです。メモリ使用量を制限するために、ルール関数は attrs のサイズに上限を設けます。
outputs dict; or None; or function; デフォルト = なし
非推奨。このパラメータは非推奨で、まもなく削除されます。頼りにしないでください。これは ---incompatible_no_rule_outputs_param無効になります。このフラグを使用して、近く予定されている削除との互換性があることを確認します。
このパラメータは非推奨になりました。代わりに OutputGroupInfo または attr.output を使用するようにルールを移行します。

事前に宣言された出力を定義するためのスキーマ。output 属性や output_list 属性とは異なり、ユーザーはこれらのファイルのラベルを指定しません。事前に宣言された出力の詳細については、ルールページをご覧ください。

この引数の値は、辞書、または辞書を生成するコールバック関数のいずれかです。コールバックは、計算された依存関係の属性と同様に機能します。関数のパラメータ名はルールの属性と照合されます。たとえば、定義 def _my_func(srcs, deps): ... とともに outputs = _my_func を渡すと、関数は属性 srcsdeps にアクセスできます。辞書を直接指定したか、関数で指定したかにかかわらず、次のように解釈されます。

辞書の各エントリは、事前に宣言された出力を作成します。キーは識別子、値は出力のラベルを決定する文字列テンプレートです。ルールの実装関数で、この ID は ctx.outputs で出力の File へのアクセスに使用されるフィールド名になります。出力のラベルはルールと同じパッケージを持ちます。パッケージの後の部分は、"%{ATTR}" の形式の各プレースホルダを属性 ATTR の値から形成された文字列に置き換えることで生成されます。

  • 文字列型の属性は、そのまま置換されます。
  • ラベル型の属性は、パッケージの後にファイル拡張子を除いたラベルの一部になります。たとえば、ラベル "//pkg:a/b.c""a/b" になります。
  • 出力型の属性は、パッケージの後のラベルの一部になり、ファイル拡張子(上記の例では "a/b.c")を含みます。
  • プレースホルダで使用されるすべてのリスト型の属性(attr.label_list など)は、要素を 1 つだけ指定する必要があります。コンバージョンは、リスト以外のバージョン(attr.label)と同じです。
  • 他の属性タイプは、プレースホルダに表示されない場合があります。
  • 特別な非属性プレースホルダ %{dirname}%{basename} は、パッケージを除く、ルールのラベルの該当部分に展開されます。たとえば、"//pkg:a/b.c" では、ディレクトリ名は a、ベース名は b.c です。

実際には、最も一般的な置換プレースホルダは "%{name}" です。たとえば、「foo」という名前のターゲットの場合、出力辞書 {"bin": "%{name}.exe"} は、実装関数で ctx.outputs.bin としてアクセスできる foo.exe という名前の出力を事前に宣言します。

executable default = False
このルールが実行可能と見なされるかどうか、つまり blaze run コマンドの対象となりうるかどうか。詳細については、 ルールページをご覧ください。
output_to_genfiles default = False
true の場合、ファイルは bin ディレクトリではなく genfiles ディレクトリに生成されます。既存のルールとの互換性を確保するために必要な場合を除き(C++ のヘッダー ファイルを生成する場合など)、このフラグは設定しないでください。
fragments sequence of strings; default = []
ターゲット構成でルールが必要とする構成フラグメントの名前のリスト。
host_fragments sequence of strings; default = []
ホスト構成でルールが必要とする構成フラグメントの名前のリスト。
_skylark_testable default = False
(試験運用版)

true の場合、このルールは、アクション プロバイダを介して、このルールに依存するルールによって検査のためにアクションを公開します。プロバイダをルール自体で利用するには、ctx.created_actions() を呼び出します。

これは、Starlark ルールの分析時の動作をテストする場合にのみ使用してください。このフラグは今後削除される可能性があります。
toolchains sequence; default = []
設定すると、このルールに必要なツールチェーンのセットです。リストには、String、Label、StarlarkToolchainTypeApi の各オブジェクトを任意の組み合わせで含めることができます。ツールチェーンは、現在のプラットフォームをチェックすることで検出され、ctx.toolchain を介してルール実装に提供されます。
incompatible_use_toolchain_transition default = False
非推奨。これは使用されなくなったため、削除する必要があります。
doc default = ''
ドキュメント生成ツールで抽出できるルールの説明。
provides default = []
実装関数が返すプロバイダのリスト。

実装関数で、ここにリストされているいずれかのタイプのプロバイダが戻り値から除外されている場合、エラーになります。ただし、実装関数がここに記載されていない追加のプロバイダを返す場合があります。

リストの各要素は、provider() によって返される *Info オブジェクトです。ただし、以前のプロバイダは文字列名で表されます。

exec_compatible_with sequence of strings; default = []
このルールタイプのすべてのターゲットに適用される実行プラットフォームの制約のリスト。
analysis_test default = False
true の場合、このルールは分析テストとして扱われます。

注: 分析テストルールは、主に Starlark コアライブラリで提供されているインフラストラクチャを使用して定義されます。詳しくは、テストをご覧ください。

ルールを分析テストルールとして定義した場合、その属性で analysis_test_transition を使用して定義された構成遷移を使用できますが、いくつかの制限が適用されます。

  • このルールのターゲットには、推移的依存関係の数が制限されます。
  • このルールは(test=True が設定されている場合と同様に)テストルールと見なされます。これは test の値よりも優先されます。
  • ルール実装関数でアクションを登録することはできません。代わりに、AnalysisTestResultInfo を提供して、合格/不合格の結果を登録する必要があります。
build_setting BuildSetting; or None; default = なし
設定されている場合は、このルールの build setting の種類を表します。config モジュールをご覧ください。これが設定されている場合、「build_setting_default」という名前の必須属性がこのルールに自動的に追加されます。この属性は、ここで渡された値に対応するタイプを指定します。
cfg default = なし
設定した場合、分析前にルールが独自の構成に適用される構成の遷移を示します。
exec_groups dict; or None; default = なし
実行グループ名(文字列)の exec_group への辞書。設定すると、単一のターゲット内の複数の実行プラットフォームでルールを実行することを許可します。詳しくは、実行グループのドキュメントをご覧ください。
compile_one_filetype sequence of strings; or None; default = なし
--compile_one_dependency で使用されます。指定されたファイルを複数のルールで使用する場合、他のルールよりこのルールを優先して選択します。
name string; or None; デフォルト = なし
非推奨。このパラメータは非推奨で、まもなく削除されます。頼りにしないでください。これは --+incompatible_remove_rule_name_parameter無効になります。このフラグを使用して、近く予定されている削除との互換性があることを確認します。
非推奨: 使用しないでください。

このルールの名前。Bazel で認識され、ロギング、native.existing_rule(...)[kind]bazel query などのコンテキストで報告されます。これは通常、このルールにバインドされる Starlark 識別子と同じです。たとえば、foo_library というルールは通常 foo_library = rule(...) として宣言され、BUILD ファイルでは foo_library(...) としてインスタンス化されます。

このパラメータを省略すると、ルールの名前は、宣言している .bzl モジュール内でこのルールにバインドされる最初の Starlark グローバル変数の名前に設定されます。したがって、名前が foo_library の場合、foo_library = rule(...) はこのパラメータを指定する必要はありません。

ルールに明示的な名前を指定しても、ルールをインスタンス化できる場所は変わりません。

select

unknown select(x, no_match_error='')

select() は、ルール属性を構成可能にするヘルパー関数です。詳細については、ビルドの百科事典をご覧ください。

パラメータ

パラメータ 説明
x required
構成条件を値にマッピングする辞書。各キーは、config_setting または constraint_value インスタンスを識別するラベルまたはラベル文字列です。文字列の代わりにラベルを使用するケースについては、マクロに関するドキュメントをご覧ください。
no_match_error default = ''
条件が一致しない場合に報告するカスタムエラー(省略可)。

single_version_override

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

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

パラメータ

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

並べ替え済み

list sorted(iterable, *, key=None, reverse=False)

指定された反復可能なシーケンスのすべての要素を含む、並べ替えられた新しいリストを返します。x < y を使用して要素 x と y のペアを比較できない場合、エラーが発生することがあります。要素は昇順で並べ替えられます。ただし、反転引数が True の場合、順序は降順になります。 並べ替えが安定します。比較が等しい要素は、元の相対的な順序を保持します。
sorted([3, 5, 4]) == [3, 4, 5]

パラメータ

パラメータ 説明
iterable required
並べ替える反復可能なシーケンス。
key default = None
比較前に各要素に適用されるオプションの関数。
reverse default = False
結果を降順で返します。

str

string str(x)

任意のオブジェクトを文字列に変換します。これはデバッグに役立ちます。
str("ab") == "ab"
str(8) == "8"

パラメータ

パラメータ 説明
x required
変換するオブジェクト。

tag_class

tag_class tag_class(attrs={}, *, doc='')

新しい tag_class オブジェクトを作成します。これは、タグのクラス(モジュール拡張機能で使用可能なデータ オブジェクト)の属性スキーマを定義します。

パラメータ

パラメータ 説明
attrs default = {}
このタグクラスのすべての属性を宣言するための辞書。属性名から属性オブジェクトにマッピングされます(attr モジュールを参照)。
doc default = ''
ドキュメント生成ツールで抽出できるタグクラスの説明。

tuple

tuple tuple(x=())

指定された反復可能値と同じ要素を持つタプルを返します。
tuple([1, 2]) == (1, 2)
tuple((2, 3, 2)) == (2, 3, 2)
tuple({5: "a", 2: "b", 4: "c"}) == (5, 2, 4)

パラメータ

パラメータ 説明
x default = ()
変換するオブジェクト。

type

string type(x)

引数の型名を返します。これは、デバッグや型チェックに役立ちます。例:
type(2) == "int"
type([1]) == "list"
type(struct(a = 2)) == "struct"
この関数は将来変更される可能性があります。Python と互換性のあるコードを記述し、将来性のあるものにするには、戻り値の比較にのみ使用します。
if type(x) == type([]):  # if x is a list

パラメータ

パラメータ 説明
x required
チェックするオブジェクトのタイプ。

use_extension

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

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

パラメータ

パラメータ 説明
extension_bzl_file 必須
モジュール拡張子を定義する Starlark ファイルのラベル。
extension_name required
使用するモジュール拡張機能の名前。この名前のシンボルは、Starlark ファイルでエクスポートする必要があります。
dev_dependency default = False
true の場合、現在のモジュールがルート モジュールでない場合、または「--ignore_dev_dependency」が有効になっている場合、モジュール拡張機能の使用は無視されます。
isolate default = False
true の場合、モジュール拡張機能のこの使用は、このモジュールと他のモジュールの両方の他のすべての使用から分離されます。この用途用に作成されたタグは、他の用途には影響しません。この用途用に拡張機能によって生成されたリポジトリは、拡張機能によって生成された他のすべてのリポジトリとは区別されます。

use_repo

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

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

パラメータ

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

visibility

None visibility(value)

現在初期化中の .bzl モジュールの読み込みの可視性を設定します。

モジュールの読み込みの可視性は、他の BUILD ファイルと .bzl ファイルによるモジュールの読み込みを許可するかどうかを制御します。(これは、ファイルが他のターゲットの依存関係として表示されるかどうかを管理する、基盤となる .bzl ソースファイルのターゲット可視性とは異なります)。読み込みの可視性はパッケージのレベルで機能する: モジュールを読み込むには、読み込みを行うファイルが、モジュールに対する可視性が付与されたパッケージ内に存在している必要があります。モジュールは、その可視性に関係なく、常に独自のパッケージ内でロードできます。

visibility() は .bzl ファイルごとに 1 回だけ、トップレベルでのみ呼び出せます。関数内で呼び出すことはできません。この呼び出しは、load() ステートメントのすぐ下と、引数を決定するために必要な簡単なロジックのすぐ下に配置することをおすすめします。

フラグ --check_bzl_visibility が false に設定されている場合、読み込みの可視性違反は警告を出力しますが、ビルドは失敗します。

パラメータ

パラメータ 説明
value required
パッケージ仕様の文字列のリスト、または単一のパッケージ仕様の文字列。

パッケージ仕様は package_group と同じ形式で指定しますが、除外パッケージ仕様は使用できません。つまり、仕様は次のような形式になります。

  • "//foo": パッケージ //foo
  • "//foo/...": パッケージ //foo とそのすべてのサブパッケージ。
  • "public" または "private": それぞれすべてのパッケージ、またはパッケージなし

「@」構文は使用できません。すべての仕様は、現在のモジュールのリポジトリを基準として解釈されます。

value が文字列のリストの場合、このモジュールに公開できるパッケージのセットは、各仕様で表されるパッケージを結合したものになります。(空のリストの効果は private と同じです)。value が単一の文字列の場合、シングルトン リスト [value] の場合と同様に扱われます。

--incompatible_package_group_has_public_syntax フラグと --incompatible_fix_package_group_reporoot_syntax フラグは、この引数には影響しません。"public""private" の値は常に使用でき、"//..." は常に「現在のリポジトリ内のすべてのパッケージ」と解釈されます。

ワークスペース

None workspace(name)

この関数は WORKSPACE ファイルでのみ使用できます。WORKSPACE ファイル内の他のすべての関数の前に宣言する必要があります。各 WORKSPACE ファイルには workspace 関数が必要です。

このワークスペースの名前を設定します。ワークスペース名は、プロジェクトを Java パッケージ形式で説明し、区切り文字としてアンダースコアを使用します。たとえば、github.com/bazelbuild/bazel の場合は「com_github_bazelbuild_bazel」にする必要があります。

この名前は、リポジトリの実行ファイルが格納されているディレクトリに使用されます。たとえば、ローカル リポジトリに実行ファイル foo/bar があり、WORKSPACE ファイルに workspace(name = 'baz') が含まれている場合、その実行ファイルは mytarget.runfiles/baz/foo/bar で使用できます。ワークスペース名が指定されていない場合、実行ファイルは bar.runfiles/foo/bar にシンボリック リンクされます。

リモート リポジトリ ルール名は、有効なワークスペース名にする必要があります。たとえば、Bazel は workspace(name = 'foo%bar') を含む maven_jar に WORKSPACE ファイルを書き込もうとするため、maven_jar(name = 'foo') を使用し、maven_jar(name = 'foo%bar') はしないようにできます。

パラメータ

パラメータ 説明
name 必須
ワークスペースの名前。名前は、先頭を英字にする必要があり、英字、数字、アンダースコア、ダッシュ、ドットのみを使用できます。

zip

list zip(*args)

tuplelist を返します。i 番目のタプルには、各引数シーケンスまたはイテラブルの i 番目の要素が含まれます。リストには、最も短い入力サイズが含まれています。イテラブル引数を 1 つ指定すると、1 タプルのリストが返されます。引数がない場合は、空のリストが返されます。例:
zip()  # == []
zip([1, 2])  # == [(1,), (2,)]
zip([1, 2], [3, 4])  # == [(1, 3), (2, 4)]
zip([1, 2], [3, 4, 5])  # == [(1, 3), (2, 4)]

パラメータ

パラメータ 説明
args 圧縮する
リスト。