หน้านี้ได้รับการแปลโดย Cloud Translation API

มีสิทธิ์

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

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

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

สำหรับสมาชิก

การดำเนินการ
aspect_ids
attr
bin_dir
build_file_path
build_setting_value
การกำหนดค่า
coverage_instrumented
created_actions
disabled_features
exec_groups
ที่ดำเนินการได้
expand_location
expand_make_variables
ฟีเจอร์
ไฟล์
ไฟล์
ส่วนย่อย
genfiles_dir
info_file
ป้ายกำกับ
เอาต์พุต
resolve_command
resolve_tools
กฎ
รันไฟล์
split_attr
super
target_platform_has_constraint
เครื่องมือเชน
var
version_file
workspace_name

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

actions ctx.actions

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

aspect_ids

list ctx.aspect_ids

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

แอตทริบิวต์

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 (เป้าหมาย) หรือ `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 ช่องโครงสร้างสอดคล้องกับชื่อแอตทริบิวต์ แต่ละค่าในโครงสร้างจะเป็น File หรือ None ก็ได้ หากไม่ได้ระบุแอตทริบิวต์ที่ไม่บังคับในกฎ ค่าโครงสร้างที่เกี่ยวข้องจะเป็น None หากไม่ได้ทําเครื่องหมายประเภทป้ายกํากับเป็น executable=True ระบบจะไม่สร้างช่อง Struct ที่เกี่ยวข้อง ดูตัวอย่างการใช้

expand_location

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

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

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

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

พารามิเตอร์

พารามิเตอร์	คำอธิบาย
`input`	ต้องระบุ สตริงที่จะขยาย
`targets`	ลำดับ ของเป้าหมาย โดยค่าเริ่มต้นคือ `[]` รายการเป้าหมายสำหรับข้อมูลการค้นหาเพิ่มเติม

อาจส่งคืน 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.
            
          
                  
            
              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.




  
 ด้วย

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.

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.

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.