追跡

7.3 · 7.2 · 7.1 · 7.0 · 6.5

ルールまたはアスペクトの実装関数に渡されるコンテキスト オブジェクト。現在のターゲットの分析に必要な情報とメソッドにアクセスできます。

特に、実装関数は現在のターゲットのラベル、属性、構成、依存関係のプロバイダにアクセスできます。出力ファイルと出力ファイルを生成するアクションを宣言するメソッドがあります。

コンテキスト オブジェクトは基本的に、実装関数の呼び出し中のみ存続します。これらのオブジェクトに関連付けられた関数以外からアクセスしても意味がありません。詳細については、ルール ページをご覧ください。

メンバー

措置

actions ctx.actions

出力ファイルと出力ファイルを生成するアクションを宣言するメソッドが含まれています。

aspect_ids

list ctx.aspect_ids

ターゲットに適用されているすべてのアスペクトの ID のリスト。アスペクト実装関数でのみ使用できます。

attr

struct ctx.attr

属性の値にアクセスするための構造体。値はユーザーが指定します（ない場合はデフォルト値が使用されます）。構造体の属性とその値の型は、rule 関数に渡される attrs ディクショナリのキーと値に対応しています。使用例をご覧ください。

bin_dir

root ctx.bin_dir

bin ディレクトリに対応するルート。

build_file_path

string ctx.build_file_path

このルールの BUILD ファイルのパス（ソースルートを基準とする相対パス）。

build_setting_value

unknown ctx.build_setting_value

現在のターゲットによって表されるビルド設定の値。build_setting 属性を設定するルールのインスタンスのコンテキストでない場合、読み取りはエラーになります。

構成

configuration ctx.configuration

デフォルト構成。詳細については、構成タイプをご覧ください。

coverage_instrumented

bool ctx.coverage_instrumented(target=None)

このルールのコンパイル アクションの実行時にコードカバレッジ計測を生成すべきかどうかを返します。target が指定されている場合は、そのターゲットで指定されたルールを返します。（ルール以外のターゲットまたは Starlark ルール ターゲットが指定されている場合は、False を返します）。--instrumentation_filter と --instrument_test_targets の構成設定に基づいて、現在のルールのソース（Target が指定されていない場合）または Target のソースを計測する必要があるかどうかを確認します。これは、構成の coverage_enabled とは異なります。構成は、カバレッジ データの収集が実行全体で有効になっているかどうかを示していますが、特定のターゲットをインストルメント化する必要があるかどうかについては示しません。

パラメータ

パラメータ 説明
target ターゲット、または None。デフォルトは None です。
ルールを指定するターゲット。指定しない場合、デフォルトは現在のルールになります。

created_actions

StarlarkValue ctx.created_actions()

_skylark_testable が 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)

非推奨。代わりに ctx.var を使用して変数にアクセスします。
「変数を作成」へのすべての参照を展開した後、文字列を返します。変数は $(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


    The set of features that are explicitly enabled by the user for this rule. See example of use.


        
file

        
struct ctx.file


    A 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]
In other words, use file to access the (singular) default output of a dependency. See example of use.


        
files

        
struct ctx.files


    A 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 Files.  It is a shortcut for:
[f for t in ctx.attr.<ATTR> for f in t.files]
 In other words, use files to access the  default outputs of a dependency. See example of use.


        
fragments

        
fragments ctx.fragments


    Allows access to configuration fragments in target configuration.


        
genfiles_dir

        
root ctx.genfiles_dir


    The root corresponding to genfiles directory.


        
info_file

        
File ctx.info_file


    The file that is used to hold the non-volatile workspace status for the current build request. See documentation for --workspace_status_command for more information.


        
label

        
Label ctx.label


    The label of the target currently being analyzed.


        
outputs

        
structure ctx.outputs


    A pseudo-struct containing all the predeclared output files, represented by 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 corresponding File.
  • 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 corresponding File; otherwise the field value is None.
  • 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 of File 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 or test, 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 the executable arg of DefaultInfo.



        
resolve_command

        
tuple ctx.resolve_command(command='', attribute=None, expand_locations=False, make_variables=None, tools=[], label_dict={}, execution_requirements={})


    (Experimental) Returns a tuple (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=[])


    Returns a tuple (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


    Rule attributes descriptor for the rule that the aspect is applied to. Only available in aspect implementation functions.


        
runfiles

        
runfiles ctx.runfiles(files=[], transitive_files=None, collect_data=False, collect_default=False, symlinks={}, root_symlinks={})


    Creates a runfiles object.

          
      
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.
            

          

                  

            
            
                          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.
            		
          

                  

            
            
                          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


    A struct to access the values of attributes with split configurations. If the attribute is a label list, the value of split_attr is a dict of the keys of the split (as strings) to lists of the ConfiguredTargets in that branch of the split. If the attribute is a label, then the value of split_attr is a dict of the keys of the split (as strings) to single ConfiguredTargets. Attributes with split configurations still appear in the attr struct, but their values will be single lists with all the branches of the split merged together.


        
super

        
unknown ctx.super()


    Experimental: Calls parent's implementation function and returns its providers


        
target_platform_has_constraint

        
bool ctx.target_platform_has_constraint(constraintValue)


    Returns true if the given constraint value is part of the current target platform.

          
      
Parameters

      

        
          
          
        
        
          

            Parameter
            Description
          

        
        
                  

            
              constraintValue
            
            
                                     required

                          The constraint value to check the target platform against.
            		
          

                
      


        
toolchains

        
ToolchainContext ctx.toolchains


    Toolchains for the default exec group of this rule.


        
var

        
dict ctx.var


    Dictionary (String to String) of configuration variables.


        
version_file

        
File ctx.version_file


    The file that is used to hold the volatile workspace status for the current build request. See documentation for --workspace_status_command for more information.


        
workspace_name

        
string ctx.workspace_name


    The name of the workspace, which is effectively the execution root name and runfiles prefix for the main repo. If --enable_bzlmod is on, this is the fixed string _main. Otherwise, this is the workspace name as defined in the WORKSPACE file.