سيتم إطلاق BazelCon لعام 2022 في الفترة من 16 إلى 17 تشرين الثاني (نوفمبر) في نيويورك وعلى الإنترنت. التسجيل اليوم
جديد: انضم إلينا في يوم المنتدى في 15 تشرين الثاني (نوفمبر). التفاصيل والتسجيل:

سريعة

تنظيم صفحاتك في مجموعات يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
كائن سياق يتم تمريره إلى دالة التنفيذ لقاعدة أو جانب. يوفّر هذا التقرير إمكانية الوصول إلى المعلومات والأساليب اللازمة لتحليل الاستهداف الحالي.

وعلى وجه الخصوص، تسمح دالة التنفيذ بالوصول إلى التصنيف والسمات والضبط ومقدّمي الخدمات التابعة لها الحالية. ويحتوي هذا التقرير على طرق للإعلان عن ملفات الإخراج والإجراءات التي تنتجها.

تعمل كائنات السياق بشكلٍ أساسي طوال مدة الطلب إلى دالة التنفيذ. من غير المفيد الوصول إلى هذه العناصر خارج الدالة المرتبطة بها. يمكنك الاطّلاع على صفحة القواعد للحصول على المزيد من المعلومات.

المشتركون الداعمون

الإجراءات

actions ctx.actions

تحتوي على طرق للإعلان عن ملفات الإخراج والإجراءات التي تنتجها.

معرّفات_ الجانب

list ctx.aspect_ids

قائمة بمعرّفات جميع الجوانب التي تم تطبيقها على الهدف. لا تتوفّر هذه الميزة إلا في وظائف تنفيذ العرض.

سمة

struct ctx.attr

بنية للوصول إلى قيم السمات. يقدّم المستخدم القيم (وفي حال عدم ظهورها، يتم استخدام قيمة تلقائية). تتوافق سمات البنية وأنواع قيمتها مع المفاتيح والقيم في الإملاء attrs المقدَّمة إلى الدالة rule. راجع مثال الاستخدام.

bin_dir

root ctx.bin_dir

الجذر المقابل لدليل المهملات.

مسار_ملف_الإصدار

string ctx.build_file_path

مسار ملف BUILD لهذه القاعدة بالنسبة إلى الجذر المصدر.

إعداد_قيمة_الإعداد

unknown ctx.build_setting_value

تجريبية. هذا الحقل تجريبي وخاضع للتغيير في أي وقت. لا تعتمد على ذلك.

قيمة إعداد الإصدار الذي يتم تمثيله من خلال الهدف الحالي. حدث خطأ أثناء الوصول إلى هذا الحقل للقواعد التي لا تضبط السمة build_setting في تعريف القاعدة.

الإعدادات

configuration ctx.configuration

الإعداد التلقائي. لمزيد من التفاصيل، يمكنك الاطّلاع على النوع الضبط.

التغطية_المخصّصة

bool ctx.coverage_instrumented(target=None)

يعرض ما إذا كان يجب إنشاء أداة تغطية الرمز عند تنفيذ إجراءات التجميع لهذه القاعدة أو عند تقديم target، القاعدة المحدّدة في ذلك الهدف. (في حال تقديم قاعدة لا تستند إلى قاعدة أو قاعدة نجمية، تعرض هذه القيمة "خطأ"). للتحقق من أن مصادر القاعدة الحالية (إذا لم يتم تقديم أي هدف) أو مصادر القيمة المستهدفة، يجب قياسها استنادًا إلى إعدادات الضبط ---deviceation_filter و-tool_test_targets. ويختلف هذا عن coverage_enabled في الضبط، حيث يشير إلى ما إذا كان قد تم تفعيل جمع بيانات التغطية للتشغيل بالكامل، لكن ليس بما إذا كان يجب استخدام هدف محدّد.

المَعلمات

المعلمة الوصف
target Target; or None; default = None
هدف يحدّد قاعدة. وفي حال عدم تقديم هذه القيمة، يتم ضبطها تلقائيًا على القاعدة الحالية.

تلك الإجراءات التي تم إنشاؤها

StarlarkValue ctx.created_actions()

بالنسبة إلى القواعد التي تم ضبط _skylark_testable فيها على True، يؤدي ذلك إلى عرض موفِّر الإجراءات الذي يمثل جميع الإجراءات التي تم إنشاؤها حتى الآن للقاعدة الحالية. بالنسبة إلى جميع القواعد الأخرى، يتم إرجاع None. يُرجى ملاحظة أنه لا يتم تعديل الموفّر عند إنشاء إجراءات لاحقة، لذا عليك استدعاء هذه الدالة مرة أخرى إذا كنت تريد فحصها.

يهدف هذا الإجراء إلى المساعدة في كتابة اختبارات لوظائف المساعد الخاصة بتنفيذ القواعد، ما قد يؤدي إلى استخدام عنصر ctx وإنشاء إجراءات بشأنه.

default_provider

Provider ctx.default_provider

تمّ الإيقاف. استخدم DefaultInfo بدلاً من ذلك.

ميزات_غير مفعّلة

list ctx.disabled_features

مجموعة الميزات التي أوقف المستخدم تفعيلها صراحةً لهذه القاعدة.

مجموعات exec

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)

توسيع كل نماذج $(location ...) في السلسلة المحدّدة عن طريق استبدال $(location //x) بمسار ملف الناتج عن الهدف //x. لا يعمل التوسيع إلا مع التصنيفات التي تشير إلى تبعيات مباشرة لهذه القاعدة أو التي تم إدراجها صراحةً في الوسيطة الاختيارية targets. سيؤدي

$(location ...) إلى حدوث خطأ إذا كان الهدف المُشار إليه يحتوي على مخرجات متعددة. وفي هذه الحالة، يُرجى استخدام السمة $(locations ...) لأنها تنشئ قائمة بمسارات الإخراج المفصولة بمسافات. ويمكن استخدامه بأمان أيضًا لملف إخراج واحد.

من المفيد استخدام هذه الوظيفة للسماح للمستخدم بتحديد أمر في ملف BUILD (مثل genrule). وفي حالات أخرى، غالبًا ما يكون من الأفضل التلاعب بالتصنيفات مباشرةً.

المَعلمات

المعلمة الوصف
input مطلوبة
السلسلة التي سيتم توسيعها
targets sequence of Targets; default = []
قائمة الاستهدافات للحصول على معلومات بحث إضافية.
short_paths default = False
استخدم المسارات النسبية الجذر بدلاً من مسارات التنفيذ الكاملة
يمكن إرجاع None.

الموسّع_المتغيّر

string ctx.expand_make_variables(attribute_name, command, additional_substitutions)

متوقف. استخدِم ctx.var للوصول إلى المتغيّرات بدلاً من ذلك.
عرض سلسلة بعد توسيع جميع المراجع إلى "إنشاء المتغيّرات&quot. يجب أن تكون المتغيرات بالتنسيق التالي: $(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.

host_configuration

configuration ctx.host_configuration

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

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

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 = []
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

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.