BazelCon 2022 findet vom 16. bis 17. November in New York und online statt.
Jetzt anmelden

CPC

Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Ein Kontextobjekt, das an die Implementierungsfunktion für eine Regel oder einen Aspekt übergeben wird Sie erhalten Zugriff auf die Informationen und Methoden, die zur Analyse des aktuellen Ziels erforderlich sind.

Insbesondere kann die Implementierungsfunktion auf das Label, die Attribute, die Konfiguration und die Anbieter der Abhängigkeiten des aktuellen Ziels zugreifen. Es gibt Methoden zum Deklarieren von Ausgabedateien und den Aktionen, mit denen sie erstellt werden.

Kontextobjekte sind für die Dauer des Aufrufs der Implementierungsfunktion aktiv. Es ist nicht hilfreich, auf diese Objekte außerhalb der zugehörigen Funktion zuzugreifen. Weitere Informationen finden Sie auf der Seite Regeln.

Mitglieder

Aktionen

actions ctx.actions

Enthält Methoden zum Deklarieren von Ausgabedateien und den Aktionen, die sie erzeugen.

Attribut-IDs

list ctx.aspect_ids

Gibt eine Listen-ID für alle auf das Ziel angewendeten Aspekte zurück. Nur verfügbar bei Implementierungsfunktionen für das Seitenverhältnis.

Attr

struct ctx.attr

Eine Struktur für den Zugriff auf die Werte der Attribute. Die Werte werden vom Nutzer bereitgestellt. Andernfalls wird ein Standardwert verwendet. Die Attribute der Struktur und die Arten ihrer Werte entsprechen den Schlüsseln und Werten des attrs-Wörterbuchs, das für die rule-Funktion angegeben ist. Beispiel für die Verwendung

bin_dir

root ctx.bin_dir

Das Stammverzeichnis, das dem bin-Verzeichnis entspricht.

Dateipfad erstellen

string ctx.build_file_path

Gibt den Pfad zur BUILD-Datei für diese Regel relativ zum Quellstamm zurück.

Build-Einstellungswert

unknown ctx.build_setting_value

Experimentell. Dieses Feld ist experimentell und kann sich jederzeit ändern. Verlassen Sie sich nicht darauf.

Gibt den Wert der Build-Einstellung zurück, die durch das aktuelle Ziel dargestellt wird. Wenn Sie Regeln aufrufen, bei denen das Attribut build_setting in der Regeldefinition nicht festgelegt ist, erhalten Sie einen Fehler.

Konfiguration

configuration ctx.configuration

Gibt die Standardkonfiguration zurück. Weitere Informationen finden Sie unter Konfiguration.

Abdeckung_instrumentiert

bool ctx.coverage_instrumented(target=None)

Gibt an, ob die Instrumentierung für die Codeabdeckung beim Ausführen der Kompilierungsaktionen für diese Regel generiert werden soll. Wird target angegeben, wird die von diesem Ziel angegebene Regel verwendet. Wenn ein Ziel, das keine Regel oder eine Starlark-Regel ist, angegeben wird, wird „False“ zurückgegeben. Prüft, ob die Quellen der aktuellen Regel (falls kein Ziel angegeben ist) oder die Quellen des Ziels basierend auf den Konfigurationseinstellungen --instrumentation_filter und --instrument_test_targets instrumentiert werden sollen. Dies unterscheidet sich von coverage_enabled in der Konfiguration, die angibt, ob die Erfassung von Abdeckungsdaten für die gesamte Ausführung aktiviert ist, aber nicht, ob ein bestimmtes Ziel instrumentiert werden soll.

Parameter

Parameter Beschreibung
target Target; or None; default = None
Ein Ziel, das eine Regel angibt. Wenn nicht angegeben, wird standardmäßig die aktuelle Regel verwendet.

Aktionen_erstellt

StarlarkValue ctx.created_actions()

Bei Regeln, bei denen _skylark_testable auf True gesetzt ist, wird ein Actions-Anbieter zurückgegeben, der alle bisher für die aktuelle Regel erstellten Aktionen darstellt. Gibt für alle anderen Regeln None zurück. Hinweis: Der Anbieter wird nicht aktualisiert, wenn nachfolgende Aktionen erstellt werden. Sie müssen diese Funktion also noch einmal aufrufen, um sie zu prüfen.

Diese soll helfen, Tests für Hilfsfunktionen zur Regelimplementierung zu schreiben, die ein ctx-Objekt aufnehmen und Aktionen für das Objekt erstellen können.

Standardanbieter

Provider ctx.default_provider

Veraltet. Verwenden Sie stattdessen DefaultInfo.

deaktivierte_features

list ctx.disabled_features

Gibt die Funktionen zurück, die für den Nutzer explizit für diese Regel deaktiviert sind.

exec_groups

ExecGroupCollection ctx.exec_groups

Eine Sammlung der für diese Regel verfügbaren Ausführungsgruppen, indexiert nach ihrem Namen. Zugriff mit ctx.exec_groups[name_of_group].

Ausführbar

struct ctx.executable

Ein struct mit ausführbaren Dateien, die in Labeltypattributen definiert sind und als executable=True gekennzeichnet sind. Die Strukturfelder entsprechen den Attributnamen. Jeder Wert in der Struktur ist entweder ein File oder None. Wenn in der Regel kein optionales Attribut angegeben ist, ist der entsprechende Strukturwert None. Wenn ein Labeltyp nicht als executable=True gekennzeichnet ist, wird kein entsprechendes Strukturfeld generiert. Beispiel für die Verwendung

Maximieren_Standort

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

Maximiert alle $(location ...)-Vorlagen im angegebenen String, indem $(location //x) durch den Pfad der Ausgabedatei des Ziels //x ersetzt wird. Die Erweiterung funktioniert nur für Labels, die auf direkte Abhängigkeiten dieser Regel verweisen oder explizit im optionalen Argument targets aufgeführt sind.

$(location ...) verursacht einen Fehler, wenn das referenzierte Ziel mehrere Ausgaben hat. Verwenden Sie in diesem Fall $(locations ...), da es eine durch Leerzeichen getrennte Liste von Ausgabepfaden erzeugt. Sie kann auch sicher für eine einzelne Ausgabedatei verwendet werden.

Mit dieser Funktion kann der Nutzer einen Befehl in einer BUILD-Datei angeben (z. B. für genrule). In anderen Fällen ist es oft besser, Labels direkt zu bearbeiten.

Parameter

Parameter Beschreibung
input erforderlich
String, der maximiert werden soll.
targets sequence of Targets; default = []
Liste der Ziele für zusätzliche Suchinformationen.
short_paths default = False
Relative Root-Pfade anstelle von vollständigen Pfaden verwenden
Kann None zurückgeben.

Variablen_maximieren

string ctx.expand_make_variables(attribute_name, command, additional_substitutions)

Eingestellt. Greifen Sie stattdessen auf ctx.var zu, um auf die Variablen zuzugreifen.
Gibt einen String zurück, nachdem Sie alle Verweise auf „Variablen erstellen“ maximiert haben. Die Variablen müssen das folgende Format haben: $(VAR_NAME). Außerdem: $$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.