관련성이 있음

문제 신고 소스 보기 Nightly · 7.4 . 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 구성 설정에 따라 현재 규칙의 소스 (타겟이 제공되지 않은 경우) 또는 타겟의 소스를 계측해야 하는지 확인합니다. 이는 전체 실행에 적용되는 적용 범위 데이터 수집 여부를 나타내지만 특정 타겟을 계측해야 하는지 여부는 나타내지 않는 구성의 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를 사용하여 변수에 액세스합니다.
모든 참조를 '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


    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.