Một đối tượng ngữ cảnh được truyền đến hàm triển khai cho một quy tắc hoặc khía cạnh. Phương thức này cung cấp quyền truy cập vào thông tin và phương thức cần thiết để phân tích mục tiêu hiện tại.
Cụ thể, lớp này cho phép hàm triển khai truy cập vào nhãn, thuộc tính, cấu hình và trình cung cấp phần phụ thuộc của mục tiêu hiện tại. Thư viện này có các phương thức để khai báo tệp đầu ra và các thao tác tạo ra tệp đầu ra.
Về cơ bản, các đối tượng ngữ cảnh tồn tại trong suốt thời gian gọi hàm triển khai. Việc truy cập vào các đối tượng này bên ngoài hàm liên kết sẽ không hữu ích. Hãy xem trang Quy tắc để biết thêm thông tin.
Hội viên
- hành động
- aspect_ids
- attr
- bin_dir
- build_file_path
- build_setting_value
- cấu hình
- coverage_instrumented
- created_actions
- disabled_features
- exec_groups
- có thể thực thi
- expand_location
- expand_make_variables
- tính năng
- tệp
- tệp
- mảnh
- genfiles_dir
- info_file
- nhãn
- đầu ra
- resolve_command
- resolve_tools
- quy tắc
- runfiles
- split_attr
- super
- target_platform_has_constraint
- chuỗi công cụ
- var
- version_file
- workspace_name
hành động
actions ctx.actionsChứa các phương thức khai báo tệp đầu ra và các thao tác tạo ra các tệp đó.
aspect_ids
list ctx.aspect_idsDanh sách mã nhận dạng cho tất cả các khía cạnh được áp dụng cho mục tiêu. Chỉ có trong các hàm triển khai khía cạnh.
attr
struct ctx.attrMột cấu trúc để truy cập vào các giá trị của thuộc tính. Giá trị do người dùng cung cấp (nếu không, hệ thống sẽ sử dụng giá trị mặc định). Các thuộc tính của cấu trúc và loại giá trị tương ứng với khoá và giá trị của
attrs
dict được cung cấp cho hàm rule
. Xem ví dụ về cách sử dụng.
bin_dir
root ctx.bin_dirThư mục gốc tương ứng với thư mục bin.
build_file_path
string ctx.build_file_pathKhông dùng nữa: Sử dụng
ctx.label.package + '/BUILD'
. Đường dẫn đến tệp BUILD cho quy tắc này, tương ứng với thư mục gốc của nguồn.
build_setting_value
unknown ctx.build_setting_valueGiá trị của chế độ cài đặt bản dựng do mục tiêu hiện tại biểu thị. Nếu đây không phải là ngữ cảnh cho một thực thể của quy tắc đặt thuộc tính
build_setting
, thì việc đọc thuộc tính này sẽ gây ra lỗi.
cấu hình
configuration ctx.configurationCấu hình mặc định. Hãy xem loại cấu hình để biết thêm chi tiết.
coverage_instrumented
bool ctx.coverage_instrumented(target=None)Trả về việc có nên tạo khả năng đo lường mức độ sử dụng mã khi thực hiện các hành động biên dịch cho quy tắc này hay không, hoặc nếu
target
được cung cấp, thì quy tắc do Mục tiêu đó chỉ định. (Nếu bạn cung cấp một Mục tiêu quy tắc không phải quy tắc hoặc quy tắc Starlark, thì hàm này sẽ trả về False.) Kiểm tra xem có nên đo lường các nguồn của quy tắc hiện tại (nếu không cung cấp Mục tiêu) hay các nguồn của Mục tiêu dựa trên chế độ cài đặt cấu hình --instrumentation_filter và --instrument_test_targets hay không. Điều này khác với coverage_enabled
trong cấu hình, ghi chú liệu tính năng thu thập dữ liệu về mức độ sử dụng có được bật cho toàn bộ quá trình chạy hay không, nhưng không ghi chú liệu có nên đo lường một mục tiêu cụ thể hay không.
Tham số
Thông số | Mô tả |
---|---|
target
|
Mục tiêu; hoặc None ; giá trị mặc định là None Một Mục tiêu chỉ định một quy tắc. Nếu không được cung cấp, giá trị mặc định sẽ là quy tắc hiện tại. |
created_actions
StarlarkValue ctx.created_actions()Đối với các quy tắc có _skylark_testable được đặt thành
True
, thao tác này sẽ trả về một trình cung cấp Actions
đại diện cho tất cả các hành động đã tạo cho quy tắc hiện tại. Đối với tất cả các quy tắc khác, trả về None
. Xin lưu ý rằng trình cung cấp không được cập nhật khi các hành động tiếp theo được tạo, vì vậy, bạn sẽ phải gọi lại hàm này nếu muốn kiểm tra các hành động đó. Đây là để giúp viết mã kiểm thử cho các hàm trợ giúp triển khai quy tắc. Các hàm này có thể nhận đối tượng
ctx
và tạo hành động trên đối tượng đó.
disabled_features
list ctx.disabled_featuresTập hợp các tính năng mà người dùng đã tắt một cách rõ ràng cho quy tắc này.
exec_groups
ExecGroupCollection ctx.exec_groupsTập hợp các nhóm thực thi có sẵn cho quy tắc này, được lập chỉ mục theo tên của các nhóm đó. Truy cập bằng
ctx.exec_groups[name_of_group]
.
tệp thực thi
struct ctx.executable
struct
chứa các tệp thực thi được xác định trong thuộc tính loại nhãn được đánh dấu là executable=True
. Các trường cấu trúc tương ứng với tên thuộc tính. Mỗi giá trị trong cấu trúc là File
hoặc None
. Nếu bạn không chỉ định thuộc tính không bắt buộc trong quy tắc, thì giá trị cấu trúc tương ứng sẽ là None
. Nếu loại nhãn không được đánh dấu là executable=True
, thì hệ thống sẽ không tạo trường cấu trúc tương ứng. Xem ví dụ về cách sử dụng.
expand_location
string ctx.expand_location(input, targets=[])Mở rộng tất cả mẫu
$(location ...)
trong chuỗi đã cho bằng cách thay thế $(location //x)
bằng đường dẫn của tệp đầu ra của mục tiêu //x. Tính năng mở rộng chỉ hoạt động đối với các nhãn trỏ đến các phần phụ thuộc trực tiếp của quy tắc này hoặc được liệt kê rõ ràng trong đối số không bắt buộc targets
. $(location ...)
sẽ gây ra lỗi nếu mục tiêu được tham chiếu có nhiều đầu ra. Trong trường hợp này, vui lòng sử dụng $(locations ...)
vì hàm này tạo ra danh sách các đường dẫn đầu ra được phân tách bằng dấu cách. Bạn cũng có thể sử dụng hàm này một cách an toàn cho một tệp đầu ra.Hàm này hữu ích để cho phép người dùng chỉ định một lệnh trong tệp BUILD (chẳng hạn như cho
genrule
). Trong các trường hợp khác, tốt hơn là bạn nên trực tiếp thao tác với nhãn.
Tham số
Thông số | Mô tả |
---|---|
input
|
string;
bắt buộc Chuỗi cần mở rộng. |
targets
|
trình tự của Mục tiêu;
mặc định là [] Danh sách mục tiêu để biết thêm thông tin tra cứu. |
None
.
expand_make_variables
string ctx.expand_make_variables(attribute_name, command, additional_substitutions)Không dùng nữa. Thay vào đó, hãy sử dụng ctx.var để truy cập vào các biến.
Trả về một chuỗi sau khi mở rộng tất cả các tệp tham chiếu đến "Tạo biến". Các biến phải có định dạng sau:
$(VAR_NAME)
. Ngoài ra, $$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
|
string;
required The attribute name. Used for error reporting. |
command
|
string;
required The expression to expand. It can contain references to "Make variables". |
additional_substitutions
|
dict;
required Additional substitutions to make beyond the default make variables. |
features
list ctx.featuresThe set of features that are explicitly enabled by the user for this rule. See example of use.
file
struct ctx.fileA
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.filesA
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]In other words, use
files
to access the default outputs of a dependency. See example of use.
fragments
fragments ctx.fragmentsAllows access to configuration fragments in target configuration.
genfiles_dir
root ctx.genfiles_dirThe root corresponding to genfiles directory.
info_file
File ctx.info_fileThe 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.labelThe label of the target currently being analyzed.
outputs
structure ctx.outputsA 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 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={})(Experimental) Returns a tuple
(inputs, command, empty list)
of the list of resolved inputs and the argv list for the resolved command both 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). The empty list is returned as the third member of the tuple for backwards compatibility.
Parameters
Parameter | Description |
---|---|
command
|
string;
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
|
bool;
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
|
dict;
default is {} Dictionary of resolved labels and the corresponding list of Files (a dict of Label : list of Files). |
execution_requirements
|
dict;
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, empty list)
of the depset of resolved inputs required to run the tools, suitable for passing as the same-named argument of the ctx.actions.run
and ctx.actions.run_shell
methods. 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. The empty list is returned as part of the tuple for backward compatibility.
Parameters
Parameter | Description |
---|---|
tools
|
sequence of Targets;
default is [] List of tools (list of targets). |
rule
rule_attributes ctx.ruleRule 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
|
bool;
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
|
bool;
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_attrA 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
|
ConstraintValueInfo;
required The constraint value to check the target platform against. |
toolchains
ToolchainContext ctx.toolchainsToolchains for the default exec group of this rule.
var
dict ctx.varDictionary (String to String) of configuration variables.
version_file
File ctx.version_fileThe 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_nameThe 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.