doanh số bán hàng

Báo cáo sự cố Xem nguồn Hằng đêm · 7,3 · 7.2 · 7.1 · 7 · 6,5

Đố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ể, API 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 các phần phụ thuộc của mục tiêu hiện tại. Lớp này có các phương thức để khai báo các 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 suốt thời gian diễn ra lệnh gọi đến hàm triển khai. Việc truy cập các đối tượng này bên ngoài hàm liên kết là không hữu ích. 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

Chứ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_ids

Danh sách mã nhận dạng cho mọi khía cạnh được áp dụng cho mục tiêu. Chỉ có trong các chức năng triển khai khung hình.

attr

struct ctx.attr

Một cấu trúc để truy cập vào các giá trị của các 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ị 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_dir

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, tương ứng với thư mục gốc của nguồn.

build_setting_value

unknown ctx.build_setting_value

Giá trị của chế độ cài đặt bản dựng được thể hiện theo mục tiêu hiện tại. 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ì bạn sẽ thấy lỗi.

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.

coverage_instrumented

bool ctx.coverage_instrumented(target=None)

Trả về việc liệu có cần tạo khả năng đo lường mức độ sử dụng mã khi thực hiện thao tác biên dịch cho quy tắc này hay không, hay quy tắc do Mục tiêu đó chỉ định (nếu có target). (Nếu bạn cung cấp một Mục tiêu không có quy tắc hoặc một Mục tiêu của quy tắc Starlark, kết quả trả về sẽ là 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 phải được đo lường dựa trên chế độ 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, 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.

Tham số

Thông số	Mô tả
target	Mục tiêu; hoặc None; giá trị mặc định là None Mục tiêu chỉ định một quy tắc. Nếu không được cung cấp, quy tắc mặc định sẽ được đặt thành quy tắc hiện tại.

created_actions

StarlarkValue ctx.created_actions()

Đối với các quy tắc có _skylark_testable đặt thành True, kết quả trả về sẽ trả về trình cung cấp Actions đại diện cho tất cả các thao tác đượ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

Tập hợp các tính năng bị người dùng tắt rõ ràng theo quy tắc này.

exec_groups

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

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 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ì mã này tạo ra một 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 khi cho phép người dùng chỉ định 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.

Tham số

Thông số	Mô tả
input	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 cho thông tin tra cứu bổ sung.

Có thể trả về 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ả mụ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.


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


    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 is []

                          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 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


    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.


        
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
            
            

                                     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.