BazelCon 2022 מגיע בין 16 ל-17 בנובמבר לניו יורק באינטרנט. הירשמו עוד היום!
חדש: אנחנו מזמינים אותך להצטרף אלינו ליום הקהילה ב-15 בנובמבר! פרטים ורישום.

TAG

קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
אובייקט הקשר שמועבר לפונקציית ההטמעה של כלל או היבט. היא מספקת גישה למידע ולשיטות שנדרשות כדי לנתח את היעד הנוכחי.

באופן ספציפי, היא מאפשרת לפונקציית ההטמעה לגשת לתווית, למאפיינים, לתצורה ולספקים התלויים של היעד הנוכחי. יש בו שיטות להצהרה על קובצי פלט והפעולות שמניבות אותם.

למעשה, אובייקטים של הקשר פעילים במהלך הקריאה לפונקציית ההטמעה. לא כדאי לגשת לאובייקטים מחוץ לפונקציה המשויכת אליהם. מידע נוסף זמין בדף הכללים

חברי מועדון

פעולות

actions ctx.actions

כולל שיטות להצהרה על קובצי פלט ועל הפעולות שמניבות אותם.

id_ids

list ctx.aspect_ids

רשימת מזהים של כל ההיבטים שהוחלו על היעד. זמין רק בפונקציות של הטמעת היבטים.

מאפיין

struct ctx.attr

שיטה שמאפשרת לגשת לערכים של המאפיינים. הערכים נקבעים על ידי המשתמש (אם לא, נעשה שימוש בערך ברירת מחדל). המאפיינים של המבנה ושל סוגי הערכים שלהם תואמים למפתחות ולערכים של הסקריפט attrs המסופקים לפונקציה rule. דוגמה לשימוש.

bin_dir

root ctx.bin_dir

הרמה הבסיסית (root) של ספריית bin.

build_file_path

string ctx.build_file_path

הנתיב לקובץ BUILD עבור הכלל הזה, ביחס לשורש המקור.

build_setting_value

unknown ctx.build_setting_value

ניסיוני. השדה הזה ניסיוני ועשוי להשתנות בכל עת. אין להסתמך על כך.

הערך של הגדרת ה-build שמיוצג על ידי היעד הנוכחי. שגיאה בגישה לשדה הזה עבור כללים שלא מגדירים את המאפיין build_setting בהגדרת הכלל שלהם.

הגדרות אישיות

configuration ctx.configuration

הגדרת ברירת המחדל. לפרטים נוספים, ראו סוג תצורה.

כיסוי_אינסטרומנטלי

bool ctx.coverage_instrumented(target=None)

מחזירה אם יש ליצור מכשור כיסוי של קוד במהלך ביצוע פעולות הידור עבור הכלל הזה, או אם הכלל שסופק, target. (אם סופק יעד שאינו כלל או כלל של Starlark, הפונקציה תחזיר False). בודקת אם המקורות של הכלל הנוכחי (אם לא סופקו יעד) או שצריך להוסיף את המקורות של היעד על סמך הגדרות התצורה של --instrumentation_filter ו- --instrument_test_targets. נתון זה שונה מהמאפיין coverage_enabled בהגדרה, שבה מצוין אם איסוף נתוני הכיסוי מופעל לכל אורך הקמפיין, אך לא אם צריך להוסיף יעד ספציפי.

פרמטרים

פרמטר תיאור
target Target; or None; ברירת מחדל = ללא
יעד המציין כלל. אם לא סופקו, ברירת המחדל היא הכלל הנוכחי.

נוצר_פעולות

StarlarkValue ctx.created_actions()

עבור כללים שבהם הערך _skylark_testable מוגדר כ-True, הפונקציה מחזירה ספק פעולות שמייצג את כל הפעולות שנוצרו עד עכשיו עבור הכלל הנוכחי. עבור כל שאר הכללים, פונקציה זו מחזירה את None. חשוב לדעת שהספק לא מתעדכן כשנוצרות פעולות נוספות, ולכן צריך לקרוא לפונקציה הזו שוב אם רוצים לבדוק אותה.

מטרה זו היא לסייע בכתיבת בדיקות לפונקציות סיוע בעת יישום כלל, שעשויות לקחת אובייקט ctx וליצור פעולות לגביו.

default_provider

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)

מרחיב את כל $(location ...) התבניות במחרוזת הנתונה על ידי החלפת $(location //x) בנתיב של קובץ הפלט של היעד //x. ההרחבה פועלת רק בתוויות שמפנות לתלויות ישירות של הכלל הזה או שרשומות במפורש בארגומנט האופציונלי targets.

$(location ...) יגרום לשגיאה אם ביעד המצוין יש מספר פלטים. במקרה כזה, צריך להשתמש בפורמט $(locations ...) כי הוא יוצר רשימה של נתיבי פלט שמופרדים ברווחים. אפשר להשתמש בה באופן בטוח גם בקובץ פלט יחיד.

כדאי להשתמש בפונקציה הזו כדי לאפשר למשתמש לציין פקודה בקובץ BUILD (למשל עבור genrule). במקרים אחרים, בדרך כלל עדיף לבצע פעולות ישירות על תוויות.

פרמטרים

פרמטר תיאור
input נדרש
מחרוזת להרחבה.
targets sequence of Targets; ברירת מחדל = []
רשימת יעדים לפרטי חיפוש נוספים.
short_paths ברירת מחדל = False
יש להשתמש בנתיבים יחסיים במקום בנתיבי exe מלאים
עשוי להחזיר None.

expand_make_variables

string ctx.expand_make_variables(attribute_name, command, additional_substitutions)

הוּצאה משימוש. במקום זאת, אפשר להשתמש בפונקציה ctx.var. כדי להחזיר משתנים,
מחזירה מחרוזת אחרי הרחבת כל ההפניות ל-"Make המשתנים". הפורמט של המשתנים הוא $(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.