टैब

किसी समस्या की शिकायत करें सोर्स देखें 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

एट्रिब्यूट की वैल्यू ऐक्सेस करने के लिए स्ट्रक्चर. वैल्यू, उपयोगकर्ता से मिलती हैं. अगर वैल्यू नहीं दी जाती हैं, तो डिफ़ॉल्ट वैल्यू का इस्तेमाल किया जाता है. स्ट्रक्चर के एट्रिब्यूट और उनकी वैल्यू के टाइप, rule फ़ंक्शन में दिए गए attrs dict की कुंजियों और वैल्यू से मेल खाते हैं. इस्तेमाल का उदाहरण देखें.

bin_dir

root ctx.bin_dir

bin डायरेक्ट्री से जुड़ा रूट.

build_file_path

string ctx.build_file_path

अब काम नहीं करता: ctx.label.package + '/BUILD' का इस्तेमाल करें. सोर्स रूट के हिसाब से, इस नियम के लिए 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

executable=True के तौर पर मार्क की गई लेबल टाइप एट्रिब्यूट में बताई गई, एक्ज़ीक्यूटेबल फ़ाइलों वाला struct. स्ट्रक्चर फ़ील्ड, एट्रिब्यूट के नाम से मेल खाते हैं. स्ट्रक्चर में मौजूद हर वैल्यू, File या None होती है. अगर नियम में किसी वैकल्पिक एट्रिब्यूट की वैल्यू नहीं दी गई है, तो उससे जुड़ी स्ट्रक्चर वैल्यू None होगी. अगर किसी लेबल टाइप को executable=True के तौर पर मार्क नहीं किया गया है, तो उससे जुड़ा कोई स्ट्रक्चर फ़ील्ड जनरेट नहीं होता. इस्तेमाल का उदाहरण देखें.

expand_location

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

यह फ़ंक्शन, $(location //x) को टारगेट //x की आउटपुट फ़ाइल के पाथ से बदलकर, दी गई स्ट्रिंग में मौजूद सभी $(location ...) टेंप्लेट को बड़ा करता है. एक्सपैंशन सिर्फ़ उन लेबल के लिए काम करता है जो इस नियम की डायरेक्ट डिपेंडेंसी पर ले जाते हैं या जिन्हें वैकल्पिक आर्ग्युमेंट targets में साफ़ तौर पर लिस्ट किया गया है. अगर रेफ़रंस वाले टारगेट में एक से ज़्यादा आउटपुट हैं, तो

$(location ...) से गड़बड़ी होगी. इस मामले में, कृपया $(locations ...) का इस्तेमाल करें, क्योंकि इससे आउटपुट पाथ की सूची बनती है, जिसमें स्पेस से अलग किया जाता है. इसका इस्तेमाल, एक आउटपुट फ़ाइल के लिए भी सुरक्षित तरीके से किया जा सकता है.

यह फ़ंक्शन, उपयोगकर्ता को BUILD फ़ाइल में कोई कमांड तय करने में मदद करता है. जैसे, genrule के लिए. अन्य मामलों में, लेबल में सीधे बदलाव करना बेहतर होता है.

पैरामीटर

पैरामीटर ब्यौरा
input string; ज़रूरी है
जिस स्ट्रिंग को बड़ा करना है.
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
            
            
                          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.



        
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, empty list) of the list of resolved inputs and the argv list for the resolved command both 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). The empty list is returned as the third member of the tuple for backwards compatibility.

          
      
Parameters

      

        
          
          
        
        
          

            Parameter
            Description
          

        
        
                  

            
              command
            
            
                          string;
                                     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
            
            
                          bool;
                                     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
            
            
                          dict;
                                     default is {}

                          Dictionary of resolved labels and the corresponding list of Files (a dict of Label : list of Files).
            		
          

                  

            
              execution_requirements
            
            
                          dict;
                                     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, empty list) of the depset of resolved inputs required to run the tools, suitable for passing as the same-named argument of the ctx.actions.run and ctx.actions.run_shell methods. 

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. The empty list is returned as part of the tuple for backward compatibility.

          
      
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
            
            
                          bool;
                                     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
            
            
                          bool;
                                     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
            
            
                          ConstraintValueInfo;
                                     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.