ctx

7.3 · 7.2 · 7.1 · 7.0 · 6.5

Um objeto de contexto transmitido para a função de implementação de uma regra ou aspecto. Ele fornece acesso às informações e aos métodos necessários para analisar o destino 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 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

corretivas

actions ctx.actions

Contém métodos para declarar arquivos de saída e as ações que os produzem.

aspect_ids

list ctx.aspect_ids

Uma lista de IDs de todos os aspectos aplicados ao destino. Disponível apenas em funções de implementação de aspectos.

attr

struct ctx.attr

Um struct para acessar os valores dos atributos. Os valores são fornecidos pelo usuário. Caso contrário, um valor padrão é usado. Os atributos do struct e os tipos dos valores correspondem às chaves e aos valores do dicionário attrs fornecido à função rule. Confira um exemplo de uso.

bin_dir

root ctx.bin_dir

A raiz correspondente ao diretório bin.

build_file_path

string ctx.build_file_path

O caminho para o arquivo BUILD para essa regra, relativo à raiz de origem.

build_setting_value

unknown ctx.build_setting_value

Valor da configuração de build representado pelo destino atual. Se esse não for o contexto de uma instância de uma regra que define o atributo build_setting, a leitura será um erro.

configuração

configuration ctx.configuration

A configuração padrão. Consulte o tipo de configuração para mais detalhes.

coverage_instrumented

bool ctx.coverage_instrumented(target=None)

Retorna se a instrumentação de cobertura de código precisa ser gerada ao executar ações de compilação para esta regra ou, se 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 fontes da regra atual (se nenhuma Target for fornecida) ou as fontes da Target precisam ser instrumentadas com base nas configurações --instrumentation_filter e --instrument_test_targets. Isso é diferente do 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 Meta ou None. O padrão é None
. Uma meta que especifica uma regra. Se não for fornecido, o padrão será a regra atual.

created_actions

StarlarkValue ctx.created_actions()

Para regras com _skylark_testable definido como 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 escrever testes para funções auxiliares de implementação de regras, que podem receber um objeto ctx e criar ações nele.

disabled_features

list ctx.disabled_features

O conjunto de recursos que são explicitamente desativados pelo usuário para esta regra.

exec_groups

ExecGroupCollection ctx.exec_groups

Uma coleção dos grupos de execução disponíveis para essa regra, indexada pelo nome. Acesse com ctx.exec_groups[name_of_group].

Executável

struct ctx.executable

Um struct contendo arquivos executáveis definidos nos atributos de tipo de rótulo marcados como executable=True. Os campos do 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 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=[])

Expande todos os modelos $(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 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 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 Sequência de Destinos. O padrão é []
. Lista de destinos para mais informações de pesquisa.
Pode retornar None.

expand_make_variables

string ctx.expand_make_variables(attribute_name, command, additional_substitutions)

Obsoleto. Em vez disso, use ctx.var para acessar as variáveis.
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


    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.


        
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 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=[])


    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 is []

                          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 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.
            

          

                  

            
            
                          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.
            		
          

                  

            
            
                          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


    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.


        
super

        
unknown ctx.super()


    Experimental: Calls parent's implementation function and returns its providers


        
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 name of the workspace, which is effectively the execution root name and runfiles prefix for the main repo. If --enable_bzlmod is on, this is the fixed string _main. Otherwise, this is the workspace name as defined in the WORKSPACE file.