Para obtener documentación sobre versiones estables, usa el menú desplegable "Documentos con versiones". La vista predeterminada refleja la versión más reciente en el encabezado.

Se usó la API de Cloud Translation para traducir esta página.

UID

Informa un problema Ver la fuente

Es un objeto de contexto que se pasa a la función de implementación de una regla o un aspecto. Proporciona acceso a la información y a los métodos necesarios para analizar el destino 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 actuales. Tiene métodos para declarar archivos de salida y las acciones que los producen.

Básicamente, los objetos de contexto permanecen durante la llamada a la función de implementación. No es útil acceder a estos objetos fuera de su función asociada. Consulte la página Reglas para obtener más información.

Miembros

acciones
aspect_ids.
atracción
bin_dir
build_file_path
valor_configuración_compilación
configuración
coverage_instrumented
created_actions
proveedor_predeterminado
funciones_inhabilitadas
grupos_ejecutivos
ejecutable
ubicación_expandida
expand_make_variables (expandir
cámara
archivo
archivos
fragmentos
genfiles_dir
archivo_información
label
nuevo_archivo
resultados
resolve_command.
resolve_tools.
regla
runfiles
dividir_attr
target_platform_has_constraint
cadenas de herramientas
var
versión_archivo
workspace_name

de solución

actions ctx.actions

Contiene métodos para declarar archivos de salida y las acciones que los producen.

ID del aspecto

list ctx.aspect_ids

Es una lista de ID de todos los aspectos aplicados al objetivo. Solo disponible en las funciones de implementación de aspectos.

attr.

struct ctx.attr

Es una estructura para acceder a los valores de los atributos. El usuario proporciona los valores (de lo contrario, se usa un valor predeterminado). Los atributos del struct y los tipos de sus valores corresponden a las claves y los valores del dict de attrs que se proporcionan a la función rule. Ver ejemplo de uso.

bin_dir

root ctx.bin_dir

La raíz que corresponde al directorio bin.

ruta_archivo_compilación

string ctx.build_file_path

La ruta de acceso al archivo BUILD para esta regla, en relación con la raíz de origen.

valor_configuración_compilación

unknown ctx.build_setting_value

Experimental. Este campo es experimental y está sujeto a cambios en cualquier momento. No dependas de él.

Es el valor de la configuración de compilación que representa el destino actual. Es un error acceder a este campo para las reglas que no establecen el atributo build_setting en su definición de regla.

configuración

configuration ctx.configuration

La configuración predeterminada. Consulta el tipo de configuración para obtener más detalles.

cobertura_instrumentada

bool ctx.coverage_instrumented(target=None)

Muestra si la instrumentación de cobertura de código se debe generar cuando se realizan acciones de compilación para esta regla o, si se proporciona target, la regla especificada por ese objetivo. Si se proporciona un objetivo sin regla o Starlark, esto muestra False. Comprueba si las fuentes de la regla actual (si no se proporciona un destino) o las fuentes del destino deben instrumentarse según la configuración del --instrumentation_filter y del --instrument_test_targets. Esto difiere de coverage_enabled en la configuración, que indica si la recopilación de datos de cobertura está habilitada para toda la ejecución, pero no si se debe instrumentar un destino específico.

Parámetros

Parámetro	Descripción
`target`	`Target; or None`; default = None Un objetivo que especifica una regla. Si no se proporciona, se establece de forma predeterminada en la regla actual.

acción_creada

StarlarkValue ctx.created_actions()

En el caso de las reglas que tienen _skylark_testable configurado como True, se muestra un proveedor de Actions que representa todas las acciones creadas hasta ahora 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 inspeccionarla.

El objetivo es ayudar a escribir pruebas para las funciones auxiliares de implementación de reglas, que pueden tomar un objeto ctx y crear acciones en él.

proveedor_predeterminado

Provider ctx.default_provider

Ya no está disponible. En su lugar, usa DefaultInfo.

funciones_inhabilitadas

list ctx.disabled_features

Es el conjunto de funciones que el usuario inhabilita de forma explícita para esta regla.

grupos_ejecutivos

ExecGroupCollection ctx.exec_groups

Una colección de los grupos de ejecución disponibles para esta regla, indexada por su nombre. Acceso con ctx.exec_groups[name_of_group].

ejecutable

struct ctx.executable

Una struct que contenga archivos ejecutables definidos en los atributos de tipo de etiqueta marcados como executable=True Los campos 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 struct correspondiente. Ver ejemplo de uso.

expandir_ubicación

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

Expande todas las plantillas $(location ...) en la string determinada mediante el reemplazo de $(location //x) con la ruta del archivo de salida de destino //x. La expansión solo funciona para etiquetas que apuntan a dependencias directas de esta regla o que se enumeran de forma explícita en el argumento opcional targets.

$(location ...) generará un error si el destino al que se hace referencia tiene varios resultados. 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 para genrule). En otros casos, a menudo es mejor manipular etiquetas directamente.

Parámetros

Parámetro	Descripción
`input`	Obligatorio String que se expandirá.
`targets`	`sequence of Targets`; default = [] Lista de destinos para obtener información de búsqueda adicional.

Puede mostrar None.

expandir_crear_variables

string ctx.expand_make_variables(attribute_name, command, additional_substitutions)

Obsoleto. Usa ctx.var para acceder a las variables.
Muestra una string 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

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.

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.
`symlinks`	`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.
`root_symlinks`	`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.