ルールまたはアスペクトの実装関数に渡されるコンテキスト オブジェクト。現在の標的の解析に必要な情報および手法にアクセスできます。
特に、実装関数から現在のターゲットのラベル、属性、構成、依存関係のプロバイダにアクセスできます。出力ファイルを宣言するためのメソッドと、出力ファイルを生成するアクションがあります。
コンテキスト オブジェクトは基本的に、実装関数の呼び出しの間存続します。関連する関数の外でこれらのオブジェクトにアクセスしても意味がありません。詳しくは、ルールのページをご覧ください。
メンバー
- アクション
- aspect_ids
- attr
- bin_dir
- build_file_path
- build_setting_value
- 構成
- coverage_instrumented
- created_actions
- disabled_features
- exec_groups
- 実行可能ファイル
- expand_location
- expand_make_variables
- 機能
- ファイル
- ファイル
- フラグメント
- genfiles_dir
- info_file
- ラベル
- 出力
- resolve_command
- resolve_tools
- ルール
- runfiles
- split_attr
- スーパー
- target_platform_has_constraint
- ツールチェーン
- 変数
- version_file
- workspace_name
措置
actions ctx.actions
aspect_ids
list ctx.aspect_ids
attr
struct ctx.attr
rule
関数に渡される attrs
辞書のキーと値に対応します。使用例をご覧ください。
bin_dir
root ctx.bin_dir
build_file_path
string ctx.build_file_path
build_setting_value
unknown ctx.build_setting_value
build_setting
属性を設定するルールのインスタンスのコンテキストでない場合、読み取りはエラーになります。
構成
configuration ctx.configuration
coverage_instrumented
bool ctx.coverage_instrumented(target=None)
target
が指定されている場合は、そのターゲットで指定されたルールを返します。(ルール以外または Starlark ルールの Target が指定されている場合は、False が返されます)。現在のルールのソース(ターゲットが指定されていない場合)またはターゲットのソースを、-instrumentation_filter および --instrument_test_targets 構成設定に基づいてインストルメント化する必要があるかどうかを確認します。これは、構成の coverage_enabled
とは異なります。構成では、カバレッジ データの収集が実行全体で有効かどうかが示されますが、特定のターゲットを計測可能にするかどうかはわかりません。
パラメータ
パラメータ | 説明 |
---|---|
target
|
Target:または None
デフォルトは None です ルールを指定するターゲット。指定しない場合、デフォルトで現在のルールが使用されます。 |
created_actions
StarlarkValue ctx.created_actions()
True
に設定されているルールの場合、現在のルールに対してこれまでに作成されたすべてのアクションを表す Actions
プロバイダが返されます。他のすべてのルールの場合、None
を返します。なお、後続のアクションを作成してもプロバイダは更新されないため、アクションを検証する場合は、この関数を再度呼び出す必要があります。これは、ルール実装ヘルパー関数のテストを作成する際に役立ちます。ルール実装ヘルパー関数では、
ctx
オブジェクトを受け取ってアクションを作成できます。
disabled_features
list ctx.disabled_features
exec_groups
ExecGroupCollection ctx.exec_groups
ctx.exec_groups[name_of_group]
でアクセス。
実行可能ファイル
struct ctx.executable
executable=True
とマークされたラベルタイプの属性で定義された実行可能ファイルを含む struct
。構造体フィールドは属性名に対応しています。構造体の各値は File
または None
です。オプションの属性がルールで指定されていない場合、対応する構造体値は None
です。ラベルタイプが executable=True
とマークされていない場合、対応する構造体フィールドは生成されません。使用例をご覧ください。
expand_location
string ctx.expand_location(input, targets=[])
$(location //x)
をターゲット //x の出力ファイルのパスに置き換えて、指定された文字列内のすべての $(location ...)
テンプレートを展開します。展開は、このルールの直接的な依存関係を示すラベル、またはオプションの引数 targets
に明示的にリストされているラベルに対してのみ機能します。参照先のターゲットに複数の出力がある場合、
$(location ...)
はエラーの原因となります。この場合は、スペース区切りの出力パスのリストが生成されるため、$(locations ...)
を使用してください。単一の出力ファイルに対しても安全です。この関数は、ユーザーが BUILD ファイル(
genrule
など)でコマンドを指定できる場合に便利です。その他のケースでは、ラベルを直接操作したほうがよい場合もあります。
パラメータ
パラメータ | 説明 |
---|---|
input
|
必須 展開される文字列。 |
targets
|
ターゲットのシーケンス
デフォルトは [] 追加のルックアップ情報のターゲットのリスト。 |
None
を返すことができます。
expand_make_variables
string ctx.expand_make_variables(attribute_name, command, additional_substitutions)
すべての参照を「Make variables」に展開して文字列を返します。変数は
$(VAR_NAME)
の形式にする必要があります。また、$$VAR_NAME
expands to $VAR_NAME
. Examples:ctx.expand_make_variables("cmd", "$(MY_VAR)", {"MY_VAR": "Hi"}) # == "Hi" ctx.expand_make_variables("cmd", "$$PWD", {}) # == "$PWD" Additional variables may come from other places, such as configurations. Note that this function is experimental.Parameters
Parameter | Description |
---|---|
attribute_name
|
required The attribute name. Used for error reporting. |
command
|
required The expression to expand. It can contain references to "Make variables". |
additional_substitutions
|
required Additional substitutions to make beyond the default make variables. |
features
list ctx.features
file
struct ctx.file
struct
containing files defined in label type attributes marked as allow_single_file
. The struct fields correspond to the attribute names. The struct value is always a File
or None
. If an optional attribute is not specified in the rule then the corresponding struct value is None
. If a label type is not marked as allow_single_file
, no corresponding struct field is generated. It is a shortcut for:list(ctx.attr.<ATTR>.files)[0]
file
to access the (singular) default output of a dependency. See example of use.
files
struct ctx.files
struct
containing files defined in label or label list type attributes. The struct fields correspond to the attribute names. The struct values are list
of File
s. It is a shortcut for:[f for t in ctx.attr.<ATTR> for f in t.files]
files
to access the default outputs of a dependency. See example of use.
fragments
fragments ctx.fragments
genfiles_dir
root ctx.genfiles_dir
info_file
File ctx.info_file
label
Label ctx.label
outputs
structure ctx.outputs
File
objects. See the Rules page for more information and examples.This field does not exist on aspect contexts, since aspects do not have predeclared outputs.
The fields of this object are defined as follows. It is an error if two outputs produce the same field name or have the same label.
- If the rule declares an
outputs
dict, then for every entry in the dict, there is a field whose name is the key and whose value is the correspondingFile
. - For every attribute of type
attr.output
that the rule declares, there is a field whose name is the attribute's name. If the target specified a label for that attribute, then the field value is the correspondingFile
; otherwise the field value isNone
. - For every attribute of type
attr.output_list
that the rule declares, there is a field whose name is the attribute's name. The field value is a list ofFile
objects corresponding to the labels given for that attribute in the target, or an empty list if the attribute was not specified in the target. - (Deprecated) If the rule is marked
executable
ortest
, there is a field named"executable"
, which is the default executable. It is recommended that instead of using this, you pass another file (either predeclared or not) to theexecutable
arg ofDefaultInfo
.
resolve_command
tuple ctx.resolve_command(command='', attribute=None, expand_locations=False, make_variables=None, tools=[], label_dict={}, execution_requirements={})
(inputs, command, input_manifests)
of the list of resolved inputs, the argv list for the resolved command, and the runfiles metadata required to run the command, all of them suitable for passing as the same-named arguments of the ctx.action
method.Note for Windows users: this method requires Bash (MSYS2). Consider using
resolve_tools()
instead (if that fits your needs).
Parameters
Parameter | Description |
---|---|
command
|
default is '' Command to resolve. |
attribute
|
string; or None ;
default is None Name of the associated attribute for which to issue an error, or None. |
expand_locations
|
default is False Shall we expand $(location) variables? See ctx.expand_location() for more details. |
make_variables
|
dict; or None ;
default is None Make variables to expand, or None. |
tools
|
sequence of Targets;
default is [] List of tools (list of targets). |
label_dict
|
default is {} Dictionary of resolved labels and the corresponding list of Files (a dict of Label : list of Files). |
execution_requirements
|
default is {} Information for scheduling the action to resolve this command. See tags for useful keys. |
resolve_tools
tuple ctx.resolve_tools(tools=[])
(inputs, input_manifests)
of the depset of resolved inputs and the runfiles metadata required to run the tools, both of them suitable for passing as the same-named arguments of the ctx.actions.run
method.In contrast to
ctx.resolve_command
, this method does not require that Bash be installed on the machine, so it's suitable for rules built on Windows.
Parameters
Parameter | Description |
---|---|
tools
|
sequence of Targets;
default is [] List of tools (list of targets). |
rule
rule_attributes ctx.rule
runfiles
runfiles ctx.runfiles(files=[], transitive_files=None, collect_data=False, collect_default=False, symlinks={}, root_symlinks={})
Parameters
Parameter | Description |
---|---|
files
|
sequence of Files;
default is [] The list of files to be added to the runfiles. |
transitive_files
|
depset of Files; or None ;
default is None The (transitive) set of files to be added to the runfiles. The depset should use the default order (which, as the name implies, is the default).
|
collect_data
|
default is False Use of this parameter is not recommended. See runfiles guide. Whether to collect the data runfiles from the dependencies in srcs, data and deps attributes. |
collect_default
|
default is False Use of this parameter is not recommended. See runfiles guide. Whether to collect the default runfiles from the dependencies in srcs, data and deps attributes. |
symlinks
|
dict; or depset of SymlinkEntrys;
default is {} Either a SymlinkEntry depset or the map of symlinks to be added to the runfiles. Symlinks are always added under the main workspace's runfiles directory (e.g. <runfiles_root>/_main/<symlink_path> , not the directory corresponding to the current target's repository. See Runfiles symlinks in the rules guide.
|
root_symlinks
|
dict; or depset of SymlinkEntrys;
default is {} Either a SymlinkEntry depset or a map of symlinks to be added to the runfiles. See Runfiles symlinks in the rules guide. |
split_attr
struct ctx.split_attr
super
unknown ctx.super()
target_platform_has_constraint
bool ctx.target_platform_has_constraint(constraintValue)
Parameters
Parameter | Description |
---|---|
constraintValue
|
required The constraint value to check the target platform against. |
toolchains
ToolchainContext ctx.toolchains
var
dict ctx.var
version_file
File ctx.version_file
workspace_name
string ctx.workspace_name
--enable_bzlmod
is on, this is the fixed string _main
. Otherwise, this is the workspace name as defined in the WORKSPACE file.