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 penerapan. Mengakses objek ini di luar fungsi yang terkait tidak akan berguna. Lihat halaman Aturan untuk mengetahui informasi selengkapnya.
Anggota
- tindakan
- aspect_ids
- attr
- bin_dir
- build_file_path
- build_setting_value
- konfigurasi
- coverage_instrumented
- created_actions
- default_provider
- disabled_features
- exec_groups
- dapat dieksekusi
- expand_location
- expand_make_variables
- fitur
- file
- file
- fragmen
- genfiles_dir
- host_configuration
- host_fragments
- info_file
- label
- new_file
- output
- resolve_command
- resolve_tools
- aturan
- runfiles
- split_attr
- target_platform_has_constraint
- toolchain
- var
- version_file
- workspace_name
tindakan
actions ctx.actions
aspect_ids
list ctx.aspect_ids
attr
struct ctx.attr
attrs yang diberikan untuk fungsi rule. Lihat contoh penggunaan.
bin_dir
root ctx.bin_dir
build_file_path
string ctx.build_file_path
build_setting_value
unknown ctx.build_setting_value
Nilai setelan build yang diwakili oleh target saat ini. Merupakan error saat mengakses kolom ini untuk aturan yang tidak menetapkan atribut build_setting dalam definisi aturannya.
konfigurasi
configuration ctx.configuration
coverage_instrumented
bool ctx.coverage_instrumented(target=None)
target disediakan, aturan yang ditentukan oleh Target tersebut. (Jika Target aturan Starlark atau non-aturan diberikan, nilai ini akan menampilkan False.) Memeriksa apakah sumber aturan saat ini (jika tidak ada Target yang disediakan) atau sumber Target harus diinstrumentasikan berdasarkan setelan konfigurasi --instrumentation_filter dan --instrument_test_targets. Hal ini berbeda dengan coverage_enabled di konfigurasi, yang mencatat apakah pengumpulan data cakupan diaktifkan untuk seluruh proses, tetapi tidak untuk menentukan apakah target tertentu harus diinstrumentasikan.
Parameter
| Parameter | Deskripsi |
|---|---|
target
|
Target; or None;
default = Tidak adaTarget yang menentukan aturan. Jika tidak diberikan, setelan defaultnya adalah aturan saat ini. |
created_actions
StarlarkValue ctx.created_actions()
True, hal 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 diupdate ketika tindakan selanjutnya dibuat, sehingga Anda harus memanggil fungsi ini lagi jika ingin memeriksanya. Ini dimaksudkan untuk membantu menulis pengujian bagi fungsi bantuan implementasi aturan, yang dapat mengambil objek
ctx dan membuat tindakan terhadap objek tersebut.
default_provider
Provider ctx.default_provider
disabled_features
list ctx.disabled_features
exec_groups
ExecGroupCollection ctx.exec_groups
ctx.exec_groups[name_of_group].
dapat dieksekusi
struct ctx.executable
struct yang berisi file yang dapat dieksekusi yang ditentukan dalam atribut jenis label 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, kolom struct yang sesuai tidak akan dibuat. Lihat contoh penggunaan.
expand_location
string ctx.expand_location(input, targets=[], short_paths=False)
$(location ...) dalam string yang diberikan dengan mengganti $(location //x) dengan jalur file output //x target. Perluasan hanya berfungsi untuk label yang mengarah ke dependensi langsung aturan ini atau yang secara eksplisit tercantum dalam argumen opsional targets. $(location ...) akan menyebabkan error jika target yang direferensikan memiliki beberapa output. Dalam hal ini, gunakan $(locations ...) karena metode ini 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). Pada kasus lain, sering kali lebih baik memanipulasi label secara langsung.
Parameter
| Parameter | Deskripsi |
|---|---|
input
|
wajib String yang akan diperluas. |
targets
|
sequence of Targets;
default = []Daftar target untuk informasi pencarian tambahan. |
short_paths
|
default = Salah Menggunakan jalur relatif root, bukan jalur exec penuh |
None.
expand_make_variables
string ctx.expand_make_variables(attribute_name, command, additional_substitutions)
Menampilkan string setelah meluaskan 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
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 Files. 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
host_configuration
configuration ctx.host_configuration
host_fragments
fragments ctx.host_fragments
info_file
File ctx.info_file
label
Label ctx.label
new_file
File ctx.new_file(var1, var2=unbound, var3=unbound)
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
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
outputsdict, 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.outputthat 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_listthat the rule declares, there is a field whose name is the attribute's name. The field value is a list ofFileobjects 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
executableortest, 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 theexecutablearg 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 = '' Command to resolve. |
attribute
|
string; or None;
default = NoneName 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 = NoneMake 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=[])
(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
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 = []The list of files to be added to the runfiles. |
transitive_files
|
depset of Files; or None;
default = NoneThe (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. |
symlinks
|
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. |
root_symlinks
|
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
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