yerel istatistik

Bir kural veya özellik için uygulama işlevine aktarılan bağlam nesnesi. Mevcut hedefi analiz etmek için gereken bilgi ve yöntemlere erişim sağlar.

Özellikle, uygulama işlevinin mevcut hedefin etiketine, özelliklerine, yapılandırmasına ve bağımlılıklarının sağlayıcılarına erişmesine izin verir. Çıkış dosyalarını ve bunları üreten işlemleri belirtmeye yönelik yöntemler vardır.

Bağlam nesneleri esasen uygulama işlevine yapılan çağrı süresince yayındadır. Bu nesnelere, ilişkili işlevlerinin dışında erişmek yararlı değildir. Daha fazla bilgi için Kurallar sayfasına göz atın.

Üyeler

işlemler

actions ctx.actions

Çıkış dosyalarını ve bunları oluşturan işlemleri bildirme yöntemlerini içerir.

aspect_ids

list ctx.aspect_ids

Hedefe uygulanan tüm yönlere ilişkin kimliklerin listesi. Yalnızca en boy uygulama işlevlerinde kullanılabilir.

özlk

struct ctx.attr

Özelliklerin değerlerine erişmek için kullanılan bir yapı. Değerler kullanıcı tarafından sağlanır (değilse varsayılan değer kullanılır). struct'ın özellikleri ve değer türleri, rule işlevine sağlanan attrs dikte işlevindeki anahtarlara ve değerlere karşılık gelir. Kullanım örneğini inceleyin.

bin_dir

root ctx.bin_dir

Bin dizinine karşılık gelen kök.

build_file_path

string ctx.build_file_path

Bu kural için DERLEME dosyasının yolu (kaynak köke göre).

build_setting_value

unknown ctx.build_setting_value

Deneysel. Bu alan deneme amaçlıdır ve herhangi bir zamanda değiştirilebilir. Bu içeriklere güvenmeyin.

Geçerli hedefle temsil edilen derleme ayarının değeri. Kural tanımında build_setting özelliğini ayarlamayan kurallar için bu alana erişmek bir hatadır.

yapılandırma

configuration ctx.configuration

Varsayılan yapılandırma. Daha fazla ayrıntı için yapılandırma türüne bakın.

coverage_instrumented

bool ctx.coverage_instrumented(target=None)

Bu kural için derleme işlemleri gerçekleştirilirken kod kapsamı enstrümantasyonunun oluşturulup oluşturulmayacağını döndürür (target sağlanırsa, bu Hedef tarafından belirtilen kural). (Kural olmayan veya Starlark kuralı Hedefi sağlanırsa bu, Yanlış değerini döndürür.) Mevcut kuralın (Hedef belirtilmemişse) veya Hedef kaynaklarının --instrumentation_filter ve --instrument_test_targets yapılandırma ayarlarına göre ayarlanması gerekip gerekmediğini kontrol eder. Bu, yapılandırmadaki coverage_enabled ürününden farklıdır. Yapılandırmadaki coverage_enabled, kapsam verisi toplama özelliğinin çalıştırmanın tamamında etkinleştirilip etkinleştirilmediğini belirtir ancak belirli bir hedefin kullanılıp kullanılmayacağını belirtmez.

Parametreler

Parametre Açıklama
target Target; or None; varsayılan = Yok
Kural belirten bir hedef. Sağlanmazsa varsayılan olarak geçerli kural kullanılır.

created_actions

StarlarkValue ctx.created_actions()

_skylark_testable değerinin True olarak ayarlandığı kurallar için bu işlem, geçerli kural için o ana kadar oluşturulan tüm işlemleri temsil eden bir Actions sağlayıcısı döndürür. Diğer tüm kurallar için None değerini döndürür. Sonraki işlemler oluşturulduğunda sağlayıcı güncellenmez. Bu nedenle, bunları incelemek isterseniz bu işlevi yeniden çağırmanız gerekir.

Bu özelliğin amacı, ctx nesnesini alıp üzerinde işlem oluşturabilecek kural uygulaması yardımcı işlevleri için testler yazmaya yardımcı olmaktır.

default_provider

Provider ctx.default_provider

Kullanımdan kaldırıldı. Bunun yerine DefaultInfo'yu kullanın.

disabled_features

list ctx.disabled_features

Kullanıcı tarafından bu kural için açıkça devre dışı bırakılan özellikler grubu.

exec_groups

ExecGroupCollection ctx.exec_groups

Bu kural için kullanılabilen, adlarına göre dizine eklenmiş yürütme gruplarının bir koleksiyonu. ctx.exec_groups[name_of_group] ile erişin.

yürütülebilir

struct ctx.executable

executable=Trueolarak işaretlenmiş etiket türü özelliklerinde tanımlanmış yürütülebilir dosyalar içeren bir struct. struct alanları özellik adlarına karşılık gelir. Yapıdaki her değer bir File veya None'dir. Kuralda isteğe bağlı bir özellik belirtilmemişse karşılık gelen struct değeri None olur. Bir etiket türü executable=True olarak işaretlenmemişse karşılık gelen bir struct alanı oluşturulmaz. Kullanım örneğini inceleyin.

expand_location

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

$(location //x) öğesini hedef //x çıkış dosyasının yoluyla değiştirerek belirtilen dizedeki tüm $(location ...) şablonlarını genişletir. Genişletme yalnızca bu kuralın doğrudan bağımlılıklarına işaret eden veya isteğe bağlı targets bağımsız değişkeninde açıkça listelenen etiketler için çalışır.

$(location ...), başvurulan hedefin birden fazla çıkışı varsa hataya neden olur. Bu durumda, çıkış yollarının boşlukla ayrılmış bir listesini oluşturduğundan lütfen $(locations ...) politikasını kullanın. Tek bir çıkış dosyası için de güvenle kullanılabilir.

Bu işlev, kullanıcının BUILD dosyasında bir komut belirtebilmesi için kullanışlıdır (örneğin genrule için). Diğer durumlarda, etiketleri doğrudan değiştirmek çoğu zaman daha iyidir.

Parametreler

Parametre Açıklama
input gerekli
Genişletilecek dize.
targets sequence of Targets; varsayılan = []
Ek arama bilgileri için hedeflerin listesi.
short_paths default = False
Tam yürütme yolları yerine kök göreli yolları kullan
None iade edilebilir.

expand_make_variables

string ctx.expand_make_variables(attribute_name, command, additional_substitutions)

Kullanımdan kaldırıldı. Bunun yerine değişkenlere erişmek için ctx.var kullanın.
"Değişkenleri oluştur" için tüm başvuruları genişlettikten sonra bir dize döndürür. Değişkenler şu biçimde olmalıdır: $(VAR_NAME). Ayrıca, $$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.


        
host_configuration

        
configuration ctx.host_configuration


    The host configuration. See the configuration type for more details.


        
host_fragments

        
fragments ctx.host_fragments


    Allows access to configuration fragments in host configuration.


        
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.
            

          

                  

            
            
                          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.
            		
          

                  

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