Özellikle, uygulama işlevinin mevcut hedefin etiketine, özelliklerine, yapılandırmasına ve bağımlılarının sağlayıcılarına erişmesine olanak tanır. Çıkış dosyalarını ve bunları üreten işlemleri tanımlama yöntemleri vardır.
Bağlam nesneleri, temel olarak uygulama işlevine yapılan çağrı süresince geçerlidir. Bu nesnelere, ilişkili işlevleri dışında erişmek yararlı değildir. Daha fazla bilgi için Kurallar sayfasını inceleyin.
Üyeler
- işlemler
- en_seksi_kimlikleri
- attr
- bin_dir
- build_file_path
- build_setting_value
- yapılandırma
- cover_tooled
- yapılan_işlemler
- varsayılan_sağlayıcı
- devre dışı bırakıldı_özellikleri
- exec_grupları
- yürütülebilir
- genişleme_konumu
- genişletme_değişkeni_değişkenleri
- özellikler
- dosya
- dosyalar
- parçalar
- genfiles_dir
- bilgi_dosyası
- etiket
- yeni_dosya
- çıkışlar
- çözüm_komutu
- çözüm_araçları
- kural
- koşu dosyaları
- bölünmüş_yüzde
- hedef_platform_has_kısıtlama
- araç zincirleri
- var
- sürüm_dosyası
- workspace_name
işlemler
actions ctx.actionsÇıkış dosyalarını ve bunları üreten işlemleri bildirme yöntemlerini içerir.
özellik_kimliği
list ctx.aspect_idsHedefe uygulanan tüm yönler için kimliklerin listesi. Yalnızca en boy uygulama işlevlerinde kullanılabilir.
Attr
struct ctx.attrÖzelliklerin değerlerine erişmek için kullanılan bir yapı. Değerler kullanıcı tarafından sağlanır (sağlanmamışsa varsayılan bir değer kullanılır). Yapının özellikleri ve değer türleri,
rule
işlevine sağlanan attrs
yönergesinin anahtarlarına ve değerlerine karşılık gelir. Kullanım örneğini inceleyin.
bin_dir
root ctx.bin_dirBin dizinine karşılık gelen kök.
derleme_dosyası_yolu
string ctx.build_file_pathKaynak köke göre, bu kural için DERLEME dosyasının yolu.
derleme_ayarı_değeri
unknown ctx.build_setting_valueDeneysel. Bu alan deneyseldir ve herhangi bir zamanda değiştirilebilir. Bu raporu kullanma.
Mevcut hedefin temsil ettiği derleme ayarının değeri. Kural tanımında build_setting
özelliğini ayarlamayan kurallar için bu alana erişilir.
yapılandırma
configuration ctx.configurationVarsayılan yapılandırma. Daha fazla ayrıntı için yapılandırma türüne bakın.
kapsam_uygulandı
bool ctx.coverage_instrumented(target=None)Bu kural için derleme işlemleri yaparken kod kapsamı araçlarının oluşturulması gerekip gerekmediğini veya
target
sağlanıyorsa bu hedef tarafından belirtilen kuralı döndürür. (Kural dışı veya Starlark kuralı sağlandıysa False (Yanlış) değerini döndürür.) Geçerli kuralın kaynaklarının (Hedef sağlanmamışsa) veya Hedef kaynaklarının --toolation_filter ve --tool_test_targets yapılandırma ayarlarına uygun olup olmadığını kontrol eder. Bu, yapılandırmadaki coverage_enabled
ürününden farklıdır. Bu özellik, kapsam veri toplamanın tüm çalıştırma için etkinleştirilip etkinleştirilmediğini belirtir ancak belirli bir hedefin kontrol edilmesi gerekip gerekmediğini gösterir.
Parametreler
Parametre | Açıklama |
---|---|
target
|
Target; or None ;
default = YokBir kural belirten hedef. Bu kural sağlanmazsa varsayılan olarak geçerli kural uygulanır. |
oluşturulan_işlemler
StarlarkValue ctx.created_actions()_skylark_testable ayarı
True
olarak belirlenmiş kurallar için bu, geçerli kurala 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ğeri döndürülür. Sonraki işlemler oluşturulduğunda sağlayıcının güncellenmediğini unutmayın. Bu nedenle, incelemek isterseniz bu işlevi tekrar çağırmanız gerekecektir. Bu bilginin, kural uygulamaya yardımcı işlevlerine yönelik testlerin yazılmasına yardımcı olması amaçlanır. Kurallar,
ctx
nesnesini alıp bu nesnede işlemler oluşturabilir.
varsayılan_sağlayıcı
Provider ctx.default_providerKullanımdan kaldırıldı. Onun yerine DefaultInfo'yu kullanın.
devre dışı_özellikler
list ctx.disabled_featuresBu kural için kullanıcı tarafından açıkça devre dışı bırakılan özellikler grubu.
exec_gruplar
ExecGroupCollection ctx.exec_groupsBu kural için kullanılabilen, adlarına göre dizine eklenen yürütme gruplarının koleksiyonu.
ctx.exec_groups[name_of_group]
ile erişim.
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 bir File
veya None
olur. Kuralda isteğe bağlı bir özellik belirtilmezse karşılık gelen yapı değeri None
olur. Bir etiket türü executable=True
olarak işaretlenmezse, karşılık gelen bir struct alanı oluşturulmaz. Kullanım örneğini inceleyin.
genişlet_konumu
string ctx.expand_location(input, targets=[])
$(location //x)
ifadesini hedef //x çıkış dosyasının yoluyla değiştirerek belirli bir 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. Referans verilen hedefin birden fazla çıkışı varsa
$(location ...)
, hataya neden olur. Bu durumda, çıkış yollarının boşlukla ayrılmış bir listesini oluşturduğundan lütfen $(locations ...)
öğesini kullanın. Tek bir çıkış dosyası için de güvenli bir şekilde kullanılabilir.Bu işlev, kullanıcının bir DERLEME dosyasında bir komut belirtmesine izin vermek açısından faydalıdır (ör.
genrule
). Diğer durumlarda etiketleri doğrudan değiştirmek daha iyidir.
Parametreler
Parametre | Açıklama |
---|---|
input
|
gerekli Genişletilecek dize. |
targets
|
sequence of Targets ;
default = []Ek arama bilgileri için hedef listesi. |
None
iade edilebilir.
değişkenleri genişlet
string ctx.expand_make_variables(attribute_name, command, additional_substitutions)Kullanımdan kaldırıldı. Değişkenlere erişmek için bunun yerine ctx.var işlevini kullanın.
Tüm referansları "Değişkenleri oluştur" ayarına 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.featuresThe set of features that are explicitly enabled by the user for this rule. See example of use.
file
struct ctx.fileA
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.filesA
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 File
s. 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.fragmentsAllows access to configuration fragments in target configuration.
genfiles_dir
root ctx.genfiles_dirThe root corresponding to genfiles directory.
info_file
File ctx.info_fileThe 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.labelThe 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.outputsA 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 correspondingFile
. - 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 correspondingFile
; otherwise the field value isNone
. - 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 ofFile
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
ortest
, 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 theexecutable
arg ofDefaultInfo
.
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 = 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=[])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.ruleRule 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 = 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_attrA 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.toolchainsToolchains for the default exec group of this rule.
var
dict ctx.varDictionary (String to String) of configuration variables.
version_file
File ctx.version_fileThe 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_nameThe workspace name as defined in the WORKSPACE file.