Globals

メンバー

• すべて
• analysis_test_transition
• 任意
• archive_override
• アスペクト
• bazel_dep
• bind
• bool
• configuration_field
• depset
• dict
• dir
• enumerate
• exec_group
• fail
• float
• getattr
• git_override
• hasattr
• hash
• int
• len
• list
• local_path_override
• max
• 分
• module
• module_extension
• multiple_version_override
• print
• プロバイダ
• 範囲
• register_execution_platforms()
• register_execution_platforms(dev_dependency)
• register_toolchains()
• register_toolchains(dev_dependency)
• repository_rule
• repr
• 取り消し
• rule
• 選択
• single_version_override
• 並べ替え
• str
• tag_class
• タプル
• type
• use_extension
• use_repo
• 公開設定
• workspace
• zip

すべて

bool all(elements)

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

パラメータ

analysis_test_transition

transition analysis_test_transition(settings)

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

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

パラメータ

任意

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='', max_compatibility_level=-1, repo_name='', dev_dependency=False)

パラメータ

バインド

None bind(name, actual=None)

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

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

パラメータ

ブール値

bool bool(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
    ...

パラメータ

depset

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

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

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

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

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

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

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

パラメータ

dict

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)

パラメータ

hasattr

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 の数字のシーケンスです。ここで、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 または無限大）はエラーです。

例:

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

パラメータ

分

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='', environ=[], os_dependent=False, arch_dependent=False)

パラメータ

multiple_version_override

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

パラメータ

プリント

None print(sep=" ", *args)

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

パラメータ

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

パラメータ

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(dev_dependency)

None register_execution_platforms(dev_dependency=False, *platform_labels)

パラメータ

register_toolchains()

None register_toolchains(*toolchain_labels)

パラメータ

register_toolchains(dev_dependency)

None register_toolchains(dev_dependency=False, *toolchain_labels)

パラメータ

repository_rule

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

パラメータ

repr

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

パラメータ

選択

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 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, isolate=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 に設定されている場合、読み込みの可視性の違反は警告を出力しますが、ビルドは失敗しません。

パラメータ

ワークスペース

None workspace(name)

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

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

この名前は、リポジトリのランファイルが保存されているディレクトリに使用されます。たとえば、ローカル リポジトリに runfile foo/bar があり、WORKSPACE ファイルに workspace(name = 'baz') が含まれている場合、runfile は 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 ファイルを書き込もうとするためです。

パラメータ

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

パラメータ