มีสิทธิ์

actions ctx.actions

list ctx.aspect_ids

struct ctx.attr

root ctx.bin_dir

string ctx.build_file_path

unknown ctx.build_setting_value

configuration ctx.configuration

bool ctx.coverage_instrumented(target=None)

StarlarkValue ctx.created_actions()

list ctx.disabled_features

ExecGroupCollection ctx.exec_groups

struct ctx.executable

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

string ctx.expand_make_variables(attribute_name, command, additional_substitutions)

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
            
            

                          string;
                                     required

                          The attribute name. Used for error reporting.
            
          
                  

            

              command
            
            

                          string;
                                     required

                          The expression to expand. It can contain references to "Make variables".
            
          
                  

            

              additional_substitutions
            
            

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

        
package_relative_label
        
Label ctx.package_relative_label(input)


    Converts the input string into a Label object, in the context of the package of the target currently being analyzed. If the input is already a Label, it is returned unchanged.
The result of this function is the same Label value as would be produced by passing the given string to a label-valued attribute of the rule and accessing the corresponding Label() คือ Label() ใช้บริบทของแพ็กเกจไฟล์ .bzl ที่เรียกใช้ ไม่ใช่แพ็กเกจของเป้าหมายที่กำลังวิเคราะห์อยู่ ฟังก์ชันนี้มีลักษณะการทำงานเหมือนกับ 
native.package_relative_label() ซึ่งใช้ในกฎหรือฟังก์ชันการติดตั้งใช้งานแง่มุมไม่ได้

                  
      
พารามิเตอร์
      

        
          
          
        
        

          

            
พารามิเตอร์
            
คำอธิบาย
          
        
        

                  

            

              input
            
            

                          สตริงหรือป้ายกำกับ
                                     ต้องระบุ

                          สตริงป้ายกำกับอินพุตหรือออบเจ็กต์ป้ายกำกับ หากมีการส่งออบเจ็กต์ป้ายกำกับ ระบบจะแสดงผลออบเจ็กต์ดังกล่าวตามที่ส่ง
            
          
                
      

        
resolve_command
        
tuple ctx.resolve_command(*, command='', attribute=None, expand_locations=False, make_variables=None, tools=[], label_dict={}, execution_requirements={})


    (ทดลอง) แสดงผลทูเพิล (inputs, command, empty list) ของรายการอินพุตที่แก้ไขแล้วและรายการ argv สำหรับคำสั่งที่แก้ไขแล้ว ซึ่งทั้ง 2 รายการเหมาะสำหรับการส่งเป็นอาร์กิวเมนต์ที่มีชื่อเดียวกันของเมธอด ctx.action
หมายเหตุสำหรับผู้ใช้ Windows: เมธอดนี้ต้องใช้ Bash (MSYS2) ลองใช้ resolve_tools() แทน (หากตรงกับความต้องการของคุณ) ระบบจะแสดงรายการที่ว่างเปล่าเป็นสมาชิกที่ 3 ของ Tuple เพื่อให้เข้ากันได้แบบย้อนหลัง
                  
      
พารามิเตอร์
      

        
          
          
        
        

          

            
พารามิเตอร์
            
คำอธิบาย
          
        
        

                  

            

              command
            
            

                          string
                                     ค่าเริ่มต้นคือ ''

                          คำสั่งในการแก้ไข
            
          
                  

            

              attribute
            
            

                          สตริง หรือ None;
                                     ค่าเริ่มต้นคือ None

                          ชื่อของแอตทริบิวต์ที่เชื่อมโยงซึ่งจะออกข้อผิดพลาด หรือ None
            
          
                  

            

              expand_locations
            
            

                          bool;
                                     ค่าเริ่มต้นคือ False

                          เราควรขยายตัวแปร $(location) ไหม ดูรายละเอียดเพิ่มเติมได้ที่ ctx.expand_location()
            
          
                  

            

              make_variables
            
            

                          dict หรือ None;
                                     ค่าเริ่มต้นคือ None

                          สร้างตัวแปรเพื่อขยาย หรือ None
            
          
                  

            

              tools
            
            

                          ลำดับของเป้าหมาย
                                     ค่าเริ่มต้นคือ []

                          รายการเครื่องมือ (รายการเป้าหมาย)
            
          
                  

            

              label_dict
            
            

                          dict;
                                     ค่าเริ่มต้นคือ {}

                          พจนานุกรมของป้ายกำกับที่แก้ไขแล้วและรายการไฟล์ที่เกี่ยวข้อง (พจนานุกรมของป้ายกำกับ : รายการไฟล์)
            
          
                  

            

              execution_requirements
            
            

                          dict;
                                     ค่าเริ่มต้นคือ {}

                          ข้อมูลสำหรับการกำหนดเวลาการดำเนินการเพื่อแก้ไขคำสั่งนี้ ดูคีย์ที่มีประโยชน์ได้ในแท็ก
            
          
                
      

        
resolve_tools
        
tuple ctx.resolve_tools(*, tools=[])


    แสดงผลทูเพิล (inputs, empty list) ของ Depset ของอินพุตที่แก้ไขแล้วซึ่งจำเป็นต่อการเรียกใช้เครื่องมือ เหมาะสำหรับการส่งเป็นอาร์กิวเมนต์ที่มีชื่อเดียวกันของเมธอด ctx.actions.run และ ctx.actions.run_shell 

วิธีนี้ไม่จำเป็นต้องติดตั้ง Bash ในเครื่อง ซึ่งแตกต่างจาก ctx.resolve_command จึงเหมาะสำหรับกฎที่สร้างใน Windows ระบบจะแสดงผลรายการที่ว่างเป็นส่วนหนึ่งของทูเพิลเพื่อความเข้ากันได้แบบย้อนหลัง
                  
      
พารามิเตอร์
      

        
          
          
        
        

          

            
พารามิเตอร์
            
คำอธิบาย
          
        
        

                  

            

              tools
            
            

                          ลำดับของเป้าหมาย
                                     ค่าเริ่มต้นคือ []

                          รายการเครื่องมือ (รายการเป้าหมาย)
            
          
                
      

        
กฎ
        
rule_attributes ctx.rule


    ตัวอธิบายแอตทริบิวต์ของกฎสำหรับกฎที่ใช้แง่มุม ใช้ได้เฉพาะในฟังก์ชันการใช้งาน Aspect

        
runfiles
        
runfiles ctx.runfiles(files=[], transitive_files=None, collect_data=False, collect_default=False, symlinks={}, root_symlinks={})


    สร้างออบเจ็กต์ไฟล์ที่ใช้เรียกใช้
                  
      
พารามิเตอร์
      

        
          
          
        
        

          

            
พารามิเตอร์
            
คำอธิบาย
          
        
        

                  

            

              files
            
            

                          ลำดับของไฟล์
                                     ค่าเริ่มต้นคือ []

                          รายการไฟล์ที่จะเพิ่มลงในไฟล์ที่ใช้ในการเรียกใช้
            
          
                  

            

              transitive_files
            
            

                          depset ของ File หรือ None
                                     ค่าเริ่มต้นคือ None

                          ชุดไฟล์ (แบบทรานซิทีฟ) ที่จะเพิ่มลงใน runfiles Depset ควรใช้ลำดับ default (ซึ่งเป็นค่าเริ่มต้นตามชื่อ)
            
          
                  

            

              collect_data
            
            

                          bool;
                                     ค่าเริ่มต้นคือ False

                          ไม่แนะนำให้ใช้พารามิเตอร์นี้ ดูคู่มือไฟล์รันไทม์ 
กำหนดว่าจะรวบรวมไฟล์ที่เรียกใช้ข้อมูลจากทรัพยากร Dependency ในแอตทริบิวต์ srcs, data และ deps หรือไม่
            
          
                  

            

              collect_default
            
            

                          bool;
                                     ค่าเริ่มต้นคือ False

                          ไม่แนะนำให้ใช้พารามิเตอร์นี้ ดูคู่มือไฟล์รันไทม์ 
จะรวบรวมไฟล์ที่เรียกใช้เริ่มต้นจากทรัพยากร Dependency ในแอตทริบิวต์ srcs, data และ deps หรือไม่
            
          
                  

            

              symlinks
            
            

                          dict หรือ depset ของ SymlinkEntrys
                                     ค่าเริ่มต้นคือ {}

                          ทั้ง depset ของ SymlinkEntry หรือแผนที่ของ Symlink ที่จะเพิ่มลงในไฟล์ที่เรียกใช้ ระบบจะเพิ่ม Symlink ไว้ใต้ไดเรกทอรี Runfiles ของพื้นที่ทำงานหลักเสมอ (เช่น <runfiles_root>/_main/<symlink_path>) ไม่ใช่ไดเรกทอรีที่สอดคล้องกับที่เก็บของเป้าหมายปัจจุบัน ดูลิงก์สัญลักษณ์ของไฟล์ที่รันในคู่มือกฎ
            
          
                  

            

              root_symlinks
            
            

                          dict หรือ depset ของ SymlinkEntry
                                     ค่าเริ่มต้นคือ {}

                          ทั้ง depset ของ SymlinkEntry หรือแผนที่ของ Symlink ที่จะเพิ่มลงในไฟล์ที่เรียกใช้ ดูลิงก์สัญลักษณ์ของไฟล์ที่รันในคู่มือกฎ
            
          
                
      

        
split_attr
        
struct ctx.split_attr


    โครงสร้างเพื่อเข้าถึงค่าของแอตทริบิวต์ที่มีการกำหนดค่าแบบแยก หากแอตทริบิวต์เป็นรายการป้ายกำกับ ค่าของ split_attr จะเป็นพจนานุกรมของคีย์ของการแยก (เป็นสตริง) ไปยังรายการ ConfiguredTargets ในกิ่งของการแยกนั้น หากแอตทริบิวต์เป็นป้ายกำกับ ค่าของ split_attr จะเป็นพจนานุกรมของคีย์ของการแยก (เป็นสตริง) ไปยัง ConfiguredTarget เดียว แอตทริบิวต์ที่มีการกำหนดค่าแบบแยกจะยังคงปรากฏในโครงสร้างแอตทริบิวต์ แต่ค่าจะเป็นรายการเดียวที่มีการผสานสาขาทั้งหมดของการแยกเข้าด้วยกัน

        
super
        
unknown ctx.super()


    ทดลอง: เรียกใช้ฟังก์ชันการติดตั้งใช้งานของผู้ปกครองและแสดงผลผู้ให้บริการ

        
target_platform_has_constraint
        
bool ctx.target_platform_has_constraint(constraintValue)


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

        
          
          
        
        

          

            
พารามิเตอร์
            
คำอธิบาย
          
        
        

                  

            

              constraintValue
            
            

                          ConstraintValueInfo;
                                     required

                          ค่าข้อจํากัดที่จะตรวจสอบแพลตฟอร์มเป้าหมาย
            
          
                
      

        
Toolchain
        
ToolchainContext ctx.toolchains


    Toolchain สำหรับกลุ่มการดำเนินการเริ่มต้นของกฎนี้

        
var
        
dict ctx.var


    พจนานุกรม (สตริงเป็นสตริง) ของตัวแปรการกำหนดค่า

        
version_file
        
File ctx.version_file


    ไฟล์ที่ใช้เก็บสถานะพื้นที่ทำงานที่ไม่คงที่สำหรับคำขอสร้างปัจจุบัน ดูข้อมูลเพิ่มเติมได้ที่เอกสารประกอบสำหรับ --workspace_status_command

        
workspace_name
        
string ctx.workspace_name


    ชื่อของพื้นที่ทำงาน ซึ่งเป็นชื่อรูทการดำเนินการและคำนำหน้าไฟล์ที่เรียกใช้สำหรับที่เก็บหลัก หาก --enable_bzlmod เปิดอยู่ สตริงที่แก้ไขแล้วจะเป็น _main มิฉะนั้น นี่คือชื่อพื้นที่ทำงานตามที่กำหนดไว้ในไฟล์ WORKSPACE