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
- actions
- aspect_ids
- attr
- bin_dir
- build_file_path
- build_setting_value
- konfigurasi
- coverage_instrumented
- created_actions
- disabled_features
- exec_groups
- executable
- expand_location
- expand_make_variables
- fitur
- file
- file
- fragmen
- genfiles_dir
- info_file
- label
- output
- resolve_command
- resolve_tools
- rule
- runfiles
- split_attr
- super
- 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 ke fungsi rule. Lihat contoh penggunaan.
bin_dir
root ctx.bin_dir
build_file_path
string ctx.build_file_path
ctx.label.package + '/BUILD'. Jalur ke file BUILD untuk aturan ini, relatif terhadap root sumber.
build_setting_value
unknown ctx.build_setting_value
build_setting, membaca ini akan menghasilkan error.
konfigurasi
configuration ctx.configuration
coverage_instrumented
bool ctx.coverage_instrumented(target=None)
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 NoneTarget yang menentukan aturan. Jika tidak diberikan, defaultnya adalah aturan saat ini. |
created_actions
StarlarkValue ctx.created_actions()
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
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 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=[])
$(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
|
string;
required String yang akan diperluas. |
targets
|
urutan Target;
default adalah []Daftar target untuk informasi pencarian tambahan. |
None.
expand_make_variables
string ctx.expand_make_variables(attribute_name, command, additional_substitutions)
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
|
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
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
info_file
File ctx.info_file
label
Label ctx.label
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, 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 NoneName of the associated attribute for which to issue an error, or None. |
expand_locations
|
bool;
default is FalseShall we expand $(location) variables? See ctx.expand_location() for more details. |
make_variables
|
dict; or None;
default is NoneMake 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=[])
(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
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 is []The list of files to be added to the runfiles. |
transitive_files
|
depset of Files; or None;
default is 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
|
bool;
default is FalseUse 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 FalseUse 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 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.
|
root_symlinks
|
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
super
unknown ctx.super()
target_platform_has_constraint
bool ctx.target_platform_has_constraint(constraintValue)
Parameters
| Parameter | Description |
|---|---|
constraintValue
|
ConstraintValueInfo;
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
--enable_bzlmod is on, this is the fixed string _main. Otherwise, this is the workspace name as defined in the WORKSPACE file.