Um objeto de contexto que é passado para a função de implementação para uma regra ou aspecto. Ela fornece acesso às informações e aos métodos necessários para analisar o alvo atual.
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 permanecem essencialmente durante a chamada à função de implementação. Não é útil acessar esses objetos fora de sua função associada. Consulte a página 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
- disabled_features
- exec_groups
- executável
- expand_location
- expand_make_variables
- recursos
- file
- arquivos
- fragmentos
- genfiles_dir
- info_file
- label
- saídas
- resolve_command
- resolve_tools
- regra
- runfiles
- split_attr
- super
- target_platform_has_constraint
- conjuntos de ferramentas
- var (link em inglês)
- version_file
- workspace_name
corretivas
actions ctx.actions
aspect_ids
list ctx.aspect_ids
attr
struct ctx.attr
attrs
fornecido para a 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
build_setting
, a leitura será um erro.
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 ou de regra Starlark for fornecido, será retornado False. 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 indica se a coleta de dados de cobertura está ativada para toda a execução, mas não se uma meta específica precisa ser instrumentada.
Parâmetros
Parâmetro | Descrição |
---|---|
target
|
Target; ou None
o padrão é None Um destino especificando 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 Actions
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.
disabled_features
list ctx.disabled_features
exec_groups
ExecGroupCollection ctx.exec_groups
ctx.exec_groups[name_of_group]
.
Executável
struct ctx.executable
struct
contendo arquivos executáveis definidos nos atributos de tipo de rótulo marcados como executable=True
. Os campos de struct correspondem aos nomes dos atributos. Cada valor no struct é um File
ou um 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 estiver marcado como executable=True
, nenhum campo de struct correspondente será gerado. Confira um exemplo de uso.
expand_location
string ctx.expand_location(input, targets=[])
$(location ...)
na string especificada substituindo $(location //x)
pelo caminho do arquivo de saída de destino //x. A expansão só funciona para rótulos que apontam para dependências diretas dessa regra ou que são explicitamente listados 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 separada por espaços de caminhos de saída. 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 em
genrule
). Em outros casos, geralmente é melhor manipular os rótulos diretamente.
Parâmetros
Parâmetro | Descrição |
---|---|
input
|
obrigatório String a ser expandida. |
targets
|
sequência de destinos;
o padrão é [] Lista de destinos para mais informações de pesquisa. |
None
.
expand_make_variables
string ctx.expand_make_variables(attribute_name, command, additional_substitutions)
Retorna uma string depois de expandir todas as referências para "Make variables". 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
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
--enable_bzlmod
is on, this is the fixed string _main
. Otherwise, this is the workspace name as defined in the WORKSPACE file.