Globals

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

メンバー

すべて

bool all(elements)

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

パラメータ

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

analysis_test_transition

transition analysis_test_transition(settings)

分析テストルールの依存関係に適用される構成遷移を作成します。この遷移は、analysis_test = True を含むルールの属性にのみ適用できます。このようなルールには機能上の制限があるため（依存関係ツリーのサイズが制限されているなど）、この関数を使用して作成された遷移は、transition を使用して作成された遷移と比較して、潜在的なスコープが制限されます。

この関数は主に、Analysis Test Framework のコアライブラリを円滑化するために設計されています。ベスト プラクティスについては、ドキュメント（または実装）をご覧ください。

パラメータ

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

任意

bool any(elements)

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

パラメータ

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

archive_override

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

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

パラメータ

パラメータ 説明
module_name 必須
このオーバーライドを適用する Bazel モジュール依存関係の名前。
urls string; or Iterable of strings; 必須
アーカイブの URL。http(s):// または file:// の URL を使用できます。
integrity デフォルト = ''
アーカイブ ファイルの想定されるチェックサム（サブリソース完全性形式）。
strip_prefix default = ''
抽出されたファイルから削除するディレクトリ接頭辞。
patches Iterable of strings; デフォルト = []
このモジュールに適用するパッチファイルを指すラベルのリスト。パッチファイルは、最上位プロジェクトのソースツリーに存在している必要があります。リストの順序で適用されます。
patch_cmds Iterable of strings; デフォルト = []
Linux/macOS でパッチ適用後に適用される Bash コマンドのシーケンス。
patch_strip デフォルト = 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; デフォルト = []
属性名のリスト。アスペクトは、これらの名前を持つターゲットの属性で指定された依存関係に沿って伝播されます。一般的な値には deps と exports があります。リストに 1 つの文字列 "*" を含めて、ターゲットのすべての依存関係に伝播することもできます。
attrs dict; or None; デフォルト = 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_rule が FooInfo または BarInfo または BazInfo と QuxInfo の両方を指定した場合にのみ、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 が FooInfo または BarInfo または BazInfo と QuxInfo の両方を提供する場合にのみ、other_aspect を参照できます。

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

実装関数で、ここで説明するプロバイダのいずれかの型が戻り値から省略されている場合はエラーです。ただし、実装関数はここに記載されていない追加のプロバイダを返す場合があります。

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

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

たとえば、アスペクトが属性「deps」を介して伝播し、ターゲット「alpha」に適用されているとします。alpha に「deps = [':beta_output']」があるとします。ここで、beta_output はターゲット beta の宣言された出力です。beta にターゲット「charlie」が「deps」の 1 つとしてあるとします。アスペクトの「apply_to_generating_rules=True」の場合、アスペクトは「alpha」、「beta」、「charlie」を介して伝播します。False の場合、アスペクトは「alpha」にのみ伝播します。

デフォルトは false です。
exec_compatible_with sequence of strings; デフォルト = []
このアスペクトのすべてのインスタンスに適用される実行プラットフォームの制約のリスト。
exec_groups dict; or None; デフォルト = None
実行グループ名（文字列）と exec_group のディクショナリ。設定すると、アスペクトは 1 つのインスタンス内の複数の実行プラットフォームでアクションを実行できます。詳細については、実行グループのドキュメントをご覧ください。

bazel_dep

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

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

パラメータ

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

バインド

None bind(name, actual=None)

警告: bind() の使用は推奨されません。問題と代替手段について詳しくは、bind の削除を検討するをご覧ください。

//external パッケージでターゲットにエイリアスを付与します。

パラメータ

パラメータ 説明
name 必須
「//external」の下のラベル。エイリアス名として使用します
actual string; or None; デフォルト = None
エイリアスされる実際のラベル

ブール値

bool bool(x=False)

bool 型のコンストラクタ。オブジェクトが None、False、空の文字列（""）、数値 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 必須
遅延バインディング値を含む構成フラグメントの名前。
name 必須
構成フラグメントから取得する値の名前。

depset

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

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

depset のすべての要素（直接的および間接的）は、式 type(x) によって取得されるものと同じ型である必要があります。

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

また、要素は現在不変である必要がありますが、この制限は今後緩和される予定です。

作成された depset の順序は、transitive depset の順序と互換性がある必要があります。"default" オーダーは他のオーダーと互換性がありますが、他のオーダーは互換性がありません。

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

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

パラメータ

パラメータ 説明
direct sequence; or None; デフォルト = None
depset の直接要素のリスト。
order default = "default"
新しい depset の走査戦略。有効な値については、こちらをご覧ください。
transitive sequence of depsets; or None; デフォルト = None
要素が depset の直接要素になる depset のリスト。

dict

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

省略可能な位置引数と省略可能なキーワード引数からディクショナリを作成します。同じキーを複数回指定した場合は、最後の値が使用されます。キーワード引数で指定されたエントリは、位置引数で指定されたエントリの後に来るものと見なされます。

パラメータ

パラメータ 説明
pairs default = []
ディクショナリ、または要素の長さが 2 の iterable（キー、値）。
kwargs 必須
追加エントリのディクショナリ。

dir

list dir(x)

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

パラメータ

パラメータ 説明
x 必須
チェックするオブジェクト。

列挙

list enumerate(list, start=0)

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

パラメータ

パラメータ 説明
list required
入力シーケンス。
start デフォルト = 0
開始インデックス。

exec_group

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

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

パラメータ

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

fail

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

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

パラメータ

パラメータ 説明
msg default = None
非推奨: 代わりに位置引数を使用してください。この引数は、先頭の位置引数として暗黙的に機能します。
attr string; or None; デフォルト = None
非推奨。この文字列を含むプレフィックスがエラー メッセージに追加されます（省略可）。
args 必須
str でフォーマットされ、スペースで結合された値のリスト。エラー メッセージに表示されます。

float

float float(x=unbound)

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

パラメータ

パラメータ 説明
x デフォルト = 未バインド
変換する値。

getattr

unknown getattr(x, name, default=unbound)

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

パラメータ

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

git_override

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

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

パラメータ

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

hasattr

bool hasattr(x, name)

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

パラメータ

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

ハッシュ

int hash(value)

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

パラメータ

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

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 で、接頭辞が使用されておらず、桁が複数ある場合、先頭の桁は 0 にできません。これは、八進数と十進数との混同を避けるためです。文字列で表される数値の桁数は、int 型で許容される範囲内である必要があります。
  • x が浮動小数点数の場合、int は浮動小数点型の整数値を返し、ゼロに丸めます。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 デフォルト = 無制限
文字列値の解釈に使用される基数。デフォルトは 10 です。2～36 の整数を指定するか、0 を指定すると、x が整数リテラルであるかのように基数を検出します。値が文字列でない場合は、このパラメータを指定しないでください。

len

int len(x)

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

パラメータ

パラメータ 説明
x 必須
長さを報告する値。

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 デフォルト = []
変換するオブジェクト。

local_path_override

None local_path_override(module_name, path)

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

パラメータ

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

最大

unknown max(*args)

指定されたすべての引数のうち最大の引数を返します。1 つの引数のみを指定する場合は、空でないイテラブルでなければなりません。要素が比較できない場合（整数と文字列など）、または引数が指定されていない場合はエラーになります。 
max(2, 5, 4) == 5
max([5, 6, 3]) == 6

パラメータ

パラメータ 説明
args required
チェック対象の要素。

分

unknown min(*args)

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

パラメータ

パラメータ 説明
args required
チェックする要素。

モジュール

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 デフォルト = 0
モジュールの互換性レベル。互換性のない大きな変更が導入されるたびに変更する必要があります。SemVer の観点から見ると、これは基本的にモジュールの「メジャー バージョン」です。ただし、バージョンの文字列自体に埋め込まれるのではなく、別のフィールドとして存在します。互換レベルが異なるモジュールは、名前が異なるモジュールであるかのようにバージョン解決に参加しますが、最終的な依存関係グラフには、同じ名前で互換レベルが異なる複数のモジュールを含めることはできません（multiple_version_override が有効な場合を除きます。詳細については、multiple_version_override をご覧ください）。
repo_name default = ''
このモジュールを表すリポジトリの名前（モジュール自体から見た名前）。デフォルトでは、リポジトリの名前はモジュールの名前です。これは、モジュール名とは異なるリポジトリ名を使用していたプロジェクトの移行を容易にするために指定できます。
bazel_compatibility Iterable of strings; デフォルト = []
このモジュールと互換性のある 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 必須
このモジュール拡張を実装する関数。1 つのパラメータ module_ctx を受け取る必要があります。この関数は、ビルドの開始時に 1 回呼び出され、使用可能なリポジトリのセットを決定します。
tag_classes default = {}
拡張機能で使用されるすべてのタグクラスを宣言するためのディクショナリ。タグクラスの名前から tag_class オブジェクトにマッピングされます。
doc default = ''
ドキュメント生成ツールによって抽出できるモジュール拡張機能の説明。

multiple_version_override

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

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

パラメータ

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

プリント

None print(sep=" ", *args)

args をデバッグ出力として出力します。文字列 "DEBUG" と、この呼び出しの場所（ファイルと行番号）が接頭辞として追加されます。引数が文字列に正確に変換される方法は指定されていませんが、いつでも変更される可能性があります。特に、str() と repr() によるフォーマットとは異なる場合があります（より詳細な場合があります）。

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

パラメータ

パラメータ 説明
sep default = " "
オブジェクト間の区切り文字。デフォルトはスペース（" "）です。
args 必須
印刷するオブジェクト。

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

パラメータ

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

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

以下に正確な説明を示します。直感的な説明とユースケースについては、ルール（プロバイダのカスタム初期化）をご覧ください。

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

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

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

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

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

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

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

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

範囲

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 = None
結果のリストに含めない最初のアイテムのインデックス（省略可能）。リストの生成は stop に達する前に停止します。
step デフォルト = 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 デフォルト = 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（実装、攻撃者、ローカル、環境、構成、リモート可能、doc）

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

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

パラメータ

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

repo_rule（実装、攻撃者、ローカル、環境、構成、リモート可能、doc）

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

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

パラメータ

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

repr

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

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

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

ディクショナリ内の各エントリは、事前に宣言された出力を作成します。キーは識別子で、値は出力ラベルを決定する文字列テンプレートです。ルールの実装関数では、識別子は 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" では、dirname は a、basename は b.c です。

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

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

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

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

実装関数で、ここで説明するプロバイダのいずれかの型が戻り値から省略されている場合はエラーです。ただし、実装関数はここに記載されていない追加のプロバイダを返す場合があります。

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

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

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

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

  • このルールのターゲットには、持つことができる伝播依存関係の数に制限があります。
  • このルールは、（test=True が設定されている場合と同様に）テストルールと見なされます。これは test の値に優先されます。
  • ルール実装関数でアクションが登録されない場合があります。代わりに、AnalysisTestResultInfo を指定して、合格/不合格の結果を登録する必要があります。
build_setting BuildSetting; or None; デフォルト = None
このルールがどのような種類の build setting であるかを指定します。config モジュールをご覧ください。これが設定されている場合、このルールに「build_setting_default」という必須属性が自動的に追加され、ここに渡された値に対応する型が設定されます。
cfg デフォルト = None
この値を設定すると、分析前にルールが独自の構成に適用する構成遷移を指定します。
exec_groups dict; or None; デフォルト = None
実行グループ名（文字列）と exec_group のディクショナリ。設定すると、ルールで 1 つのターゲット内の複数の実行プラットフォームでアクションを実行できます。詳細については、実行グループに関するドキュメントをご覧ください。
compile_one_filetype sequence of strings; or None; デフォルト = None
--compile_one_dependency で使用: 複数のルールが指定されたファイルを使用する場合、他のルールよりもこのルールを選択するかどうか。
name string; or None; デフォルト = 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(...) でこのパラメータを指定する必要はありません。

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

選択

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

並べ替え

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

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

パラメータ

パラメータ 説明
iterable 必須
並べ替えるイテレラブルなシーケンス。
key デフォルト = None
比較前に各要素に適用されるオプションの関数。
reverse デフォルト = False
結果を降順で返します。

str

string str(x)

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

パラメータ

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

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 デフォルト = ()
変換するオブジェクト。

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 デフォルト = False
true の場合、このモジュール拡張機能のこの使用は、このモジュールと他のモジュールの両方で、他のすべての使用から分離されます。この用途用に作成されたタグは、他の用途に影響しません。この用途のために拡張機能によって生成されたリポジトリは、拡張機能によって生成された他のすべてのリポジトリとは区別されます。

use_repo

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

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

パラメータ

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

visibility

None visibility(value)

現在初期化されている .bzl モジュールの読み込み公開設定を設定します。

モジュールの読み込み公開設定は、他の BUILD ファイルと .bzl ファイルがそのモジュールを読み込むことができるかどうかを制御します。（これは、ファイルが他のターゲットの依存関係として表示されるかどうかを管理する、基になる .bzl ソースファイルのターゲット可視性とは異なります）。読み込みの公開設定はパッケージ単位で機能します。モジュールを読み込むには、読み込みを行うファイルが、そのモジュールの公開設定が付与されているパッケージに存在している必要があります。モジュールは、可視性に関わらず、常に独自のパッケージ内で読み込むことができます。

visibility() は、.bzl ファイルごとに 1 回だけ呼び出すことができ、関数内ではなく最上位レベルでのみ呼び出せます。推奨されるスタイルは、この呼び出しを load() ステートメントの直下と、引数の決定に必要な簡単なロジックのすぐ下に配置することです。

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

パラメータ

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

パッケージの仕様は 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 にシンボリック リンクされます。

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

パラメータ

パラメータ 説明
name 必須
ワークスペースの名前。名前の先頭は英字にする必要があります。名前に含められるのは文字、数字、アンダースコア、ダッシュ、ピリオドのみです。

zip

list zip(*args)

tuple の list を返します。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 required
圧縮するリスト。