グローバル

メンバー

• すべて
• analysis_test_migration
• 任意
• archive_override
• アスペクト
• bazel_dep
• bind
• ブール値
• configuration_field
• depset
• dict
• dir
• 列挙型
• exec_group
• 失敗
• float
• getattr
• git_override
• hasattr
• ハッシュ
• int
• len
• リスト
• local_path_override
• max
• min
• module
• module_extension
• multiple_version_override
• print
• provider
• 範囲
• register_execution_platforms()
• register_execution_platforms()
• register_toolchains()
• register_toolchains()
• repository_rule（implementation、attrs、local、environ、configure、remotable、doc）
• repository_rule（implementation、attrs、local、environ、configure、remotable、doc）
• repr
• 反転
• rule
• 選択
• single_version_override
• 並べ替え済み
• str
• tag_class
• タプル
• type
• use_extension
• use_repo
• 可視性
• workspace
• zip

all

bool all(elements)

all(["hello", 3, True]) == True
all([-1, 0, 1]) == False

パラメータ

analytics_test_migration

transition analysis_test_transition(settings)

analytics-test ルールの依存関係に適用する構成遷移を作成します。この移行は、analysis_test = True を持つルールの属性にのみ適用されます。このようなルールは機能において制限があります（たとえば、依存関係ツリーのサイズに制限があるため）。そのため、この関数を使用して作成する移行は、migration を使用して実行される遷移と比較して潜在的な範囲が限定されます。

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

パラメータ

任意

bool any(elements)

any([-1, 0, 1]) == True
any([False, 0, ""]) == False

パラメータ

archive_override

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

パラメータ

アスペクト

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)

パラメータ

bazel_dep

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

パラメータ

bind

None bind(name, actual=None)

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

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

パラメータ

ブール値

bool bool(x=False)

パラメータ

構成フィールド

LateBoundDefault configuration_field(fragment, name)

使用例:

ルール属性の定義:

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

ルールの実装でアクセスする:

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

パラメータ

Depset

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

デプセットのすべての要素（直接的および間接的）は、式 type(x) で得られるのと同じ型でなければなりません。

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

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

作成した Depset の順序は、transitive Depset の順序と互換性がある必要があります。"default" の注文は他の注文と互換性があります。他のすべての注文は、他のデベロッパーとのみ互換性があります。

下位互換性と上位互換性に関する注意事項。この関数は現在、位置を示す items パラメータを受け入れます。これは非推奨であり、今後削除され、direct が削除されると depset 関数の唯一の位置パラメータになります。したがって、以下の呼び出しはどちらも同等で、常に問題ありません。

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

パラメータ

辞書

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

パラメータ

dir

list dir(x)

パラメータ

列挙する

list enumerate(list, start=0)

enumerate([24, 21, 84]) == [(0, 24), (1, 21), (2, 84)]

パラメータ

exec_group

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

パラメータ

fail

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

パラメータ

float

float float(x=unbound)

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

パラメータ

Getattr

unknown getattr(x, name, default=unbound)

getattr(ctx.attr, "myattr")
getattr(ctx.attr, "myattr", "mydefault")

パラメータ

git_override

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

パラメータ

ハッシャー

bool hasattr(x, name)

hasattr(ctx.attr, "myattr")

パラメータ

ハッシュ

int hash(value)

s[0] * (31^(n-1)) + s[1] * (31^(n-2)) + ... + s[n-1]

パラメータ

int

int int(x, base=unbound)

• x がすでに int である場合、int はそのまま変更を返します。
• x がブール値の場合、int は True を 1、False を 0 として返します。
• x が文字列の場合、<sign><prefix><digits> の形式にする必要があります。<sign> は、"+"、"-"、または空（正と解釈）のいずれかです。<digits> は 0 から base - 1 までの数字の並びで、a ～ z（またはこれに相当する A ～ Z）は 10 ～ 35 の数字として使用されます。base が 2/8/16 の場合、<prefix> はオプションで、それぞれ 0b/0o/0x（または同等の 0B/0O/0X）です。base がこれらのベースの底、または特別な値 0 以外の値である場合は、接頭辞を空にする必要があります。base が 0 の場合、使用されるプレフィックスに応じて基数 2/8/10/16 のいずれかが選択されるという意味で、文字列は整数リテラルとして解釈されます。base が 0 で、接頭辞を使用せず、1 桁以上の数字がある場合は、先頭の桁を 0 にすることはできません。これは、8 進数と 10 進数の混同を回避するためです。文字列で表される数値の大きさは、int 型の許容範囲内でなければなりません。
• x が浮動小数点数の場合、int は浮動小数点数の整数値を返し、ゼロに丸めます。x が非有限（NaN または無限大）の場合、エラーが発生します。

例:

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

パラメータ

len

int len(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]

パラメータ

local_path_override

None local_path_override(module_name, path)

パラメータ

最高

unknown max(*args)

max(2, 5, 4) == 5
max([5, 6, 3]) == 6

パラメータ

min

unknown min(*args)

min(2, 5, 4) == 2
min([5, 6, 3]) == 3

パラメータ

モジュール

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

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

パラメータ

module_extension

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

パラメータ

複数のバージョンをオーバーライドする

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

パラメータ

プリント

None print(sep=" ", *args)

製品版のコードで print を使用することは、ユーザーに生成される迷惑メールのため推奨されません。非推奨となる場合は、可能な限り fail() を使用してハードエラーを優先することをおすすめします。

パラメータ

プロバイダ

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 パラメータに関する説明をご覧ください。

パラメータ

MyInfo = provider()
m = MyInfo(foo = 1)

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

範囲

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

range(4) == [0, 1, 2, 3]
range(3, 9, 2) == [3, 5, 7]
range(3, 0, -1) == [3, 2, 1]

パラメータ

register_execution_platforms()

None register_execution_platforms(*platform_labels)

パラメータ

register_execution_platforms()

None register_execution_platforms(*platform_labels)

パラメータ

register_toolchains()

None register_toolchains(*toolchain_labels)

パラメータ

register_toolchains()

None register_toolchains(*toolchain_labels)

パラメータ

repository_rule（implementation、attrs、local、environ、configure、remotable、doc）

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

パラメータ

repository_rule（implementation、attrs、local、environ、configure、remotable、doc）

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

パラメータ

RPR

string repr(x)

repr("ab") == '"ab"'

パラメータ

取り消し済み

list reversed(sequence)

reversed([3, 5, 4]) == [4, 5, 3]

パラメータ

ルール

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 で終わる必要がありますが、他のすべてのルールにこのサフィックスを付けないでください。（この制限はルールにのみ適用され、ターゲットには適用されません）。

パラメータ

select

unknown select(x, no_match_error='')

パラメータ

#single_version_override

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

パラメータ

並べ替え済み

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

sorted([3, 5, 4]) == [3, 4, 5]

パラメータ

str

string str(x)

str("ab") == "ab"
str(8) == "8"

パラメータ

タグクラス

tag_class tag_class(attrs={}, *, 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)

パラメータ

type

string type(x)

type(2) == "int"
type([1]) == "list"
type(struct(a = 2)) == "struct"

if type(x) == type([]):  # if x is a list

パラメータ

#use_extension

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

パラメータ

#use_repo

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

パラメータ

visibility

None visibility(value)

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

モジュールの読み込みの公開設定によって、他の BUILD ファイルと .bzl ファイルの読み込みが可能かどうかが決まります。（これは、ファイルが他のターゲットの依存関係として表示されるかどうかを決定する、基盤となる .bzl ソースファイルのターゲットの公開設定とは異なります）。読み込みの可視性はパッケージのレベルで機能します。モジュールを読み込むには、読み込みを行うファイルが、モジュールへのアクセスが許可されているパッケージ内に存在している必要があります。モジュールの公開設定に関係なく、モジュールはいつでも独自のパッケージ内で読み込むことができます。

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

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

パラメータ

workspace

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%bar') ではなく maven_jar(name = 'foo') を使用できます。

パラメータ

zip

list zip(*args)

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)]

パラメータ