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. Công cụ này cấp quyền truy cập vào thông tin và phương pháp 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.actions
aspect_ids
list ctx.aspect_ids
attr
struct ctx.attr
attrs
dict được cung cấp cho hàm rule
. Xem ví dụ về cách sử dụng.
bin_dir
root ctx.bin_dir
build_file_path
string ctx.build_file_path
build_setting_value
unknown ctx.build_setting_value
build_setting
, thì bạn sẽ thấy lỗi.
cấu hình
configuration ctx.configuration
coverage_instrumented
bool ctx.coverage_instrumented(target=None)
target
). (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, trong đó lưu ý 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ộ lần chạy hay không, chứ không phải liệu một mục tiêu cụ thể có được đo lường hay không.
Thông 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()
True
, kết quả trả về sẽ trả về trình cung cấp Actions
đại diện cho tất cả các hành động được tạo tính đến thời điểm hiện tại cho quy tắc hiện tại. Đối với tất cả các quy tắc khác, hàm sẽ trả về None
. Lưu ý trình cung cấp này không được cập nhật khi các thao tác 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 chúng. Mục đích của API này là viết mã kiểm thử cho các chức năng trợ giúp triển khai quy tắc. Các chức năng này có thể nhận đối tượng
ctx
và tạo thao tác trên đối tượng đó.
disabled_features
list ctx.disabled_features
exec_groups
ExecGroupCollection ctx.exec_groups
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ì sẽ không có trường cấu trúc tương ứng nào được tạo. Xem ví dụ về cách sử dụng.
expand_location
string ctx.expand_location(input, targets=[])
$(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, bạn thường nên thao tác trực tiếp với nhãn.
Thông số
Thông số | Mô tả |
---|---|
input
|
bắt buộc Chuỗi cần được 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)
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
|
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
file
struct ctx.file
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]
file
to access the (singular) default output of a dependency. See example of use.
files
struct ctx.files
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]
files
to access the default outputs of a dependency. See example of use.
fragments
fragments ctx.fragments
genfiles_dir
root ctx.genfiles_dir
info_file
File ctx.info_file
label
Label ctx.label
outputs
structure ctx.outputs
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={})
(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=[])
(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
runfiles
runfiles ctx.runfiles(files=[], transitive_files=None, collect_data=False, collect_default=False, symlinks={}, root_symlinks={})
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. |
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_attr
super
unknown ctx.super()
target_platform_has_constraint
bool ctx.target_platform_has_constraint(constraintValue)
Parameters
Parameter | Description |
---|---|
constraintValue
|
required The constraint value to check the target platform against. |
toolchains
ToolchainContext ctx.toolchains
var
dict ctx.var
version_file
File ctx.version_file
workspace_name
string ctx.workspace_name
--enable_bzlmod
is on, this is the fixed string _main
. Otherwise, this is the workspace name as defined in the WORKSPACE file.