Để xem tài liệu về bản phát hành ổn định, vui lòng sử dụng trình đơn thả xuống "Tài liệu được tạo phiên bản". Chế độ xem mặc định phản ánh phiên bản mới nhất ở HEAD.

Trang này được dịch bởi Cloud Translation API.

doanh số bán hàng

Báo cáo vấn đề Xem nguồn

Đối tượng ngữ cảnh được chuyển vào hàm triển khai cho một quy tắc hoặc khía cạnh. Nó cung 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 biệt, hàm 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à nhà cung cấp phần phụ thuộc của mục tiêu hiện tại. Tệp này có các phương thức để khai báo tệp đầu ra và hành động tạo ra các tệp đó.

Về cơ bản, các đối tượng ngữ cảnh tồn tại trong thời gian diễn ra lệnh gọi đến hàm triển khai. Không hữu ích khi truy cập vào các đối tượng này bên ngoài chức năng liên quan. Hãy xem trang Quy tắc để biết thêm thông tin.

Thành viên

hành động
aspect_ids
attr
bin_dir
build_file_path
giá_trị_cài_đặt_xây_dựng
cấu hình
coverage_instrumented
generated_actions
default_provider
disabled_features
exec_groups
thực thi
expand_location
expand_make_variables
tính năng
file
tệp
mảnh
genfiles_dir
info_file
nhãn
new_file
kết quả
resolve_command
resolve_tools
quy tắc
runfiles
Split_attr
target_platform_has_constraint
chuỗi công cụ
khác
version_file
workspace_name

thao tác

actions ctx.actions

Chứa các phương thức khai báo tệp đầu ra và thao tác tạo ra các tệp đó.

tỷ lệ co

list ctx.aspect_ids

Danh sách id cho tất cả các khía cạnh áp dụng cho mục tiêu. Chỉ có trong các hàm triển khai khía cạnh.

thuộc tính

struct ctx.attr

Một cấ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, 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 lệnh được cung cấp cho hàm rule. Xem ví dụ về cách sử dụng.

bin_dir

root ctx.bin_dir

Thư mục gốc tương ứng với thư mục bin.

đường_dẫn_tệp

string ctx.build_file_path

Đường dẫn đến tệp BUILD cho quy tắc này, liên quan đến thư mục nguồn.

giá trị cài đặt của bản dựng

unknown ctx.build_setting_value

Thử nghiệm. Trường này là thử nghiệm và có thể thay đổi bất kỳ lúc nào. Đừng phụ thuộc vào dữ liệu đó.

Giá trị của chế độ cài đặt bản dựng được thể hiện bằng mục tiêu hiện tại. Đã xảy ra lỗi khi truy cập trường này cho các quy tắc không đặt thuộc tính build_setting trong định nghĩa quy tắc của chúng.

cấu hình

configuration ctx.configuration

Cấu hình mặc định. Xem loại cấu hình để biết thêm chi tiết.

được_cung_cấp

bool ctx.coverage_instrumented(target=None)

Trả về thông tin liệu công cụ đo lường mức độ sử dụng mã có nên được tạo khi thực hiện thao tác biên dịch cho quy tắc này hay không, hoặc nếu bạn cung cấp target, thì quy tắc này sẽ được chỉ định trong Mục tiêu. (Nếu bạn cung cấp một quy tắc không phải quy tắc hoặc Mục tiêu Starlark thì kết quả sẽ là Sai). 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) hay các nguồn Mục tiêu phải được đo lường dựa trên cài đặt cấu hình --instrumentation_filter và --instrument_test_targets. Điều này khác với coverage_enabled trong cấu hình, cho biết liệu tính năng thu thập dữ liệu mức độ phù hợp có được bật cho toàn bộ lần chạy hay không, nhưng không biết liệu có nên đo lường mục tiêu cụ thể hay không.

Các tham số

Thông số	Nội dung mô tả
`target`	`Target; or None`; default = None 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ẽ áp dụng quy tắc hiện tại.

hành_động_đã tạo

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 nhà cung cấp Actions đại diện cho tất cả hành động đã tạo cho đến nay đối với quy tắc hiện tại. Đối với tất cả các quy tắc khác, hãy trả về None. 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 chúng.

Mục đích của phần này là 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 một đối tượng ctx và tạo hành động cho đối tượng đó.

nhà_cung_cấp_mặc_định

Provider ctx.default_provider

Không dùng nữa. Thay vào đó, hãy sử dụng DefaultInfo.

tính_năng_tắt

list ctx.disabled_features

Bộ tính năng bị người dùng tắt một cách rõ ràng theo quy tắc này.

nhóm_thực_tế

ExecGroupCollection ctx.exec_groups

Tậ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 chúng. Truy cập bằng ctx.exec_groups[name_of_group].

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à một 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 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.

mở rộng_vị trí

string ctx.expand_location(input, targets=[])

Mở rộng tất cả cá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 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ố targets không bắt buộc.

$(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ì thuộc tính này tạo 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ể dùng tính năng này cho một tệp đầu ra.

Hàm này 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.

Các tham số

Thông số	Nội dung mô tả
`input`	bắt buộc Chuỗi cần mở rộng.
`targets`	`sequence of Targets`; default = [] Danh sách các mục tiêu cho thông tin tra cứu bổ sung.

Có thể trả lại hàng vào None.

mở rộng_biến_tạo_biến

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 "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.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.
`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_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.