BazelCon 2022, 16 नवंबर से 17 नवंबर तक न्यूयॉर्क में और ऑनलाइन उपलब्ध है.
आज ही रजिस्टर करें!

टैब

संग्रह की मदद से व्यवस्थित रहें अपनी प्राथमिकताओं के आधार पर, कॉन्टेंट को सेव करें और कैटगरी में बांटें.
किसी कॉन्टेक्स्ट ऑब्जेक्ट को लागू करने के लिए, किसी नियम या पहलू को पास किया जाने वाला प्रसंग ऑब्जेक्ट. इससे, आपको मौजूदा टारगेट का विश्लेषण करने के लिए ज़रूरी जानकारी और तरीकों का ऐक्सेस मिलता है.

खास तौर पर, यह लागू करने की सुविधा की मदद से, मौजूदा टारगेट और लेबल के साथ-साथ, कॉन्फ़िगरेशन और डिपेंडेंसी को ऐक्सेस करता है. इसमें आउटपुट फ़ाइलों और उन्हें बनाने वाली कार्रवाइयों का एलान करने के तरीके दिए गए हैं.

कॉन्टेक्स्ट ऑब्जेक्ट, कॉल के दौरान लागू करने के फ़ंक्शन के लिए ज़रूरी होते हैं. इन ऑब्जेक्ट को इनसे जुड़े फ़ंक्शन के बाहर ऐक्सेस करना फ़ायदेमंद नहीं है. ज़्यादा जानकारी के लिए, नियम पेज देखें.

पैसे चुकाकर बने सदस्य

कार्रवाइयां

actions ctx.actions

इसमें आउटपुट फ़ाइलों और उन्हें बनाने वाली कार्रवाइयों का एलान करने के तरीके शामिल हैं.

झटपट_आईडी

list ctx.aspect_ids

टारगेट पर लागू किए गए सभी पहलुओं के लिए सूची आईडी दिखाता है. सिर्फ़ आसपेक्ट इंप्लिमेंटेशन फ़ंक्शन में उपलब्ध.

attr

struct ctx.attr

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

बिन_दीर

root ctx.bin_dir

बिन डायरेक्ट्री से जुड़ा रूट.

build_file_path

string ctx.build_file_path

सोर्स रूट के मुकाबले, इस नियम के लिए BUILD फ़ाइल का पाथ दिखाता है.

build_setting_value

unknown ctx.build_setting_value

प्रयोग के तौर पर. इस फ़ील्ड पर अभी प्रयोग किया जा रहा है और इसे किसी भी समय बदला जा सकता है. इसका इस्तेमाल न करें.

बिल्ड सेटिंग की वैल्यू दिखाता है, जिसे मौजूदा टारगेट के ज़रिए दिखाया जाता है. उन नियमों के लिए इस फ़ील्ड को ऐक्सेस करते समय गड़बड़ी हुई जो नियम की परिभाषा में build_setting एट्रिब्यूट को सेट नहीं करते.

कॉन्फ़िगरेशन

configuration ctx.configuration

डिफ़ॉल्ट कॉन्फ़िगरेशन दिखाता है. ज़्यादा जानकारी के लिए, कॉन्फ़िगरेशन का टाइप देखें.

कवरेज_प्लैटफ़ॉर्म

bool ctx.coverage_instrumented(target=None)

इस नियम के लिए कंपाइलेशन की कार्रवाइयां करते समय कोड कवरेज का इंस्ट्रूमेंटेशन जनरेट होना चाहिए या अगर target दिया गया है, तो उस टारगेट के मुताबिक तय किया गया नियम. (अगर कोई गैर-नियम या स्टारलार्क नियम टारगेट दिया गया है, तो यह गलत दिखाता है.) यह जांचता है कि मौजूदा नियम के सोर्स (अगर कोई टारगेट नहीं दिया गया है) या टारगेट के सोर्स को, इंस्ट्रूमेंटेशन_फ़िल्टर और --console_test_targets कॉन्फ़िगरेशन सेटिंग के आधार पर लागू किया जाना चाहिए या नहीं. यह कॉन्फ़िगरेशन में coverage_enabled से अलग है, जो बताता है कि पूरी परफ़ॉर्मेंस के लिए कवरेज डेटा इकट्ठा करने की सुविधा चालू है या नहीं. हालांकि, यह तय नहीं कर सकते कि किसी खास टारगेट को लागू किया जाना चाहिए या नहीं.

पैरामीटर

पैरामीटर जानकारी
target Target; or None; डिफ़ॉल्ट = कोई नहीं
टारगेट के बारे में बताने वाला नियम. अगर जानकारी नहीं दी गई है, तो डिफ़ॉल्ट रूप से मौजूदा नियम लागू होगा.

बनाई गई_कार्रवाइयां

StarlarkValue ctx.created_actions()

_skylark_testable के साथ True पर सेट किए गए नियमों के लिए, यह मौजूदा नियम के लिए अब तक बनाई गई सभी कार्रवाइयों को दिखाने वाली कार्रवाइयां कंपनी दिखाता है. अन्य सभी नियमों के लिए, None दिखाता है. ध्यान दें कि सेवा देने वाली कंपनी को तब अपडेट नहीं किया जाता, जब बाद में की जाने वाली कार्रवाइयां बनाई जाती हैं. इसलिए, फ़ंक्शन का पता लगाने के लिए आपको इसे फिर से कॉल करना होगा.

इसका मकसद, नियम लागू करने वाले हेल्पर के फ़ंक्शन की जांच लिखना है. इसके लिए, ctx ऑब्जेक्ट का इस्तेमाल किया जा सकता है और उस पर कार्रवाइयां की जा सकती हैं.

डिफ़ॉल्ट_सेवा देने वाली कंपनी

Provider ctx.default_provider

समर्थन नहीं होना या रुकना. इसके बजाय DefaultInfo का इस्तेमाल करें.

अक्षम की गई सुविधाएं

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 के तौर पर मार्क नहीं किया जाता है, तो उससे जुड़ा कोई स्ट्रक्चर्ड फ़ील्ड जनरेट नहीं होता. इस्तेमाल का उदाहरण देखें.

विस्तार_स्थान

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

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

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

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

पैरामीटर

पैरामीटर जानकारी
input ज़रूरी है
स्ट्रिंग को बड़ा करना है.
targets sequence of Targets; डिफ़ॉल्ट = []
लुकअप की अन्य जानकारी के लिए, टारगेट की सूची.
short_paths डिफ़ॉल्ट = गलत
पूरे एक्ज़ीक्यूटिव पाथ के बजाय रूट रिलेटिव पाथ का इस्तेमाल करें
None को वापस किया जा सकता है.

एक्सपैंशन_मेक_वैरिएबल

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

Returns 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

Returns 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

Returns 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

Returns rule attributes descriptor for the rule that 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

Returns 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

Returns the workspace name as defined in the WORKSPACE file.