メンバー
- すべて
- analysis_test_transition
- 任意
- archive_override
- アスペクト
- bazel_dep
- bind
- bool
- configuration_field
- depset
- 辞書
- dir
- 列挙
- exec_group
- 失敗
- 浮動小数点数
- getattr
- git_override
- hasattr
- ハッシュ
- 整数
- レンズ
- リスト
- local_path_override
- 最大
- 分
- モジュール
- module_extension
- multiple_version_override
- 印刷
- プロバイダ
- 範囲
- register_execution_platforms()
- register_execution_platforms(dev_dependency)
- register_toolchains()
- register_toolchains(dev_dependency)
- repository_rule
- repr
- 反転
- ルール
- 選択
- single_version_override
- 並べ替え済み
- str
- tag_class
- タプル
- 種類
- use_extension
- use_repo
- 可視性
- ワークスペース
- 郵便番号
すべて
bool all(elements)
all(["hello", 3, True]) == True all([-1, 0, 1]) == False
パラメータ
| パラメータ | 説明 |
|---|---|
elements
|
必須 文字列または要素のコレクション。 |
analysis_test_transition
transition analysis_test_transition(settings)
Analysis-test ルールの依存関係に適用する設定の移行を作成します。この移行は、analysis_test = True を含むルールの属性にのみ適用できます。このようなルールは機能が制限されているため（たとえば、依存関係ツリーのサイズが制限されているため）、この関数を使用して作成された遷移は、Transition を使用して作成された遷移と比較して潜在的なスコープが制限されます。
この関数は主に、Analysis Test Framework のコアライブラリを円滑化するために設計されています。ベスト プラクティスについては、ドキュメント（またはその実装）をご覧ください。
パラメータ
| パラメータ | 説明 |
|---|---|
settings
|
必須 この構成移行で設定する必要がある構成設定に関する情報を含むディクショナリ。キーはビルド設定のラベルで、値は移行後の新しい値です。その他の設定はすべて変更されていません。これを使用して、分析テストに合格するために設定する必要がある特定の構成設定を宣言します。 |
任意
bool any(elements)
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)
パラメータ
| パラメータ | 説明 |
|---|---|
module_name
|
必須 このオーバーライドを適用する Bazel モジュール依存関係の名前。 |
urls
|
string; or Iterable of strings、
必須アーカイブの URLhttp(s):// または file:// の URL を使用できます。 |
integrity
|
デフォルト = '' アーカイブ ファイルで想定されるチェックサム（サブリソースの整合性形式）。 |
strip_prefix
|
デフォルト = '' 抽出されたファイルから削除するディレクトリ接頭辞。 |
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 があります。このリストには、ターゲットのすべての依存関係を伝播する単一の文字列 "*" を含めることもできます。
|
attrs
|
dict; or None、
デフォルト = Noneアスペクトのすべての属性を宣言するディクショナリ。属性名から `attr.label` や `attr.string` などの属性オブジェクトにマッピングします（attr モジュールを参照）。アスペクト属性は、 ctx パラメータのフィールドとして実装関数で使用できます。
明示的な属性は、 |
required_providers
|
デフォルト = [] この属性を使用すると、アスペクトは、ルールが必要なプロバイダをアドバタイズするターゲットのみに伝播を制限できます。値は、個別のプロバイダまたはプロバイダのリストのいずれかを含むリストにする必要があります。両方を含めることはできません。たとえば、 [[FooInfo], [BarInfo], [BazInfo, QuxInfo]] は有効な値ですが、[FooInfo, BarInfo, [BazInfo, QuxInfo]] は無効になります。プロバイダのネスト解除されたリストは、1 つのプロバイダのリストを含むリストに自動的に変換されます。つまり、 一部のルール（ |
required_aspect_providers
|
デフォルト = [] この属性により、このアスペクトは他のアスペクトを検査できます。値は、個別のプロバイダまたはプロバイダのリストのいずれかを含むリストにする必要があります。両方を含めることはできません。たとえば、 [[FooInfo], [BarInfo], [BazInfo, QuxInfo]] は有効な値ですが、[FooInfo, BarInfo, [BazInfo, QuxInfo]] は無効になります。プロバイダのネスト解除されたリストは、1 つのプロバイダのリストを含むリストに自動的に変換されます。つまり、 別のアスペクト（ |
provides
|
デフォルト = [] 実装関数が返すプロバイダのリスト。 実装関数で、以下のいずれかのタイプのプロバイダが戻り値から除外されている場合、エラーになります。ただし、実装関数は、ここに記載されていない追加のプロバイダを返すことがあります。 リストの各要素は、 |
requires
|
sequence of Aspects、
デフォルト = []このアスペクトの前に伝播する必要があるアスペクトのリスト。 |
fragments
|
sequence of strings、
デフォルト = []アスペクトがターゲット構成で必要とする構成フラグメントの名前のリスト。 |
host_fragments
|
sequence of strings、
デフォルト = []アスペクトがホスト構成で必要とする構成フラグメントの名前のリスト。 |
toolchains
|
sequence、
デフォルト = []設定した場合、このルールに必要なツールチェーンのセット。このリストには、String、Label、StarlarkToolchainTypeApi などのオブジェクトを自由に組み合わせて含めることができます。現在のプラットフォームを確認することでツールチェーンが見つかり、 ctx.toolchain を介してルールの実装に提供されます。
|
incompatible_use_toolchain_transition
|
デフォルト = False 非推奨です。使用されなくなったため、削除する必要があります。 |
doc
|
デフォルト = '' ドキュメント生成ツールで抽出できるアスペクトの説明。 |
apply_to_generating_rules
|
デフォルト = False true の場合、アスペクトは出力ファイルに適用された場合、代わりに出力ファイルの生成ルールに適用されます。 たとえば、アスペクトが属性 `deps` を介して推移的に伝播され、ターゲットの「alpha」に適用されるとします。`alpha` に `deps = [':beta_output']` があるとします。`beta_output` はターゲットの `beta` に対して宣言された出力です。`beta` に、その `deps` の 1 つとしてターゲットの `charlie` があるとします。アスペクトに `apply_to_generating_rules=True` が設定されている場合、アスペクトは `alpha`、`beta`、`charlie` を通じて伝播されます。False の場合、アスペクトは `alpha` にのみ伝播されます。 デフォルトは false です。 |
exec_compatible_with
|
sequence of strings、
デフォルト = []このアスペクトのすべてのインスタンスに適用される実行プラットフォームの制約のリスト。 |
exec_groups
|
dict; or None、
デフォルト = None実行グループ名（文字列）の exec_groups への辞書。設定すると、アスペクトは 1 つのインスタンス内の複数の実行プラットフォームでアクションを実行できます。詳細については、実行グループに関するドキュメントをご覧ください。
|
bazel_dep
None bazel_dep(name, version='', max_compatibility_level=-1, repo_name='', dev_dependency=False)
パラメータ
| パラメータ | 説明 |
|---|---|
name
|
必須 直接的な依存関係として追加するモジュールの名前。 |
version
|
デフォルト = '' 直接的な依存関係として追加するモジュールのバージョン。 |
max_compatibility_level
|
デフォルト = -1 直接的な依存関係として追加するモジュールでサポートされる最大 compatibility_level。このモジュールのバージョンは、サポートされている最小の compatibility_level を意味し、この属性が指定されていない場合は、最大値が暗黙的に指定されます。
|
repo_name
|
デフォルト = '' この依存関係を表す外部リポジトリの名前。デフォルトはモジュールの名前です。 |
dev_dependency
|
デフォルト = False true の場合、現在のモジュールがルート モジュールでない場合、または「--ignore_dev_dependency」が有効になっている場合、この依存関係は無視されます。 |
バインド
None bind(name, actual=None)
警告: bind() の使用はおすすめしません。バインドの問題と代替方法については、バインドの削除を検討するをご覧ください。
//external パッケージでターゲットにエイリアスを付与します。
パラメータ
| パラメータ | 説明 |
|---|---|
name
|
必須 「//external」の下のラベルエイリアス名として使用する |
actual
|
string; or None、
デフォルト = Noneエイリアスとなる実際のラベル |
ブール値
bool bool(x=False)
None、False、空の文字列（""）、数値 0、または空のコレクション（()、[] など）の場合、False を返します。それ以外の場合は、True を返します。
パラメータ
| パラメータ | 説明 |
|---|---|
x
|
デフォルト = False 変換する変数。 |
configuration_field
LateBoundDefault configuration_field(fragment, name)
使用例:
ルール属性の定義:
'_foo': attr.label(default=configuration_field(fragment='java', name='toolchain'))
ルールの実装でのアクセス:
def _rule_impl(ctx):
foo_info = ctx.attr._foo
...パラメータ
| パラメータ | 説明 |
|---|---|
fragment
|
必須 遅延バインドされた値を含む構成フラグメントの名前。 |
name
|
必須 構成フラグメントから取得する値の名前。 |
到着
depset depset(direct=None, order="default", *, transitive=None)
direct パラメータは depset の直接要素のリストで、transitive パラメータは、要素が作成された depset の間接要素になる depset のリストです。depset がリストに変換されるときに返される要素の順序は、order パラメータで指定します。詳細については、Depsets の概要をご覧ください。
依存関係のすべての要素（直接的および間接的）は、式 type(x) で取得される型と同じ型でなければなりません。
ハッシュベースのセットは反復処理中の重複を排除するために使用されるので、depset のすべての要素はハッシュ可能である必要があります。ただし、現在のところ、この不変条件は、すべてのコンストラクタで一貫してチェックされるわけではありません。一貫性のあるチェックを有効にするには、--compatibility_always_check_depset_elements フラグを使用します。今後のリリースではこれがデフォルトの動作になる予定です。問題 10313 をご覧ください。
また、要素は現在不変である必要がありますが、この制限は今後緩和される予定です。
作成されるデプセットの順序は、transitive デプセットの順序と互換性がある必要があります。"default" の注文は他の注文と互換性があります。他のすべての注文は自分とのみ互換性があります。
下位互換性/上位互換性に関する注意事項。現在、この関数は位置の items パラメータを受け入れます。これは非推奨となり、将来的に削除される予定です。削除後は、direct が depset 関数の唯一の位置パラメータになります。したがって、次の呼び出しはどちらも同等で、将来の変化にも対応できます。
depset(['a', 'b'], transitive = [...]) depset(direct = ['a', 'b'], transitive = [...])
パラメータ
| パラメータ | 説明 |
|---|---|
direct
|
sequence; or None、
デフォルト = Nonedepset の direct 要素のリスト。 |
order
|
default = "default" 新しい依存関係の走査戦略。設定可能な値については、こちらをご覧ください。 |
transitive
|
sequence of depsets; or None、
デフォルト = None要素が depset の間接要素になる depset のリスト。 |
辞書
dict dict(pairs=[], **kwargs)
パラメータ
| パラメータ | 説明 |
|---|---|
pairs
|
デフォルト = [] 要素がそれぞれ長さ 2（キー、値）であるディクショナリ、またはイテラブル。 |
kwargs
|
必須 追加エントリの辞書。 |
dir
list dir(x)
パラメータ
| パラメータ | 説明 |
|---|---|
x
|
必須 確認するオブジェクト。 |
列挙
list enumerate(list, start=0)
enumerate([24, 21, 84]) == [(0, 24), (1, 21), (2, 84)]
パラメータ
| パラメータ | 説明 |
|---|---|
list
|
必須 生成します。 |
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
|
デフォルト = False true に設定すると、この実行グループは、このグループが接続されているルールのツールチェーンと制約を継承します。他の文字列に設定すると、エラーがスローされます。 |
fail
None fail(msg=None, attr=None, *args)
パラメータ
| パラメータ | 説明 |
|---|---|
msg
|
デフォルト = None 非推奨: 代わりに位置引数を使用してください。この引数は、暗黙的に先行する位置引数として機能します。 |
attr
|
string; or None、
デフォルト = None非推奨。この文字列を含むオプションの接頭辞がエラー メッセージに追加されます。 |
args
|
必須 エラー メッセージに表示される debugPrint（デフォルトでは str と同等）でフォーマットされ、スペースで結合された値のリスト。 |
float
float float(x=unbound)
- </ph>
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
|
デフォルト = バインドなし 指定された名前の属性が構造体にない場合に返されるデフォルト値。 |
git_override
None git_override(module_name, remote, commit='', patches=[], patch_cmds=[], patch_strip=0)
パラメータ
| パラメータ | 説明 |
|---|---|
module_name
|
必須 このオーバーライドを適用する Bazel モジュール依存関係の名前。 |
remote
|
必須 リモート Git リポジトリの URL。 |
commit
|
デフォルト = '' チェックアウトする commit です。 |
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
|
必須 属性の名前。 |
ハッシュ
int hash(value)
String.hashCode() と同じアルゴリズムを使用して確定的に計算されます。つまり、s[0] * (31^(n-1)) + s[1] * (31^(n-2)) + ... + s[n-1]
パラメータ
| パラメータ | 説明 |
|---|---|
value
|
必須 ハッシュする文字列値。 |
int
int int(x, base=unbound)
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 にすることはできません。これは、8 進数と 10 進数の混同を避けるためです。文字列で表される数値の大きさは、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
|
必須 変換する文字列。 |
base
|
デフォルト = バインドなし 文字列値の解釈に使用されるベース。デフォルトは 10 です。2 ～ 36 の値にする必要があります。 x が整数リテラルであるかのようにベースを検出する場合は 0 です。値が文字列でない場合、このパラメータは指定できません。
|
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)
max(2, 5, 4) == 5 max([5, 6, 3]) == 6
パラメータ
| パラメータ | 説明 |
|---|---|
args
|
必須 チェック対象の要素です。 |
分
unknown min(*args)
min(2, 5, 4) == 2 min([5, 6, 3]) == 3
パラメータ
| パラメータ | 説明 |
|---|---|
args
|
必須 チェック対象の要素です。 |
モジュール
None module(name='', version='', compatibility_level=0, repo_name='', bazel_compatibility=[])
1 回だけ呼び出す必要があります。このモジュールは、このモジュールがルート モジュールである場合にのみ省略できます（別のモジュールに依存しない場合など）。
パラメータ
| パラメータ | 説明 |
|---|---|
name
|
デフォルト = '' モジュールの名前。このモジュールがルート モジュールである場合にのみ省略できます（別のモジュールに依存しない場合と同様です）。有効なモジュール名は、1）小文字（a ～ z）、数字（0 ～ 9）、ドット（.）、ハイフン（-）、アンダースコア（_）のみを使用する。2）小文字で始まる3）末尾が英小文字または数字である。 |
version
|
デフォルト = '' モジュールのバージョン。このモジュールがルート モジュールである場合にのみ省略できます（別のモジュールに依存しない場合と同様です）。 |
compatibility_level
|
デフォルト = 0 モジュールの互換性レベル互換性のない大きな変更が行われるたびに変更する必要があります。これは基本的に「メジャー バージョン」です。SemVer で表します。ただし、バージョン文字列自体に埋め込まれるのではなく、個別のフィールドとして存在します。互換性レベルが異なるモジュールは、名前の異なるモジュールであるかのようにバージョン解決に関与しますが、最終的な依存関係グラフに、名前が同じで互換性レベルが異なる複数のモジュールを含めることはできません（ multiple_version_override が有効な場合は除きます。詳細については、そちらをご覧ください）。
|
repo_name
|
デフォルト = '' モジュール自体から見える、このモジュールを表すリポジトリの名前。デフォルトでは、リポジトリの名前はモジュールの名前です。これを指定すると、モジュール名とは異なるリポジトリ名を使用しているプロジェクトの移行が容易になります。 |
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 以降でのみ利用可能な機能に依存している場合は、Used を使用します。-X.X.X: Bazel バージョン X.X.X に互換性がありません。障害となる X.X.X のバグが新しいバージョンで修正された場合に使用します。 |
module_extension
unknown module_extension(implementation, *, tag_classes={}, doc='', environ=[], os_dependent=False, arch_dependent=False)パラメータ
| パラメータ | 説明 |
|---|---|
implementation
|
必須 このモジュール拡張機能を実装する関数。単一のパラメータ module_ctx を取る必要があります。この関数は、ビルドの開始時に一度呼び出され、使用可能なリポジトリのセットを決定します。
|
tag_classes
|
default = {} 拡張機能で使用されるすべてのタグクラスを宣言するためのディクショナリ。タグクラスの名前から tag_class オブジェクトにマッピングされます。
|
doc
|
デフォルト = '' ドキュメント生成ツールで抽出できるモジュール拡張機能の説明。 |
environ
|
sequence of strings、
デフォルト = []このモジュール拡張機能が依存する環境変数のリストを指定します。そのリスト内の環境変数が変更されると、拡張機能が再評価されます。 |
os_dependent
|
デフォルト = False この拡張機能が OS に依存しているかどうかを示します |
arch_dependent
|
デフォルト = False この拡張機能がアーキテクチャに依存するかどうかを示します |
multiple_version_override
None multiple_version_override(module_name, versions, registry='')
パラメータ
| パラメータ | 説明 |
|---|---|
module_name
|
必須 このオーバーライドを適用する Bazel モジュール依存関係の名前。 |
versions
|
Iterable of strings、
必須共存を許可するバージョンを明示的に指定します。これらのバージョンは、依存関係グラフの事前選択にすでに存在している必要があります。このモジュールに対する依存関係は「アップグレード済み」になります同じ互換性レベルで許可されたバージョンに最も近いものに設定されます。一方、依存関係が同じ互換性レベルで許可されているバージョンよりも高いバージョンを持つ場合、エラーが発生します。 |
registry
|
デフォルト = '' このモジュールのレジストリをオーバーライドします。レジストリのデフォルト リストからこのモジュールを見つける代わりに、指定したレジストリを使用する必要があります。 |
プリント
None print(sep=" ", *args)
args をデバッグ出力として出力します。先頭に、文字列 "DEBUG" とこの呼び出しの場所（ファイル番号と行番号）が付加されます。引数が文字列に変換される具体的な方法は指定されていませんが、いつでも変更される可能性があります。特に、str() や repr() によって行われる書式設定とは異なる（より詳細な）場合があります。製品版のコードで print を使用することは、ユーザーにスパムが発生するためおすすめしません。非推奨については、可能な限り fail() を使用してハードエラーを取得することをおすすめします。
パラメータ
| パラメータ | 説明 |
|---|---|
sep
|
デフォルト = "「 」 オブジェクト間の区切り文字。デフォルトはスペース（「 」）です。 |
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
|
デフォルト = '' ドキュメント生成ツールで抽出できるプロバイダの説明。 |
fields
|
sequence of strings; or dict; or None、
デフォルト = None指定すると、許可される一連のフィールドが制限されます。 有効な値は次のとおりです。
|
init
|
callable; or None、
デフォルト = Noneインスタンス化の際にプロバイダのフィールド値を前処理して検証するためのコールバック（省略可）。 init が指定された場合、provider() は通常のプロバイダ シンボルと未加工のコンストラクタの 2 つの要素のタプルを返します。詳細な説明は以下のとおりです。直感的な説明とユースケースについては、ルール（プロバイダのカスタム初期化）をご覧ください。
init コールバックが指定されていない場合、シンボル P 自体の呼び出しは、デフォルトのコンストラクタ関数 c の呼び出しとして機能します。つまり、P(*args, **kwargs) は c(*args, **kwargs) を返します。次に例を示します。MyInfo = provider() m = MyInfo(foo = 1) m が m.foo == 1 を持つ MyInfo インスタンスになるように簡単にします。ただし、
注: 上記の手順は、 このように、
MyInfo, _new_myinfo = provider(init = ...) |
範囲
sequence range(start_or_stop, stop_or_none=None, step=1)
step の増分を使用して、項目が start から stop まで進むリストを作成します。引数が 1 つしかない場合、items の範囲は 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、
デフォルト = None結果リストに含めない最初のアイテムのインデックス（省略可） stop に達する前にリストの生成が停止します。
|
step
|
デフォルト = 1 増分値（デフォルトは 1）。負の値の場合もあります。 |
register_execution_platforms()
None register_execution_platforms(*platform_labels)
パラメータ
| パラメータ | 説明 |
|---|---|
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)
パラメータ
| パラメータ | 説明 |
|---|---|
toolchain_labels
|
sequence of strings、
必須登録するツールチェーンのラベル。 |
register_toolchains(dev_dependency)
None register_toolchains(dev_dependency=False, *toolchain_labels)
@ または // で始まるパターン）にする必要があります。詳細については、ツールチェーンの解決をご覧ください。
パラメータ
| パラメータ | 説明 |
|---|---|
dev_dependency
|
デフォルト = False true の場合、現在のモジュールがルート モジュールでない場合、または「--ignore_dev_dependency」が有効になっている場合、ツールチェーンは登録されません。 |
toolchain_labels
|
sequence of strings、
必須登録するツールチェーンのラベル。 |
repository_rule
callable repository_rule(implementation, *, attrs=None, local=False, environ=[], configure=False, remotable=False, doc='')
パラメータ
| パラメータ | 説明 |
|---|---|
implementation
|
必須 実装します。単一のパラメータ repository_ctx を指定する必要があります。この関数は、ルールのインスタンスごとに、読み込みフェーズで呼び出されます。
|
attrs
|
dict; or None、
デフォルト = Noneルールのすべての属性を宣言できます。属性名から属性オブジェクトにマッピングされます（attr モジュールを参照）。 _ で始まる属性は非公開であり、ラベルへの暗黙的な依存関係をファイルに追加するために使用できます（リポジトリ ルールは生成されたアーティファクトに依存できません）。属性 name は暗黙的に追加されており、指定することはできません。
|
local
|
デフォルト = False このルールはローカル システムからすべてを取得するため、取得のたびに再評価する必要があることを示します。 |
environ
|
sequence of strings、
デフォルト = []このリポジトリ ルールが依存する環境変数のリストを指定します。そのリスト内の環境変数が変更されると、リポジトリが再取得されます。 |
configure
|
デフォルト = False リポジトリが構成のためにシステムを検査することを示します |
remotable
|
デフォルト = False 試験運用版。このパラメータは試験運用版で、いつでも変更できます。これに依存しないでください。 ---experimental_repo_remote_exec を設定することで、試験運用版として有効にできます。リモート実行との互換性あり |
doc
|
デフォルト = '' ドキュメント生成ツールで抽出できるリポジトリ ルールの説明。 |
repr
string repr(x)
repr("ab") == '"ab"'パラメータ
| パラメータ | 説明 |
|---|---|
x
|
必須 変換するオブジェクト。 |
反転
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)
ルールは、.bzl ファイル内のグローバル変数に割り当てる必要があります。グローバル変数の名前はルールの名前です。
テストルールには _test で終わる名前が必要ですが、他のすべてのルールには、この接尾辞を付けないでください。（この制限はルールにのみ適用され、ターゲットには適用されません）。
パラメータ
| パラメータ | 説明 |
|---|---|
implementation
|
必須 Starlark の関数でこのルールを実装する場合、パラメータは 1 つだけ ctx としません。この関数は、ルールのインスタンスごとに分析フェーズで呼び出されます。ユーザーが指定した属性にアクセスできます。宣言されたすべての出力を生成するアクションを作成する必要があります。 |
test
|
デフォルト = False このルールがテストルールであるかどうか、つまり blaze test コマンドのサブジェクトであるかどうかです。すべてのテストルールは自動的に実行可能とみなされます。テストルールで executable = True を明示的に設定する必要はありません（推奨されません）。詳しくは、 ルールのページをご覧ください。
|
attrs
|
dict; or None、
デフォルト = Noneルールのすべての属性を宣言できます。属性名から属性オブジェクトにマッピングされます（attr モジュールを参照）。 _ で始まる属性は非公開であり、ラベルへの暗黙的な依存関係の追加に使用できます。属性 name は暗黙的に追加されており、指定することはできません。属性 visibility、deprecation、tags、testonly、features は暗黙的に追加され、オーバーライドできません。ほとんどのルールで必要な属性は、ほんの一握りです。メモリ使用量を制限するために、ルール関数では属性のサイズに上限を設けています。
|
outputs
|
dict; or None; or function、
デフォルト = None非推奨。このパラメータは非推奨となっており、まもなく削除されます。これに依存しないでください。 ---incompatible_no_rule_outputs_param により無効になります。このフラグを使用して、コードが間もなく削除される可能性があることを確認します。このパラメータのサポートは終了しました。代わりに OutputGroupInfo または attr.output を使用するようにルールを移行してください。事前に宣言された出力を定義するスキーマ この引数の値は、ディクショナリか、ディクショナリを生成するコールバック関数のいずれかです。コールバックは、計算された依存関係属性と同様に機能します。関数のパラメータ名はルールの属性と照合されます。たとえば、 ディクショナリ内の各エントリは、事前に宣言された出力を作成します。キーは識別子で、値は出力ラベルを決定する文字列テンプレートです。ルールの実装関数では、識別子が
実際には、最も一般的な置換プレースホルダは |
executable
|
デフォルト = False このルールが実行可能とみなされるかどうか、つまり、 blaze run コマンドのサブジェクトである可能性があるかどうか。詳しくは、 ルールのページをご覧ください。
|
output_to_genfiles
|
デフォルト = False true の場合、ファイルは bin ディレクトリではなく genfiles ディレクトリに生成されます。既存のルールとの互換性が必要な場合（C++ のヘッダー ファイルを生成する場合など）を除き、このフラグは設定しないでください。 |
fragments
|
sequence of strings、
デフォルト = []ルールがターゲット構成で必要とする構成フラグメントの名前のリスト。 |
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
|
デフォルト = False 非推奨です。使用されなくなったため、削除する必要があります。 |
doc
|
デフォルト = '' ドキュメント生成ツールで抽出できるルールの説明。 |
provides
|
デフォルト = [] 実装関数が返すプロバイダのリスト。 実装関数で、以下のいずれかのタイプのプロバイダが戻り値から除外されている場合、エラーになります。ただし、実装関数は、ここに記載されていない追加のプロバイダを返すことがあります。 リストの各要素は、 |
exec_compatible_with
|
sequence of strings、
デフォルト = []このルールタイプのすべてのターゲットに適用される実行プラットフォームの制約のリスト。 |
analysis_test
|
デフォルト = False true の場合、このルールは分析テストとして扱われます。 注: 分析テストルールは、主に Starlark のコアライブラリで提供されるインフラストラクチャを使用して定義されます。詳しくは、テストをご覧ください。 ルールが分析テストルールとして定義されている場合、その属性の analysis_test_transition を使用して定義された設定の移行を使用できますが、いくつかの制限が適用されます。
|
build_setting
|
BuildSetting; or None、
デフォルト = None設定する場合、このルールの build setting の種類を表します。config モジュールをご覧ください。これが設定されている場合、"build_setting_default" という名前の必須属性ここで渡された値に対応する型とともに、このルールが自動的に追加されます。
|
cfg
|
デフォルト = None 設定されている場合は、分析前にルールが独自の構成に適用される構成の遷移を指定します。 |
exec_groups
|
dict; or None、
デフォルト = None実行グループ名（文字列）の exec_groups への辞書。設定すると、ルールによって 1 つのターゲット内の複数の実行プラットフォームでアクションを実行できます。詳細については、実行グループに関するドキュメントをご覧ください。
|
compile_one_filetype
|
sequence of strings; or None、
デフォルト = None--compile_one_dependency で使用: 指定されたファイルを複数のルールで使用する場合、他のルールよりもこのルールを選択します。 |
name
|
string; or None、
デフォルト = None非推奨。このパラメータは非推奨となっており、まもなく削除されます。これに依存しないでください。 --+incompatible_remove_rule_name_parameter により無効になります。このフラグを使用して、コードが間もなく削除される可能性があることを確認します。非推奨: 使用しないでください。 Bazel で認識され、Logging、 このパラメータを省略すると、ルールの名前は、宣言元の .bzl モジュール内でこのルールにバインドされる最初の Starlark グローバル変数の名前に設定されます。したがって、名前が ルールに明示的な名前を指定しても、ルールをインスタンス化できる場所は変更されません。 |
選択
unknown select(x, no_match_error='')
select() は、ルール属性を構成可能にするヘルパー関数です。詳しくは、ビルドの百科事典をご覧ください。
パラメータ
| パラメータ | 説明 |
|---|---|
x
|
必須 構成条件を値にマッピングする辞書。各キーは、config_setting または constraint_value インスタンスを識別するラベルまたはラベル文字列です。文字列の代わりにラベルを使用するタイミングについては、マクロに関するドキュメントをご覧ください。 |
no_match_error
|
デフォルト = '' 条件が一致しない場合に報告するカスタムエラー（省略可）。 |
single_version_override
None single_version_override(module_name, version='', registry='', patches=[], patch_cmds=[], patch_strip=0)
パラメータ
| パラメータ | 説明 |
|---|---|
module_name
|
必須 このオーバーライドを適用する Bazel モジュール依存関係の名前。 |
version
|
デフォルト = '' 依存関係グラフ内でこのモジュールの宣言されたバージョンをオーバーライドします。言い換えると、このモジュールは「固定」オーバーライドできますオーバーライドする対象がレジストリまたはパッチの場合は、この属性を省略できます。 |
registry
|
デフォルト = '' このモジュールのレジストリをオーバーライドします。レジストリのデフォルト リストからこのモジュールを見つける代わりに、指定したレジストリを使用する必要があります。 |
patches
|
Iterable of strings、
デフォルト = []このモジュールに適用するパッチファイルを指すラベルのリスト。パッチファイルは、最上位プロジェクトのソースツリーに存在している必要があります。これらはリスト順に適用されます。 |
patch_cmds
|
Iterable of strings、
デフォルト = []パッチ適用後に Linux/macOS で適用される Bash コマンドの順序。 |
patch_strip
|
デフォルト = 0 Unix パッチの --strip 引数と同じです。 |
並べ替え済み
list sorted(iterable, *, key=None, reverse=False)
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='')
パラメータ
| パラメータ | 説明 |
|---|---|
attrs
|
default = {} このタグクラスのすべての属性を宣言するための辞書。属性名から属性オブジェクトにマッピングされます（attr モジュールを参照）。 |
doc
|
デフォルト = '' ドキュメント生成ツールで抽出できるタグクラスの説明。 |
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"
if type(x) == type([]): # if x is a list
パラメータ
| パラメータ | 説明 |
|---|---|
x
|
必須 タイプを確認するオブジェクト。 |
use_extension
module_extension_proxy use_extension(extension_bzl_file, extension_name, *, dev_dependency=False, isolate=False)
パラメータ
| パラメータ | 説明 |
|---|---|
extension_bzl_file
|
必須 モジュール拡張子を定義する Starlark ファイルのラベル。 |
extension_name
|
必須 使用するモジュール拡張機能の名前。この名前のシンボルは、Starlark ファイルによってエクスポートする必要があります。 |
dev_dependency
|
デフォルト = False true の場合、現在のモジュールがルート モジュールでない場合、または「--ignore_dev_dependency」が有効になっている場合、このモジュール拡張機能の使用は無視されます。 |
isolate
|
デフォルト = False 試験運用版。このパラメータは試験運用版で、いつでも変更できます。これに依存しないでください。 ---experimental_isolated_extension_usages を true に設定すると、試験運用版に基づいて有効にできます。true の場合、このモジュール拡張機能の使用は、このモジュールと他のモジュールの両方で他のすべての使用から分離されます。この用途用に作成されたタグは、他の用途に影響しません。この用途のために拡張機能によって生成されたリポジトリは、拡張機能によって生成された他のすべてのリポジトリとは区別されます。 このパラメータは現在試験運用版であり、 |
use_repo
None use_repo(extension_proxy, *args, **kwargs)
パラメータ
| パラメータ | 説明 |
|---|---|
extension_proxy
|
必須use_extension 呼び出しによって返されるモジュール拡張プロキシ オブジェクト。
|
args
|
必須 インポートするリポジトリの名前。 |
kwargs
|
必須 現在のモジュールのスコープにインポートする特定のリポジトリを異なる名前で指定します。キーは現在のスコープで使用する名前にする必要がありますが、値はモジュール拡張機能によってエクスポートされた元の名前である必要があります。 |
visibility
None visibility(value)
現在初期化されている .bzl モジュールの読み込み可視性を設定します。
モジュールの読み込みの可否は、他の BUILD ファイルや .bzl ファイルの読み込み可否を制御します。（これは、ファイルが他のターゲットの依存関係として表示されるかどうかを管理する、基になる .bzl ソースファイルのターゲット可視性とは異なります）。読み込みの可視性はパッケージのレベルで機能します。モジュールを読み込むには、読み込みを行うファイルが、モジュールへの可視性が付与されたパッケージに存在する必要があります。モジュールは、可視性に関係なく、常にそれぞれのパッケージ内で読み込めます。
visibility() は .bzl ファイルごとに 1 回だけ呼び出すことができます。関数内ではトップレベルで呼び出すことはできません。推奨されるスタイルは、この呼び出しを load() ステートメントの直下と、引数の決定に必要な簡単なロジックのすぐ下に配置することです。
フラグ --check_bzl_visibility が false に設定されている場合、読み込みの可視性違反により警告が出力されますが、ビルドは失敗しません。
パラメータ
| パラメータ | 説明 |
|---|---|
value
|
必須 パッケージ仕様の文字列のリスト、または単一のパッケージ仕様の文字列。 パッケージ仕様は
「@」構文は使用できません。すべての仕様は、現在のモジュールのリポジトリに対して相対的に解釈されます。
フラグ |
ワークスペース
None workspace(name)
この関数は WORKSPACE ファイルでのみ使用できます。また、WORKSPACE ファイル内の他のすべての関数の前に宣言する必要があります。各 WORKSPACE ファイルには workspace 関数が必要です。
このワークスペースの名前を設定します。ワークスペース名は、Java パッケージ スタイルのプロジェクトの記述にする必要があります。区切り文字にはアンダースコアを使用します。たとえば、「github.com/bazelbuild/bazel」では「com_github_bazelbuild_bazel」を使用します。
この名前は、リポジトリの runfile が保存されるディレクトリに使用されます。たとえば、ローカル リポジトリに実行ファイル 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
|
必須 圧縮して圧縮します |