มีสิทธิ์

ออบเจ็กต์บริบทที่ส่งไปยังฟังก์ชันการใช้งานสำหรับกฎหรือองค์ประกอบ เป็นช่องทางให้เข้าถึงข้อมูลและวิธีการที่จำเป็นในการวิเคราะห์เป้าหมายในปัจจุบัน

โดยเฉพาะอย่างยิ่ง ช่วยให้ฟังก์ชันการใช้งานเข้าถึงป้ายกำกับ แอตทริบิวต์ การกำหนดค่า และผู้ให้บริการทรัพยากร Dependency ของเป้าหมายปัจจุบัน โดยมีวิธีการประกาศไฟล์เอาต์พุตและการดำเนินการที่สร้างไฟล์เหล่านั้น

ออบเจ็กต์บริบทจะทำงานตลอดช่วงเวลาที่เรียกใช้ฟังก์ชันการใช้งาน การเข้าถึงออบเจ็กต์เหล่านี้นอกฟังก์ชันที่เกี่ยวข้องจะไม่มีประโยชน์ ดูข้อมูลเพิ่มเติมในหน้ากฎ

สมาชิก

การดำเนินการ

actions ctx.actions

มีวิธีการประกาศไฟล์เอาต์พุตและการดำเนินการที่ทำให้เกิดไฟล์เหล่านั้น

aspect_ids

list ctx.aspect_ids

รายการรหัสสำหรับทุกด้านที่ใช้กับเป้าหมาย ใช้ได้เฉพาะในฟังก์ชันการใช้งานด้านต่างๆ เท่านั้น

Attr

struct ctx.attr

โครงสร้างสำหรับเข้าถึงค่าของแอตทริบิวต์ ค่านี้มาจากผู้ใช้ (หากไม่มี ระบบจะใช้ค่าเริ่มต้น) แอตทริบิวต์ของโครงสร้างและประเภทค่าจะสอดคล้องกับคีย์และค่าของ attrs dict ที่ระบุไว้กับฟังก์ชัน rule ดูตัวอย่างการใช้งาน

bin_dir

root ctx.bin_dir

รูทที่ตรงกับไดเรกทอรี bin

build_file_path

string ctx.build_file_path

เส้นทางไปยังไฟล์ BUILD สำหรับกฎนี้ ซึ่งสัมพันธ์กับรูทต้นทาง

build_setting_value

unknown ctx.build_setting_value

ทดลอง ฟิลด์นี้อยู่ในขั้นทดลองและอาจมีการเปลี่ยนแปลงได้ตลอดเวลา อย่าพึ่งพาสิ่งนี้

ค่าของการตั้งค่าบิลด์ที่แสดงในเป้าหมายปัจจุบัน เกิดข้อผิดพลาดในการเข้าถึงช่องนี้สําหรับกฎที่ไม่ได้ตั้งค่าแอตทริบิวต์ build_setting ในคําจํากัดความของกฎ

การกำหนดค่า

configuration ctx.configuration

การกำหนดค่าเริ่มต้น โปรดดูรายละเอียดเพิ่มเติมในประเภทการกำหนดค่า

coverage_instrumented

bool ctx.coverage_instrumented(target=None)

ส่งคืนว่าควรสร้างการวัดคุมการครอบคลุมของโค้ดเมื่อทำการคอมไพล์สำหรับกฎนี้หรือไม่ หรือหากมี target กฎที่ระบุโดยเป้าหมายนั้น (หากมีการระบุ "เป้าหมาย" ของกฎที่ไม่มีกฎหรือ Starlark ไว้ ค่านี้จะส่งคืนเป็น "เท็จ") ตรวจสอบว่าแหล่งที่มาของกฎปัจจุบัน (หากไม่ได้ระบุเป้าหมาย) หรือควรใช้แหล่งที่มาของเป้าหมายตามการตั้งค่าการกำหนดค่า --instrumentation_filter และ --instrument_test_targets ซึ่งจะแตกต่างจาก coverage_enabled ในการกําหนดค่า ซึ่งจะระบุว่ามีการเปิดใช้การรวบรวมข้อมูลการครอบคลุมสำหรับทั้งการเรียกใช้หรือไม่ แต่ไม่ได้ระบุว่าควรใช้เป้าหมายที่เจาะจงหรือไม่

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
target Target; or None; default = ไม่มี
เป้าหมายที่ระบุกฎ หากไม่ระบุ ระบบจะใช้กฎปัจจุบันเป็นค่าเริ่มต้น

created_actions

StarlarkValue ctx.created_actions()

สำหรับกฎที่มีการตั้งค่า _skylark_testable เป็น True จะแสดงผู้ให้บริการ Actions ที่เป็นตัวแทนการดำเนินการทั้งหมดที่สร้างขึ้นจนถึงปัจจุบันสำหรับกฎปัจจุบัน สำหรับกฎอื่นๆ ทั้งหมด ระบบจะแสดงผล None โปรดทราบว่าผู้ให้บริการจะไม่อัปเดตเมื่อมีการสร้างการดำเนินการที่ตามมา ดังนั้นคุณจะต้องเรียกใช้ฟังก์ชันนี้อีกครั้งหากต้องการตรวจสอบ

มีจุดประสงค์เพื่อช่วยเขียนการทดสอบสำหรับฟังก์ชันตัวช่วยในการใช้กฎ ซึ่งอาจดำเนินการในออบเจ็กต์ ctx และสร้างการดำเนินการในออบเจ็กต์ดังกล่าว

default_provider

Provider ctx.default_provider

เลิกใช้งานแล้ว ใช้ DefaultInfo แทน

disabled_features

list ctx.disabled_features

ชุดของฟีเจอร์ที่ผู้ใช้ปิดใช้อย่างชัดแจ้งสำหรับกฎนี้

exec_groups

ExecGroupCollection ctx.exec_groups

คอลเล็กชันของกลุ่มการดำเนินการที่ใช้ได้กับกฎนี้ โดยจัดทำดัชนีตามชื่อ เข้าถึงด้วย ctx.exec_groups[name_of_group]

ไฟล์ปฏิบัติการ

struct ctx.executable

struct มีไฟล์ปฏิบัติการที่กำหนดไว้ในแอตทริบิวต์ประเภทป้ายกำกับเป็น executable=True ช่องโครงสร้างสัมพันธ์กับชื่อแอตทริบิวต์ แต่ละค่าในโครงสร้างจะเป็น File หรือ None ก็ได้ หากไม่ได้ระบุแอตทริบิวต์ที่ไม่บังคับในกฎ ค่า Struct ที่เกี่ยวข้องจะเป็น None หากไม่ได้ทำเครื่องหมายประเภทป้ายกำกับเป็น executable=True จะไม่มีการสร้างช่อง Struct ที่สอดคล้องกัน ดูตัวอย่างการใช้งาน

expand_location

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

ขยายเทมเพลต $(location ...) ทั้งหมดในสตริงที่ระบุโดยแทนที่ $(location //x) ด้วยเส้นทางของไฟล์เอาต์พุตที่เป็น //x เป้าหมาย การขยายจะใช้ได้กับป้ายกำกับที่ชี้ไปยังทรัพยากร Dependency โดยตรงของกฎนี้ หรือที่ระบุไว้อย่างชัดเจนในอาร์กิวเมนต์ที่ไม่บังคับ targets

$(location ...) จะทำให้เกิดข้อผิดพลาดหากเป้าหมายที่อ้างอิงมีหลายเอาต์พุต ในกรณีนี้ โปรดใช้ $(locations ...) เนื่องจากมีการสร้างรายการเส้นทางเอาต์พุตที่คั่นด้วยช่องว่าง และยังใช้กับไฟล์เอาต์พุตไฟล์เดียวได้อย่างปลอดภัยด้วย

ฟังก์ชันนี้มีประโยชน์ในการให้ผู้ใช้ระบุคำสั่งในไฟล์ BUILD (เช่น สำหรับ genrule) ในกรณีอื่นๆ การจัดการป้ายกำกับโดยตรงมักจะดีกว่า

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
input ต้องระบุ
สตริงที่จะขยาย
targets sequence of Targets; ค่าเริ่มต้น = []
รายการเป้าหมายสำหรับข้อมูลการค้นหาเพิ่มเติม
short_paths ค่าเริ่มต้น = เท็จ
ใช้เส้นทางที่เกี่ยวข้องระดับรูทแทนเส้นทางการดำเนินการแบบเต็ม
อาจส่งคืน None

expand_make_variables

string ctx.expand_make_variables(attribute_name, command, additional_substitutions)

เลิกใช้งานแล้ว ใช้ ctx.var เพื่อเข้าถึงตัวแปรแทน
แสดงผลสตริงหลังจากขยายการอ้างอิงทั้งหมดไปที่ "สร้างตัวแปร" ตัวแปรต้องอยู่ในรูปแบบต่อไปนี้: $(VAR_NAME) และ$$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 workspace name as defined in the WORKSPACE file.