Cụ thể, tuỳ chọn 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 của mục tiêu hiện tại và các trình cung cấp phần phụ thuộc. Lớp 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 các tệp đó.
Về cơ bản, các đối tượng ngữ cảnh hoạt động trong khoảng thời gian gọi hàm triển khai. Bạn không nên truy cập vào những đối tượng này bên ngoài chức năng liên kết với chúng. Hãy xem trang Quy tắc để biết thêm thông tin.
Hội viên
- hành động
- aspect_ids
- attr (giá trị thuộc tính)
- bin_dir
- build_file_path
- build_setting_value
- cấu hình
- coverage_instrumented
- created_actions
- default_provider
- 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
- host_configuration
- host_fragments
- info_file
- label
- new_file
- đầu ra
- resolve_command
- resolve_tools
- quy tắc
- runfiles
- split_attr
- target_platform_has_constraint
- chuỗi công cụ
- var
- version_file
- workspace_name
thao tác
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 khung hình.
thuộc tính
struct ctx.attrCấu trúc để truy cập vào các giá trị của thuộc tính. Các giá trị do người dùng cung cấp (nếu không, giá trị mặc định sẽ được sử dụng). Các thuộc tính của cấu trúc và loại giá trị của chúng tương ứng với các khoá và giá trị của lệnh
attrs đượ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_pathĐường dẫn đến tệp BUILD cho quy tắc này, so với thư mục gốc của nguồn.
build_setting_value
unknown ctx.build_setting_valueThử nghiệm. Trường này đang trong giai đoạn thử nghiệm và có thể thay đổi bất cứ lúc nào. Đừng phụ thuộc vào công cụ này.
Giá trị của chế độ cài đặt bản dựng được biểu thị bằng mục tiêu hiện tại. Sẽ xảy ra lỗi khi truy cập trường này đối với các quy tắc không đặt thuộc tính build_setting trong định nghĩa quy tắc.
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ề xem liệu đo lường mức độ sử dụng mã có được tạo khi thực hiện hành động biên dịch cho quy tắc này hay không, hay nếu bạn cung cấp
target, thì quy tắc do Mục tiêu đó chỉ định. (Nếu bạn cung cấp một Mục tiêu không phải quy tắc hoặc một quy tắc Starlark, thì giá trị này sẽ trả về giá trị False.) Kiểm tra xem các nguồn của quy tắc hiện tại (nếu không có Mục tiêu nào được cung cấp) hoặc các nguồn của Mục tiêu có phải được đo lường 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 (cấu hình) (giúp ghi chú liệu 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) nhưng không đo lường một mục tiêu cụ thể.
Thông số
| Thông số | Nội dung mô tả |
|---|---|
target
|
Target; or None;
mặc định = KhôngMục tiêu chỉ định quy tắc. Nếu không được cung cấp thì chế độ cài đặt 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, phương thức này sẽ trả về một trình cung cấp Hành động đại diện cho tất cả hành động được tạo cho đến thời điểm hiện tại đối với 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 sẽ 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 tính năng này là viết nội dung 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ể thực hiện đối tượng
ctx và tạo các hành động trên đối tượng đó.
default_provider
Provider ctx.default_providerKhông dùng nữa. Thay vào đó, hãy sử dụng DefaultInfo.
disabled_features
list ctx.disabled_featuresTập hợp các tính năng bị người dùng vô hiệu hoá một cách rõ ràng đối với 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 thực thi đó. 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 các 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à một File hoặc None. Nếu thuộc tính không bắt buộc không được chỉ định 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=[], short_paths=False)Mở rộng tất cả mẫu
$(location ...) trong chuỗi đã cho bằng cách thay $(location //x) bằng đường dẫn của tệp đầu ra của đích //x. Tính năng mở rộng chỉ hoạt động cho 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 dữ liệ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 cho một tệp đầu ra đơn lẻ một cách an toàn.Hàm này rất hữu ích khi cho phép người dùng chỉ định một lệnh trong tệp BUILD (như đối với
genrule). Trong các trường hợp khác, bạn nên thao tác trực tiếp với nhãn.
Thông số
| Thông số | Nội dung mô tả |
|---|---|
input
|
bắt buộc Chuỗi cần được mở rộng. |
targets
|
sequence of Targets;
mặc định = []Danh sách mục tiêu cho thông tin tra cứu bổ sung. |
short_paths
|
mặc định = Sai Sử dụng đường dẫn tương đối gốc thay vì đường dẫn đầy đủ thực thi |
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ả tham chiếu đến mục "Tạo biến". Các biến phải có định dạng như 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.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 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.fragmentsAllows access to configuration fragments in target configuration.
genfiles_dir
root ctx.genfiles_dirThe root corresponding to genfiles directory.
host_configuration
configuration ctx.host_configurationThe host configuration. See the configuration type for more details.
host_fragments
fragments ctx.host_fragmentsAllows access to configuration fragments in host configuration.
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.
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.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
outputsdict, 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.outputthat 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_listthat the rule declares, there is a field whose name is the attribute's name. The field value is a list ofFileobjects 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
executableortest, 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 theexecutablearg 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, 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 = NoneName 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 = NoneMake 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.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 = []The list of files to be added to the runfiles. |
transitive_files
|
depset of Files; or None;
default = NoneThe (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. |
symlinks
|
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. |
root_symlinks
|
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_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.
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.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 workspace name as defined in the WORKSPACE file.