ctx

問題を報告 ソースを表示

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

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

Context オブジェクトは、基本的に実装関数を呼び出す間有効です。関連する関数の外部でこれらのオブジェクトにアクセスすることは有用ではありません。詳しくは、ルールのページをご確認ください。

メンバー

措置

actions ctx.actions

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

アスペクト比_

list ctx.aspect_ids

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

属性

struct ctx.attr

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

bin_dir

root ctx.bin_dir

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

build_file_path

string ctx.build_file_path

このルールの BUILD ファイルのパス（ソースルートからの相対パス）。

ビルド設定値

unknown ctx.build_setting_value

試験運用版。このフィールドは試験段階であり、随時変更される可能性があります。依存しないでください。

現在のターゲットで表されるビルド設定の値。ルール定義で build_setting 属性を設定していないルールについて、このフィールドにアクセスするとエラーが発生します。

構成

configuration ctx.configuration

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

#scope_instrumented

bool ctx.coverage_instrumented(target=None)

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

パラメータ

パラメータ 説明
target Target; or None; default = None
ルールを指定したターゲット。指定しなかった場合、現在のルールがデフォルトです。

作成済みアクション

StarlarkValue ctx.created_actions()

_skylark_testable が True に設定されているルールの場合、現在のルールに対してこれまでに作成されたすべてのアクションを表す Actions プロバイダが返されます。他のすべてのルールについては、None を返します。以降のアクションの作成時はプロバイダが更新されないため、関数を検査したい場合はこの関数を再度呼び出す必要があります。

これは、ctxオブジェクトを取得してアクションを作成するルール実装ヘルパー関数のテストを作成することを目的としています。

default_provider

Provider ctx.default_provider

非推奨です。代わりに DefaultInfo を使用してください。

無効になる機能

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 とマークされていない場合、対応する構造体フィールドは生成されません。使用例をご覧ください。

エキスパンド場所

string ctx.expand_location(input, targets=[])

$(location //x) をターゲット //x の出力ファイルのパスに置き換えて、指定された文字列内のすべての $(location ...) テンプレートを展開します。展開は、このルールの直接的な依存関係を参照するラベル、またはオプションの引数 targets に明示的に指定されたラベルに対してのみ機能します。

$(location ...) は、参照先のターゲットに複数の出力がある場合にエラーが発生します。この場合は、スペースで区切った出力パスのリストが生成されるため、$(locations ...) を使用してください。単一の出力ファイルにも安全に使用できます。

この関数は、ユーザーがビルドファイルでコマンドを指定できるようにする場合に役立ちます（genrule など）。それ以外の場合は、多くの場合、ラベルを直接操作する方が適切です。

パラメータ

パラメータ 説明
input 必須
展開する文字列。
targets sequence of Targets; default = []
追加のルックアップ情報のターゲットのリスト。
None を返すことがあります。

エキスパンド変数

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.


        
new_file

        
File ctx.new_file(var1, var2=unbound, var3=unbound)


    DEPRECATED. Use ctx.actions.declare_file. 
Creates a file object. There are four possible signatures to this method:
  • new_file(filename): Creates a file object with the given filename in the current package.
  • new_file(file_root, filename): Creates a file object with the given filename under the given file root.
  • new_file(sibling_file, filename): Creates a file object in the same directory as the given sibling file.
  • new_file(file_root, sibling_file, suffix): Creates a file object with same base name of the sibling_file but with different given suffix, under the given file root.
 
Does not actually create a file on the file system, just declares that some action will do so. You must create an action that generates the file. If the file should be visible to other rules, declare a rule output instead when possible. Doing so enables Blaze to associate a label with the file that rules can refer to (allowing finer dependency control) instead of referencing the whole rule.

          
      
Parameters

      

        
          
          
        
        
          

            Parameter
            Description
          

        
        
                  

            
              var1
            
            
                          string; or root; or File;
                                     required


            		
          

                  

            
              var2
            
            
                          string; or File;
                                     default = unbound


            		
          

                  

            
              var3
            
            
                          string;
                                     default = unbound


            		
          

                
      


        
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 = ''

                          Command to resolve.
            		
          

                  

            
              attribute
            
            
                          string; or None;
                                     default = None

                          Name of the associated attribute for which to issue an error, or None.
            		
          

                  

            
              expand_locations
            
            
                                     default = False

                          Shall we expand $(location) variables? See ctx.expand_location() for more details.
            		
          

                  

            
              make_variables
            
            
                          dict; or None;
                                     default = None

                          Make variables to expand, or None.
            		
          

                  

            
              tools
            
            
                          sequence of Targets;
                                     default = []

                          List of tools (list of targets).
            		
          

                  

            
              label_dict
            
            
                                     default = {}

                          Dictionary of resolved labels and the corresponding list of Files (a dict of Label : list of Files).
            		
          

                  

            
              execution_requirements
            
            
                                     default = {}

                          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 = []

                          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 = []

                          The list of files to be added to the runfiles.
            		
          

                  

            
              transitive_files
            
            
                          depset of Files; or None;
                                     default = 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 = 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 = 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 = {}

                          Either a SymlinkEntry depset or the map of symlinks, prefixed by workspace name, to be added to the runfiles. See Runfiles symlinks in the rules guide.
            		
          

                  

            
            
                          dict; or depset of SymlinkEntrys;
                                     default = {}

                          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.


        
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 workspace name as defined in the WORKSPACE file.