관련성이 있음

컬렉션을 사용해 정리하기 내 환경설정을 기준으로 콘텐츠를 저장하고 분류하세요.
문제 신고 소스 보기

규칙이나 측면의 구현 함수에 전달되는 컨텍스트 객체입니다. 현재 대상을 분석하는 데 필요한 정보와 메서드에 액세스할 수 있습니다.

특히 구현 함수가 현재 타겟의 라벨, 속성, 구성 및 종속 항목의 제공자에 액세스할 수 있습니다. 출력 파일과 이를 생성하는 작업을 선언하는 메서드를 제공합니다.

컨텍스트 객체는 기본적으로 구현 함수를 호출하는 동안 유지됩니다. 연결된 함수 외부에서 이러한 객체에 액세스하는 것은 유용하지 않습니다. 자세한 내용은 규칙 페이지를 참고하세요.

회원

작업

actions ctx.actions

출력 파일을 선언하는 메서드와 이를 생성하는 작업을 포함합니다.

가로세로_ID

list ctx.aspect_ids

타겟에 적용된 모든 측면의 ID 목록입니다. 가로세로 구현 함수에서만 사용할 수 있습니다.

속성

struct ctx.attr

속성 값에 액세스하는 구조체입니다. 값은 사용자가 제공합니다. 그렇지 않은 경우 기본값이 사용됩니다. 구조체의 속성 및 그 값 유형은 rule 함수에 제공된 attrs dict의 키와 값에 해당합니다. 사용 사례 보기

bin_dir

root ctx.bin_dir

bin 디렉터리에 해당하는 루트입니다.

빌드_파일_경로

string ctx.build_file_path

소스 루트를 기준으로 하는 이 규칙의 BUILD 파일의 경로입니다.

빌드_설정_값

unknown ctx.build_setting_value

실험용. 이 입력란은 실험용이며 언제든지 변경될 수 있습니다. 여기에 의존하지 마세요.

현재 타겟으로 표시되는 빌드 설정의 값입니다. 규칙 정의에서 build_setting 속성을 설정하지 않은 규칙에서 이 필드에 액세스하면 오류가 발생합니다.

구성

configuration ctx.configuration

기본 구성 자세한 내용은 구성 유형을 참조하세요.

노출 범위_계측

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_testableTrue로 설정된 규칙의 경우, 현재 규칙에 관해 지금까지 생성된 모든 작업을 나타내는 Actions 제공자를 반환합니다. 다른 모든 규칙의 경우 None를 반환합니다. 후속 작업이 만들어질 때 제공자가 업데이트되지 않으므로, 제공자를 검사하려면 이 함수를 다시 호출해야 합니다.

이 규칙은 규칙에서 ctx 객체를 받아 작업을 생성할 수 있는 규칙 구현 도우미 함수의 테스트를 작성하는 데 도움이 됩니다.

기본 제공업체

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=[], short_paths=False)

$(location //x)를 대상 //x의 출력 파일 경로로 바꿔 지정된 문자열의 모든 $(location ...) 템플릿을 펼칩니다. 확장은 이 규칙의 직접적인 종속 항목을 가리키거나 선택적 인수 targets에 명시적으로 나열된 라벨에만 작동합니다.

참조된 타겟에 출력이 여러 개 있으면 $(location ...)에서 오류가 발생합니다. 여기서는 공백으로 구분된 출력 경로 목록을 생성하므로 $(locations ...)를 사용하세요. 단일 출력 파일에도 안전하게 사용할 수 있습니다.

이 함수는 사용자가 BUILD 파일에서 명령어를 지정하는 데 유용합니다 (예: genrule). 다른 경우에는 라벨을 직접 조작하는 것이 더 좋습니다.

매개변수

매개변수 설명
input 필수
펼칠 문자열입니다.
targets sequence of Targets; default = []
추가 조회 정보의 대상 목록입니다.
short_paths default = False
전체 실행 경로 대신 루트 상대 경로를 사용합니다.
None 값이 반환될 수 있습니다.

확장_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.

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.