Em particular, ele permite que a função de implementação acesse o rótulo, os atributos, a configuração e os provedores das dependências do destino atual. Ele tem métodos para declarar arquivos de saída e as ações que os produzem.
Os objetos de contexto basicamente permanecem ativos durante a duração da chamada para a função de implementação. Não é útil acessar esses objetos fora da função associada. Consulte a página de regras para mais informações.
Membros
- ações
- aspect_ids
- attr
- bin_dir
- build_file_path
- build_setting_value
- configuração
- coverage_instrumented
- created_actions
- default_provider
- disabled_features
- exec_groups
- executável
- expand_location
- expand_make_variables
- recursos
- file
- arquivos
- fragmentos
- genfiles_dir
- host_configuration
- host_fragments
- info_file
- label
- new_file
- saídas
- resolve_command
- resolve_tools
- regra
- runfiles
- split_attr
- target_platform_has_constraint
- conjuntos de ferramentas
- var
- version_file
- workspace_name
corretivas
actions ctx.actions
aspect_ids
list ctx.aspect_ids
attr
struct ctx.attr
attrs
fornecido à função rule
. Confira um exemplo de uso.
bin_dir
root ctx.bin_dir
build_file_path
string ctx.build_file_path
build_setting_value
unknown ctx.build_setting_value
O valor da configuração de build representado pelo destino atual. É um erro acessar esse campo para regras que não definem o atributo build_setting
na definição da regra.
configuração
configuration ctx.configuration
coverage_instrumented
bool ctx.coverage_instrumented(target=None)
target
for fornecida, a regra especificada por esse destino. Se um destino de regra não correspondente ou uma regra Starlark for fornecido, o resultado será "Falso". Verifica se as origens da regra atual (se nenhuma segmentação for fornecida) ou se as origens da meta precisam ser instrumentadas com base nas configurações de configuração --instrumentation_filter e --instrument_test_targets. Isso é diferente de coverage_enabled
na configuração, que observa se a coleta de dados de cobertura está ativada para toda a execução, mas não se um destino específico precisa ser instrumentado.
Parâmetros
Parâmetro | Descrição |
---|---|
target
|
Target; or None ;
padrão = nenhumUm destino que especifica uma regra. Se não for informado, o padrão será a regra atual. |
created_actions
StarlarkValue ctx.created_actions()
True
, isso retorna um provedor de Ações que representa todas as ações criadas até o momento para a regra atual. Para todas as outras regras, retorna None
. Observe que o provedor não é atualizado quando ações subsequentes são criadas, portanto, você terá que chamar essa função novamente se quiser inspecioná-las. O objetivo é ajudar a criar testes para funções auxiliares de implementação de regras, que podem usar um objeto
ctx
e criar ações nele.
default_provider
Provider ctx.default_provider
disabled_features
list ctx.disabled_features
exec_groups
ExecGroupCollection ctx.exec_groups
ctx.exec_groups[name_of_group]
.
Executável
struct ctx.executable
struct
que contém arquivos executáveis definidos em atributos de tipo de rótulo marcados como executable=True
. Os campos do struct correspondem aos nomes dos atributos. Cada valor na struct é um File
ou None
. Se um atributo opcional não for especificado na regra, o valor do struct correspondente será None
. Se um tipo de rótulo não for marcado como executable=True
, nenhum campo de struct correspondente será gerado. Confira um exemplo de uso.
expand_location
string ctx.expand_location(input, targets=[], short_paths=False)
$(location ...)
na string especificada substituindo $(location //x)
pelo caminho do arquivo de saída do destino //x. A expansão só funciona para rótulos que apontam para dependências diretas dessa regra ou que são listados explicitamente no argumento opcional targets
. $(location ...)
vai causar um erro se o destino referenciado tiver várias saídas. Nesse caso, use $(locations ...)
, porque ele produz uma lista de caminhos de saída separados por espaços. Ela também pode ser usada com segurança para um único arquivo de saída.Essa função é útil para permitir que o usuário especifique um comando em um arquivo BUILD (como para
genrule
). Em outros casos, muitas vezes é melhor manipular os rótulos diretamente.
Parâmetros
Parâmetro | Descrição |
---|---|
input
|
required String a ser expandida. |
targets
|
sequence of Targets ;
padrão = []Lista de destinos para informações de pesquisa adicionais. |
short_paths
|
default = False Use caminhos relativos raiz em vez de caminhos de execução completos |
None
.
expand_make_variables
string ctx.expand_make_variables(attribute_name, command, additional_substitutions)
Retorna uma string após expandir todas as referências para "Criar variáveis". As variáveis precisam ter o seguinte formato:
$(VAR_NAME)
. Além disso, $$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
The set of features that are explicitly enabled by the user for this rule. See example of use. list ctx.featuresfile
A struct ctx.filestruct
containing files defined in label type attributes marked asallow_single_file
. The struct fields correspond to the attribute names. The struct value is always aFile
orNone
. If an optional attribute is not specified in the rule then the corresponding struct value isNone
. If a label type is not marked asallow_single_file
, no corresponding struct field is generated. It is a shortcut for:In other words, use list(ctx.attr.<ATTR>.files)[0]file
to access the (singular) default output of a dependency. See example of use.files
A struct ctx.filesstruct
containing files defined in label or label list type attributes. The struct fields correspond to the attribute names. The struct values arelist
ofFile
s. It is a shortcut for:In other words, use [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
Allows access to configuration fragments in target configuration. fragments ctx.fragmentsgenfiles_dir
The root corresponding to genfiles directory. root ctx.genfiles_dirhost_configuration
The host configuration. See the configuration type for more details. configuration ctx.host_configurationhost_fragments
Allows access to configuration fragments in host configuration. fragments ctx.host_fragmentsinfo_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. File ctx.info_filelabel
The label of the target currently being analyzed. Label ctx.labelnew_file
DEPRECATED. Use ctx.actions.declare_file. File ctx.new_file(var1, var2=unbound, var3=unbound)
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
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 = '' Command to resolve. |
attribute
|
string; or None ;
default = NoneName 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 = NoneMake 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=[])
(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
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 = []The list of files to be added to the runfiles. |
transitive_files
|
depset of Files; or None ;
default = NoneThe (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
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