yerel istatistik

Sorun bildir Kaynağı göster Nightly · 8.0 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

Bir kural veya özellik için uygulama işlevine iletilen bir bağlam nesnesi. Mevcut hedefi analiz etmek için gereken bilgilere 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 olanak tanır. Çıkış dosyalarını ve bunları oluşturan işlemleri bildirme yöntemlerine sahiptir.

Bağlama nesneleri temel olarak uygulama işlevine yapılan çağrı süresi boyunca geçerlidir. Bu nesnelere ilişkili işlevlerinin dışından erişmek yararlı değildir. Daha fazla bilgi için Kurallar sayfasına bakın.

Üyeler

işlemler

actions ctx.actions

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

aspect_ids

list ctx.aspect_ids

Hedefe uygulanan tüm özelliklerin kimliklerinin listesi. Yalnızca özellik 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 (aksi takdirde varsayılan değer kullanılır). Yapının özellikleri ve değerlerinin türleri, rule işlevine sağlanan attrs sözlüğünün anahtarlarına ve değerlerine 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

Desteği sonlandırıldı: ctx.label.package + '/BUILD' kullanın. Bu kuralın BUILD dosyasının, kaynak köküne göre yolu.

build_setting_value

unknown ctx.build_setting_value

Geçerli hedef tarafından temsil edilen derleme ayarının değeri. Bu, build_setting özelliğini ayarlayan bir kural örneğinin bağlamı değilse bu okuma hatalı olur.

yapılandırma

configuration ctx.configuration

Varsayılan yapılandırma. Daha fazla bilgi 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 yapılırken veya target sağlanırsa ilgili hedef tarafından belirtilen kural için kod kapsamı enstrümantasyonunun oluşturulup oluşturulmayacağını döndürür. (Kural olmayan veya Starlark kuralı hedefi sağlanırsa bu işlev False değerini döndürür.) Geçerli kuralın kaynaklarının (hedef sağlanmamışsa) veya hedefin kaynaklarının --instrumentation_filter ve --instrument_test_targets yapılandırma ayarlarına göre enstrümante edilip edilmeyeceğini kontrol eder. Bu, yapılandırmada coverage_enabled ile farklıdır. coverage_enabled, kapsam verilerinin toplanması özelliğinin tüm çalışma için etkin olup olmadığını belirtir ancak belirli bir hedefin enstrümante edilmesi gerekip gerekmediğini belirtmez.

Parametreler

Parametre Açıklama
target Hedef veya None; varsayılan değer None
Kuralı belirten bir hedef. Sağlanmazsa varsayılan olarak geçerli kural kullanılır.

created_actions

StarlarkValue ctx.created_actions()

_skylark_testable özelliği True olarak ayarlanmış kurallar için bu işlev, geçerli kural için şimdiye kadar oluşturulan tüm işlemleri temsil eden bir Actions sağlayıcı 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ının güncellenmediğini unutmayın. Bu nedenle, bunları incelemek isterseniz bu işlevi tekrar çağırmanız gerekir.

Bu, ctx nesnesi alıp üzerinde işlemler oluşturabilecek kural uygulama yardımcı işlevleri için testler yazmanıza yardımcı olmak amacıyla tasarlanmıştır.

disabled_features

list ctx.disabled_features

Bu kural için kullanıcı tarafından açıkça devre dışı bırakılan özellik grubu.

exec_groups

ExecGroupCollection ctx.exec_groups

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

yürütülebilir

struct ctx.executable

executable=True olarak işaretlenmiş etiket türü özelliklerinde tanımlanan yürütülebilir dosyaları içeren bir struct. Yapı alanları, özellik adlarına karşılık gelir. Yapıdaki her değer File veya None'tır. Kurallarda isteğe bağlı bir özellik belirtilmezse ilgili yapı 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=[])

$(location //x) değerini hedef //x çıkış dosyasının yolu ile değiştirerek belirli bir dizedeki tüm $(location ...) şablonlarını genişletir. Genişleme 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 ...), referans verilen hedefin birden fazla çıkışı varsa hata oluşturur. Bu durumda, çıkış yollarının boşlukla ayrılmış bir listesini oluşturduğundan lütfen $(locations ...) seçeneğini kullanın. Tek bir çıkış dosyası için de güvenli bir şekilde kullanılabilir.

Bu işlev, kullanıcının BUILD dosyasında bir komut belirtmesine (genrule için olduğu gibi) olanak tanır. Diğer durumlarda, etiketleri doğrudan değiştirmek genellikle daha iyidir.

Parametreler

Parametre Açıklama
input string; required
Genişletilecek dize.
targets Hedef dizisi; varsayılan değer []
Ek arama bilgileri için hedeflerin listesi.
None değerini döndürebilir.

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.
Tüm referansları "Değişken oluştur" olarak 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
            
            
                          string;
                                     required

                          The attribute name. Used for error reporting.
            		
          

                  

            
              command
            
            
                          string;
                                     required

                          The expression to expand. It can contain references to "Make variables".
            		
          

                  

            
              additional_substitutions
            
            
                          dict;
                                     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, empty list) of the list of resolved inputs and the argv list for the resolved command both 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). The empty list is returned as the third member of the tuple for backwards compatibility.

          
      
Parameters

      

        
          
          
        
        
          

            Parameter
            Description
          

        
        
                  

            
              command
            
            
                          string;
                                     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
            
            
                          bool;
                                     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
            
            
                          dict;
                                     default is {}

                          Dictionary of resolved labels and the corresponding list of Files (a dict of Label : list of Files).
            		
          

                  

            
              execution_requirements
            
            
                          dict;
                                     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, empty list) of the depset of resolved inputs required to run the tools, suitable for passing as the same-named argument of the ctx.actions.run and ctx.actions.run_shell methods. 

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. The empty list is returned as part of the tuple for backward compatibility.

          
      
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
            
            
                          bool;
                                     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
            
            
                          bool;
                                     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
            
            
                          ConstraintValueInfo;
                                     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.