lewati

Laporkan masalah Lihat sumber Nightly · 8.0 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

Objek konteks yang diteruskan ke fungsi implementasi untuk aturan atau aspek. API ini memberikan akses ke informasi dan metode yang diperlukan untuk menganalisis target saat ini.

Secara khusus, hal ini memungkinkan fungsi implementasi mengakses label, atribut, konfigurasi, dan penyedia dependensi target saat ini. Class ini memiliki metode untuk mendeklarasikan file output dan tindakan yang menghasilkannya.

Objek konteks pada dasarnya aktif selama durasi panggilan ke fungsi implementasi. Akses ke objek ini di luar fungsi terkait tidak akan berguna. Lihat halaman Aturan untuk mengetahui informasi selengkapnya.

Anggota

tindakan

actions ctx.actions

Berisi metode untuk mendeklarasikan file output dan tindakan yang menghasilkannya.

aspect_ids

list ctx.aspect_ids

Daftar ID untuk semua aspek yang diterapkan ke target. Hanya tersedia di fungsi implementasi aspek.

attr

struct ctx.attr

Struktur untuk mengakses nilai atribut. Nilai diberikan oleh pengguna (jika tidak, nilai default akan digunakan). Atribut struct dan jenis nilainya sesuai dengan kunci dan nilai kamus attrs yang diberikan ke fungsi rule. Lihat contoh penggunaan.

bin_dir

root ctx.bin_dir

Root yang sesuai dengan direktori bin.

build_file_path

string ctx.build_file_path

Jalur ke file BUILD untuk aturan ini, relatif terhadap root sumber.

build_setting_value

unknown ctx.build_setting_value

Nilai setelan build yang diwakili oleh target saat ini. Jika ini bukan konteks untuk instance aturan yang menetapkan atribut build_setting, membaca ini akan menghasilkan error.

konfigurasi

configuration ctx.configuration

Konfigurasi default. Lihat jenis konfigurasi untuk mengetahui detail selengkapnya.

coverage_instrumented

bool ctx.coverage_instrumented(target=None)

Menampilkan apakah instrumentasi cakupan kode harus dibuat saat melakukan tindakan kompilasi untuk aturan ini atau, jika target disediakan, aturan yang ditentukan oleh Target tersebut. (Jika Target aturan non-aturan atau Starlark diberikan, ini akan menampilkan False.) Memeriksa apakah sumber aturan saat ini (jika tidak ada Target yang diberikan) atau sumber Target harus diinstrumentasi berdasarkan setelan konfigurasi --instrumentation_filter dan --instrument_test_targets. Hal ini berbeda dengan coverage_enabled dalam konfigurasi, yang mencatat apakah pengumpulan data cakupan diaktifkan untuk seluruh operasi, tetapi tidak mencatat apakah target tertentu harus diinstrumentasi.

Parameter

Parameter Deskripsi
target Target; atau None; defaultnya adalah None
Target yang menentukan aturan. Jika tidak diberikan, defaultnya adalah aturan saat ini.

created_actions

StarlarkValue ctx.created_actions()

Untuk aturan dengan _skylark_testable yang ditetapkan ke True, tindakan ini akan menampilkan penyedia Actions yang mewakili semua tindakan yang dibuat sejauh ini untuk aturan saat ini. Untuk semua aturan lainnya, menampilkan None. Perhatikan bahwa penyedia tidak diperbarui saat tindakan berikutnya dibuat, sehingga Anda harus memanggil fungsi ini lagi jika ingin memeriksanya.

Ini dimaksudkan untuk membantu menulis pengujian untuk fungsi bantuan penerapan aturan, yang dapat mengambil objek ctx dan membuat tindakan di dalamnya.

disabled_features

list ctx.disabled_features

Kumpulan fitur yang dinonaktifkan secara eksplisit oleh pengguna untuk aturan ini.

exec_groups

ExecGroupCollection ctx.exec_groups

Kumpulan grup eksekusi yang tersedia untuk aturan ini, diindeks berdasarkan namanya. Akses dengan ctx.exec_groups[name_of_group].

dapat dieksekusi

struct ctx.executable

struct yang berisi file yang dapat dieksekusi yang ditentukan dalam atribut jenis label yang ditandai sebagai executable=True. Kolom struct sesuai dengan nama atribut. Setiap nilai dalam struct adalah File atau None. Jika atribut opsional tidak ditentukan dalam aturan, nilai struct yang sesuai adalah None. Jika jenis label tidak ditandai sebagai executable=True, tidak ada kolom struct yang sesuai yang dihasilkan. Lihat contoh penggunaan.

expand_location

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

Memperluas semua template $(location ...) dalam string yang diberikan dengan mengganti $(location //x) dengan jalur file output target //x. Perluasan hanya berfungsi untuk label yang mengarah ke dependensi langsung aturan ini atau yang tercantum secara eksplisit dalam argumen opsional targets.

$(location ...) akan menyebabkan error jika target yang dirujuk memiliki beberapa output. Dalam hal ini, gunakan $(locations ...) karena menghasilkan daftar jalur output yang dipisahkan spasi. Fungsi ini juga dapat digunakan dengan aman untuk satu file output.

Fungsi ini berguna untuk memungkinkan pengguna menentukan perintah dalam file BUILD (seperti untuk genrule). Dalam kasus lain, sebaiknya manipulasi label secara langsung.

Parameter

Parameter Deskripsi
input required
String yang akan diperluas.
targets urutan Target; default adalah []
Daftar target untuk informasi pencarian tambahan.
Dapat menampilkan None.

expand_make_variables

string ctx.expand_make_variables(attribute_name, command, additional_substitutions)

Tidak digunakan lagi. Sebagai gantinya, gunakan ctx.var untuk mengakses variabel.
Menampilkan string setelah memperluas semua referensi ke "Buat variabel". Variabel harus memiliki format berikut: $(VAR_NAME). Selain itu, $$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.