doanh số bán hàng

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. Nó cung cấp quyền truy cập vào thông tin và các phương pháp cần thiết để phân tích mục tiêu hiện tại.

Cụ thể, nó 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ủa các phần phụ thuộc của mục tiêu hiện tại. Nó 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 đó.

Về cơ bản, các đối tượng bối cảnh sẽ tồn tại trong suốt thời gian gọi đến 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 được 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

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 tệp đó.

aspect_ids

list ctx.aspect_ids

Danh 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.attr

Một cấu trúc để truy cập vào các giá trị của thuộc tính. Người dùng cung cấp các giá trị (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à các loại giá trị của chúng tương ứng với các khoá và giá trị của từ điển attrs đượ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.

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.

build_setting_value

unknown ctx.build_setting_value

Thử 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 nó.

Giá trị của chế độ cài đặt bản dựng do mục tiêu hiện tại đại diện. Bạn sẽ gặp lỗi khi truy cập vào trường này đối với những 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.configuration

Cấu hình mặc định. Hãy xem loại cấu hình để biết thêm thông tin chi tiết.

coverage_instrumented

bool ctx.coverage_instrumented(target=None)

Trả về liệu có nên tạo tính năng đo lường mức độ phù hợp của mã khi thực hiện các thao tác 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 Target đó chỉ định. (Nếu bạn cung cấp một Target 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ác nguồn của quy tắc hiện tại (nếu không có Target nào được cung cấp) hoặc các nguồn của Target có nên được đo lường hay khô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. Cấu hình này ghi chú liệu tính năng thu thập dữ liệu về mức độ phù hợp có được bật cho toàn bộ quá trình chạy hay không, nhưng không ghi chú liệu một mục tiêu cụ thể có được đo lường hay không.

Thông số

Tham số Mô tả
target Target; or None; default = None
Một Target chỉ định một quy tắc. Nếu bạn không cung cấp, hệ thống sẽ mặc định sử dụng 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 (Hành động) đại diện cho tất cả các hành động đã được tạo cho đến nay cho quy tắc hiện tại. Đối với tất cả các quy tắc khác, hàm này sẽ trả về None. Xin lưu ý rằng 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 các thao tác đó.

Mục đích của việc này là giúp viết các bài 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 các thao tác trên đối tượng đó.

default_provider

Provider ctx.default_provider

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

disabled_features

list ctx.disabled_features

Tậ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_groups

Một 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. Truy cập bằng ctx.exec_groups[name_of_group].

tệp thực thi

struct ctx.executable

Một 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 một 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 một loại nhãn không được đánh dấu là executable=True, thì 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ả 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. Hoạt động mở rộng chỉ áp dụng cho những 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ì lệnh 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 duy nhất.

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 (chẳng hạn như đối với genrule). Trong các trường hợp khác, thường thì bạn nên thao tác trực tiếp với nhãn.

Thông số

Tham số Mô tả
input required
Chuỗi cần mở rộng.
targets sequence of Targets; default = []
Danh sách các mục tiêu để biết thêm thông tin tra cứu.
short_paths default = False
Sử dụng đường dẫn tương đối của thư mục gốc thay vì đường dẫn thực thi đầy đủ
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 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 thông tin 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


    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.


        
host_configuration

        
configuration ctx.host_configuration


    The host configuration. See the configuration type for more details.


        
host_fragments

        
fragments ctx.host_fragments


    Allows access to configuration fragments in host configuration.


        
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.
            

          

                  

            
            
                          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.
            		
          

                  

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