มีสิทธิ์

รายงานปัญหา ดูแหล่งที่มา รุ่น Nightly · 7.4 7.3 · 7.2 · 7.1 · 7.0 · 6.5

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

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

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

สมาชิก

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

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 ผลลัพธ์จะเป็น False) ตรวจสอบว่าควรใช้เครื่องมือวัดแหล่งที่มาของกฎปัจจุบัน (หากไม่ได้ระบุเป้าหมาย) หรือแหล่งที่มาของเป้าหมายตามการตั้งค่าการกําหนดค่า --instrumentation_filter และ --instrument_test_targets หรือไม่ ซึ่งแตกต่างจาก coverage_enabled ในการกําหนดค่า ซึ่งจะระบุว่ามีการเปิดใช้การเก็บรวบรวมข้อมูลความครอบคลุมสําหรับการเรียกใช้ทั้งหมดหรือไม่ แต่ไม่ได้ระบุว่าควรติดตั้งใช้งานเป้าหมายที่เฉพาะเจาะจงหรือไม่

พารามิเตอร์

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

created_actions

StarlarkValue ctx.created_actions()

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

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

disabled_features

list ctx.disabled_features

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

exec_groups

ExecGroupCollection ctx.exec_groups

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

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

struct ctx.executable

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

expand_location

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

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

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

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

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
input required
String to be expanded.
targets ลําดับของ Target ค่าเริ่มต้นคือ []
ลิสต์ของเป้าหมายสําหรับข้อมูลเพิ่มเติมในการค้นหา
อาจแสดงผล 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.


        
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.
            

          

                  

            
            
                          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.
            		
          

                  

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