Un objeto de contexto que se pasa a la función de implementación para una regla o un aspecto. Proporciona acceso a la información y los métodos necesarios para analizar el objetivo actual.
En particular, permite que la función de implementación acceda a la etiqueta, los atributos, la configuración y los proveedores de sus dependencias del destino actual. Tiene métodos para declarar archivos de salida y las acciones que los producen.
Los objetos de contexto se encuentran prácticamente activos durante la llamada a la función de implementación. No es útil acceder a estos objetos fuera de su función asociada. Consulta la página Reglas para obtener más información.
Miembros
- acciones
- aspect_ids
- attr
- bin_dir
- build_file_path
- build_setting_value
- configuración
- coverage_instrumented
- created_actions
- disabled_features
- exec_groups
- ejecutable
- expand_location
- expand_make_variables
- funciones
- archivo
- archivos
- fragmentos
- genfiles_dir
- info_file
- label
- resultados
- resolve_command
- resolve_tools
- regla
- runfiles
- split_attr
- súper
- target_platform_has_constraint
- cadenas de herramientas
- var
- version_file
- workspace_name
de solución
actions ctx.actions
aspect_ids
list ctx.aspect_ids
attr
struct ctx.attr
attrs
que se proporcionó a la función rule
. Consulta un ejemplo de uso.
bin_dir
root ctx.bin_dir
build_file_path
string ctx.build_file_path
build_setting_value
unknown ctx.build_setting_value
build_setting
, la lectura de esto es un error.
configuración
configuration ctx.configuration
coverage_instrumented
bool ctx.coverage_instrumented(target=None)
target
, la regla especificada por ese Target. (Si se proporciona un destino que no es una regla o un destino de la regla de Starlark, el resultado es falso). Verifica si las fuentes de la regla actual (si no se proporciona un objetivo) o las fuentes del objetivo deben instrumentarse según la configuración de --instrumentation_filter y --instrument_test_targets. Esto difiere de coverage_enabled
en la configuración, que indica si la recopilación de datos de cobertura está habilitada durante toda la ejecución, pero no si se debe instrumentar un objetivo específico.
Parámetros
Parámetro | Descripción |
---|---|
target
|
Objetivo; o None ;
el valor predeterminado es None Un destino que especifica una regla. Si no se proporciona, el valor predeterminado es la regla actual. |
created_actions
StarlarkValue ctx.created_actions()
True
, esto muestra un proveedor de Actions
que representa todas las acciones creadas hasta el momento para la regla actual. Para todas las demás reglas, muestra None
. Ten en cuenta que el proveedor no se actualiza cuando se crean acciones posteriores, por lo que tendrás que volver a llamar a esta función si deseas inspeccionarlos. Su objetivo es ayudar a escribir pruebas para funciones auxiliares en la implementación de reglas, que pueden incorporar un objeto
ctx
y crear acciones en él.
disabled_features
list ctx.disabled_features
exec_groups
ExecGroupCollection ctx.exec_groups
ctx.exec_groups[name_of_group]
.
ejecutable
struct ctx.executable
struct
que contiene archivos ejecutables definidos en los atributos de tipo de etiqueta marcados como executable=True
Los campos de struct corresponden a los nombres de los atributos. Cada valor del struct es File
o None
. Si no se especifica un atributo opcional en la regla, el valor de struct correspondiente es None
. Si un tipo de etiqueta no está marcado como executable=True
, no se genera ningún campo de struct correspondiente. Consulta un ejemplo de uso.
expand_location
string ctx.expand_location(input, targets=[])
$(location ...)
en la cadena dada, reemplaza $(location //x)
por la ruta de acceso del archivo de salida del destino //x. La expansión solo funciona para las etiquetas que apuntan a dependencias directas de esta regla o que se indican explícitamente en el argumento opcional targets
. $(location ...)
provocará un error si el destino al que se hace referencia tiene varias salidas. En este caso, usa $(locations ...)
, ya que produce una lista de rutas de salida separadas por espacios. También se puede usar de forma segura para un solo archivo de salida.Esta función es útil para permitir que el usuario especifique un comando en un archivo BUILD (como
genrule
). En otros casos, suele ser mejor manipular las etiquetas directamente.
Parámetros
Parámetro | Descripción |
---|---|
input
|
obligatorio Cadena que se expandirá. |
targets
|
secuencia de Objetivos
el valor predeterminado es [] Lista de destinos para obtener información adicional sobre la búsqueda. |
None
.
expand_make_variables
string ctx.expand_make_variables(attribute_name, command, additional_substitutions)
Muestra una cadena después de expandir todas las referencias a "Make variables". Las variables deben tener el siguiente formato:
$(VAR_NAME)
. Además, $$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
file
struct ctx.file
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]
file
to access the (singular) default output of a dependency. See example of use.
files
struct ctx.files
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 File
s. It is a shortcut for:[f for t in ctx.attr.<ATTR> for f in t.files]
files
to access the default outputs of a dependency. See example of use.
fragments
fragments ctx.fragments
genfiles_dir
root ctx.genfiles_dir
info_file
File ctx.info_file
label
Label ctx.label
outputs
structure ctx.outputs
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 correspondingFile
. - 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 correspondingFile
; otherwise the field value isNone
. - 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 ofFile
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
ortest
, 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 theexecutable
arg ofDefaultInfo
.
resolve_command
tuple ctx.resolve_command(command='', attribute=None, expand_locations=False, make_variables=None, tools=[], label_dict={}, execution_requirements={})
(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 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
|
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
|
default is {} Dictionary of resolved labels and the corresponding list of Files (a dict of Label : list of Files). |
execution_requirements
|
default is {} Information for scheduling the action to resolve this command. See tags for useful keys. |
resolve_tools
tuple ctx.resolve_tools(tools=[])
(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 is [] List of tools (list of targets). |
rule
rule_attributes ctx.rule
runfiles
runfiles ctx.runfiles(files=[], transitive_files=None, collect_data=False, collect_default=False, symlinks={}, root_symlinks={})
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
|
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
|
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. |
symlinks
|
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.
|
root_symlinks
|
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
super
unknown ctx.super()
target_platform_has_constraint
bool ctx.target_platform_has_constraint(constraintValue)
Parameters
Parameter | Description |
---|---|
constraintValue
|
required The constraint value to check the target platform against. |
toolchains
ToolchainContext ctx.toolchains
var
dict ctx.var
version_file
File ctx.version_file
workspace_name
string ctx.workspace_name