İşlem oluşturmak için işlevler sağlayan modül. Bu modüle ctx.actions
adresinden erişebilirsiniz.
Üyeler
- args
- declare_directory
- declare_file
- declare_symlink
- do_nothing
- expand_template
- koşu
- run_shell
- symlink
- template_dict
- write
args
Args actions.args()
declare_directory
File actions.declare_directory(filename, *, sibling=None)
Args.add_all()
ile bir işlem komutunda genişletilebilir. declare_directory işlevinin genişletilmiş içeriğinde yalnızca normal dosyalar ve dizinler bulunabilir.
Parametreler
Parametre | Açıklama |
---|---|
filename
|
gerekli "Eşdüzey" sağlanmamışsa yeni dizinin, geçerli pakete göre yolu. Aksi takdirde, dosya için temel bir ad ('sibling' bir dizini tanımlar). |
sibling
|
Dosya veya None ;
varsayılan değer None Yeni tanımlanan dizinle aynı dizinde bulunan bir dosya. Dosya, mevcut pakette olmalıdır. |
declare_file
File actions.declare_file(filename, *, sibling=None)
sibling
belirtilmezse dosya adı, paket dizine göreli olur. Aksi takdirde dosya, sibling
ile aynı dizinde olur. Dosyalar mevcut paketin dışında oluşturulamaz.Bir dosyayı bildirmeye ek olarak, dosyayı yayınlayan bir işlem de oluşturmanız gerektiğini unutmayın. Bu işlemin oluşturulması, döndürülen File
nesnesinin işlemin oluşturma işlevine iletilmesini gerektirir.
Önceden tanımlanmış çıkış dosyalarının bu işlev kullanılarak tanımlanması gerekmez (ve tanımlanamaz). Bunun yerine, File
nesnelerini ctx.outputs
adresinden alabilirsiniz. Kullanım örneğini inceleyin.
Parametreler
Parametre | Açıklama |
---|---|
filename
|
zorunlu "Kardeş" sağlanmazsa yeni dosyanın mevcut pakete göre yolu. Aksi takdirde, bir dosyanın temel adı ("kardeş" bir dizini belirler). |
sibling
|
Dosya veya None ;
varsayılan olarak None 'dır.Yeni oluşturulan dosyayla aynı dizinde bulunan bir dosyadır. Dosya, mevcut pakette olmalıdır. |
declare_symlink
File actions.declare_symlink(filename, *, sibling=None)
Parametreler
Parametre | Açıklama |
---|---|
filename
|
zorunlu "Kardeş" sağlanmazsa yeni sembolik bağlantının mevcut pakete göre yolu. Aksi takdirde, dosya için temel bir ad ('sibling' bir dizini tanımlar). |
sibling
|
Dosya veya None ;
varsayılan değer None Yeni tanımlanan sembolik bağlantıyla aynı dizinde bulunan bir dosya. |
do_nothing
None
actions.do_nothing(mnemonic, inputs=[])
Parametreler
Parametre | Açıklama |
---|---|
mnemonic
|
required İşlemin tek kelimelik açıklaması (ör. CppCompile veya GoLink). |
inputs
|
Dosya dizisi veya depset;
varsayılan değer [] İşlemin giriş dosyalarının listesi. |
expand_template
None
actions.expand_template(template, output, substitutions={}, is_executable=False, computed_substitutions=unbound)
substitutions
sözlüğü kullanılarak değiştirilecek. Şablonda bir sözlük anahtarı göründüğünde (veya önceki bir değiştirme işleminin sonucunda), söz konusu anahtar ilişkili değerle değiştirilir. Anahtarlar için özel bir söz dizimi yoktur. Örneğin, çakışmaları önlemek için köşeli parantez kullanabilirsiniz (ör. {KEY}
). Kullanım örneğine bakın.
Parametreler
Parametre | Açıklama |
---|---|
template
|
zorunlu UTF-8 olarak kodlanmış bir metin dosyası olan şablon dosyası. |
output
|
zorunlu UTF-8 olarak kodlanmış bir metin dosyası olan çıkış dosyası. |
substitutions
|
varsayılan değer {} Şablon genişletilirken yapılacak ikameler. |
is_executable
|
varsayılan değer False Çıkış dosyasının yürütülebilir olup olmayacağı. |
computed_substitutions
|
TemplateDict;
varsayılan olarak unbound şeklindedirŞablon genişletilirken yapılacak değişiklikler. |
run
None
actions.run(outputs, inputs=[], unused_inputs_list=None, executable, tools=unbound, arguments=[], mnemonic=None, progress_message=None, use_default_shell_env=False, env=None, execution_requirements=None, input_manifests=None, exec_group=None, shadowed_action=None, resource_set=None, toolchain=unbound)
Parametreler
Parametre | Açıklama |
---|---|
outputs
|
Dosya dizisi;
zorunlu İşlemin çıkış dosyalarının listesi. |
inputs
|
Files'ın sequence veya depset;
varsayılan olarak [] İşlemin giriş dosyalarının listesi veya dökümü. |
unused_inputs_list
|
Dosya veya None ;
varsayılan değer None İşlem tarafından kullanılmayan girişlerin listesini içeren dosya. Bu dosyanın içeriği (genellikle işlemin çıkışlarından biri), işlemin tamamı sırasında kullanılmayan giriş dosyalarının listesine karşılık gelir. Bu dosyalarda yapılan değişiklikler, eylemin sonuçlarını hiçbir şekilde etkilememelidir. |
executable
|
Dosya; veya dize; veya FilesToRunProvider;
zorunlu İşlem tarafından çağrılacak yürütülebilir dosya. |
tools
|
sequence veya depset;
varsayılan değer unbound İşlemin ihtiyaç duyduğu tüm araçların listesi veya depset. Araçlar, işlem için otomatik olarak kullanıma sunulan ek çalıştırma dosyalarına sahip girişlerdir. Sağlanan liste, heterojen bir dosya koleksiyonu, FilesToRunProvider örnekleri veya dosya depsetleri olabilir. Doğrudan listede bulunan ve ctx.executable kaynağından gelen dosyaların çalıştırma dosyaları otomatik olarak eklenir. Sağlanan depset yalnızca Dosya içermelidir. Her iki durumda da, depsets içindeki dosyalara çalıştırma dosyaları için ctx.executable ile çapraz referans verilmez. |
arguments
|
sequence;
varsayılan değer [] İşlemin komut satırı bağımsız değişkenleri. Dize veya actions.args() nesneleri listesi olmalıdır.
|
mnemonic
|
dize; veya None ;
varsayılan değer None 'dirİşlemin tek kelimelik bir açıklamasıdır (ör. CppCompile veya GoLink). |
progress_message
|
dize; veya None ;
varsayılan değer None Derleme sırasında kullanıcıya gösterilecek ilerleme mesajı (ör. "foo.o oluşturmak için foo.cc derleniyor"). İleti, sırasıyla etiket dizesi, ilk giriş veya çıkışın yolu ile değiştirilen %{label} , %{input} veya %{output} kalıpları içerebilir. Statik dizeler yerine daha verimli olan kalıpları tercih edin.
|
use_default_shell_env
|
varsayılan değer False İşlemin, işletim sistemine bağlı birkaç değişkenin yanı sıra --action_env aracılığıyla ayarlanan değişkenlerden oluşan varsayılan kabuk ortamını kullanıp kullanmayacağı.Hem |
env
|
dict veya None ;
varsayılan değer None Ortam değişkenleri sözlüğünü ayarlar. Hem |
execution_requirements
|
dict veya None ;
varsayılan değer None İşlemi planlamayla ilgili bilgiler. Faydalı anahtarlar için etiketlere bakın. |
input_manifests
|
sequence; veya None ;
varsayılan değer None (Deneysel) giriş çalıştırma dosyası meta verilerini ayarlar; bunlar genellikle resolve_command tarafından oluşturulur. |
exec_group
|
dize; veya None ;
varsayılan değer None İşlemi, belirtilen yönetici grubunun yürütme platformunda çalıştırır. Hiçbiri belirtilmezse hedefin varsayılan yürütme platformu kullanılır. |
shadowed_action
|
İşlem;
varsayılan değer None İşlemi, belirtilen gölgelenen işlemin girişlerini ve işlemin girişler listesine ve ortamına eklenen ortamı kullanarak çalıştırır. İşlem ortamı, gölgelendirilen işlemin ortam değişkenlerinin üzerine yazabilir. Aksi takdirde yalnızca işlemin girişlerini ve belirtilen ortamı kullanır. |
resource_set
|
çağrılabilir; veya None ;
varsayılan olarak None Bu işlem yerel olarak çalıştırılırsa yürütme sırasındaki kaynak kullanımını tahmin etmek için kullanılan, bir kaynak kümesi sözlüğü döndüren geri çağırma işlevi. İşlev iki konumsal bağımsız değişkeni kabul eder: işletim sistemi adını temsil eden bir dize (ör. "osx") ve işleme verilen girişlerin sayısını temsil eden bir tam sayı. Döndürülen sözlük, her biri float veya int türünde olabilecek aşağıdaki girişleri içerebilir:
Bu parametre Geri çağırma üst düzey olmalıdır (lambda ve iç içe işlevlere izin verilmez). |
toolchain
|
Etiket; veya dize; veya None ;
varsayılan değer unbound Bu işlemde kullanılan yürütülebilir dosyanın veya araçların araç zinciri türü. İşlemin doğru yürütme platformunda yürütülebilmesi için parametre ayarlanmalıdır. Bu özellik şu anda işlem gerektirmemektedir, ancak gelecekteki Bazel sürümlerinde gerekli olacağı için araç zinciri kullanıldığında bunu ayarlamanızı öneririz. Bu işlemi oluşturan kuralın, "rule()" işlevinde bu araç zincirini tanımlaması gerektiğini unutmayın. "toolchain" ve "exec_group" parametrelerinin ikisi de ayarlandığında "exec_group" kullanılır. "exec_group" aynısını belirtmezse hata oluşur. |
run_shell
None
actions.run_shell(outputs, inputs=[], tools=unbound, arguments=[], mnemonic=None, command, progress_message=None, use_default_shell_env=False, env=None, execution_requirements=None, input_manifests=None, exec_group=None, shadowed_action=None, resource_set=None, toolchain=unbound)
Parametreler
Parametre | Açıklama |
---|---|
outputs
|
Dosya dizisi;
zorunlu İşlemin çıkış dosyalarının listesi. |
inputs
|
Dosya dizisi veya depset;
varsayılan değer [] İşlemin giriş dosyalarının listesi veya depset. |
tools
|
Dosya dizisi veya depset;
varsayılan olarak unbound İşlemin ihtiyaç duyduğu tüm araçların listesi veya depset. Araçlar, işleme otomatik olarak sunulan ek çalıştırma dosyalarına sahip girişlerdir. Liste, Files veya FilesToRunProvider örnekleri içerebilir. |
arguments
|
sequence;
varsayılan değer [] İşlemin komut satırı bağımsız değişkenleri. Dizelerin veya actions.args() nesnelerinin listesi olmalıdır.Bazel, bu özellikteki öğeleri komuta bağımsız değişken olarak iletir. Komut,
|
mnemonic
|
dize; veya None ;
varsayılan değer None 'dirİşlemin tek kelimelik bir açıklamasıdır (ör. CppCompile veya GoLink). |
command
|
dize veya dize dizisi;
zorunlu Yürütülecek Shell komutu. Bu, bir dize (tercih edilir) veya dize dizisi (kullanımdan kaldırılmıştır) olabilir.
(Desteği sonlandırıldı) Bazel, komutu yürütmek için genrules ile aynı kabuğu kullanır. |
progress_message
|
dize; veya None ;
varsayılan değer None Derleme sırasında kullanıcıya gösterilecek ilerleme mesajı (ör. "foo.o oluşturmak için foo.cc derleniyor"). İleti, sırasıyla etiket dizesi, ilk giriş veya çıkışın yolu ile değiştirilen %{label} , %{input} veya %{output} kalıpları içerebilir. Statik dizeler yerine daha verimli olan kalıpları tercih edin.
|
use_default_shell_env
|
varsayılan değer False 'tir.İşlemin, işletim sistemine bağlı birkaç değişkenden ve --action_env aracılığıyla ayarlanan değişkenlerden oluşan varsayılan kabuk ortamını kullanıp kullanmayacağıdır.Hem |
env
|
dict; veya None ;
varsayılan değer None 'dirOrtam değişkenlerinin sözlüğünü ayarlar. Hem |
execution_requirements
|
dict veya None ;
varsayılan değer None İşlemi planlamayla ilgili bilgiler. Faydalı anahtarlar için etiketlere bakın. |
input_manifests
|
sequence veya None ;
varsayılan olarak None şeklindedir(Deneysel), giriş çalıştırma dosyaları meta verilerini ayarlar. Bu meta veriler genellikle çözümleme_komutu tarafından oluşturulur. |
exec_group
|
dize; veya None ;
varsayılan değer None İşlemi, belirtilen yönetici grubunun yürütme platformunda çalıştırır. Yoksa hedefin varsayılan yürütme platformunu kullanır. |
shadowed_action
|
İşlem;
varsayılan değer None İşlemi, işlemin girişler listesine eklenen belirli gölgelenen işlemin keşfedilen girişlerini kullanarak çalıştırır. Aksi takdirde yalnızca işlemin girişlerini kullanır. |
resource_set
|
callable; veya None ;
varsayılan değer None Yerel olarak çalıştırıldığında kaynak kullanımını tahmin etmek için bir geri çağırma işlevi. ctx.actions.run() adresine göz atın.
|
toolchain
|
Etiket; veya dize; veya None ;
varsayılan değer unbound Yürütülebilir dosyanın veya bu işlemde kullanılan araçların araç zinciri türü. İşlemin doğru yürütme platformunda yürütülebilmesi için parametre ayarlanmalıdır. Bu özellik şu anda işlem gerektirmemektedir, ancak gelecekteki Bazel sürümlerinde gerekli olacağı için araç zinciri kullanıldığında bunu ayarlamanızı öneririz. Bu işlemi oluşturan kuralın, "rule()" işlevinde bu araç zincirini tanımlaması gerektiğini unutmayın. Hem "toolchain" hem de "exec_group" parametreleri ayarlandığında "exec_group" kullanılır. "exec_group" aynı araç setini belirtmezse hata oluşur. |
sembolik bağlantı
None
actions.symlink(output, target_file=None, target_path=None, is_executable=False, progress_message=None)
Bu işlev, target_file
veya target_path
özelliklerinden tam olarak biri belirtilmiş şekilde çağrılmalıdır.
target_file
kullanırken output
'u declare_file()
veya declare_directory()
ile tanımlayın ve target_file
türünü eşleyin. Bu işlem, sembolik bağlantının target_file
'e işaret etmesini sağlar. Bazel, sembolik bağlantının hedefi veya içeriği değiştiğinde bu işlemin çıktısını geçersiz kılar.
Aksi takdirde, target_path
kullanırken output
'ü declare_symlink()
ile belirtin. Bu durumda, sembolik bağlantı target_path
'ü işaret eder. Bazel, sembolik bağlantıyı hiçbir zaman çözmez ve bu işlemin çıkışı yalnızca sembolik bağlantının metin içeriği (yani readlink()
değeri) değiştiğinde geçersiz kılınır. Özellikle, boş bir sembolik bağlantı oluşturmak için kullanılabilir.
Parametreler
Parametre | Açıklama |
---|---|
output
|
gerekli Bu işlemin sonucu. |
target_file
|
Dosya veya None ;
varsayılan değer None Çıkış sembolik bağlantısının işaret edeceği dosya. |
target_path
|
dize veya None ;
varsayılan değer None Çıkış sembolik bağlantısının işaret edeceği tam yol. Normalleştirme veya başka bir işlem uygulanmaz. |
is_executable
|
varsayılan değer False Yalnızca target_file ile kullanılabilir, target_path ile kullanılamaz. Doğru ise işlem yürütüldüğünde target_file 'nin yürütülebilir olup olmadığını doğrulamak için yolu kontrol edilir ve yürütülebilir değilse hata bildirilir. is_executable değerinin False olarak ayarlanması, hedefin yürütülemeyeceği anlamına gelmez. Yalnızca doğrulama yapılmadığı anlamına gelir.Yapım sırasında boş sembolik bağlantılar bulunmayabileceği için bu özellik |
progress_message
|
string; veya None ;
varsayılan olarak None şeklindedirDerleme sırasında kullanıcıya gösterilecek ilerleme mesajı. |
template_dict
TemplateDict actions.template_dict()
write
None
actions.write(output, content, is_executable=False)
expand_template
kullanmayı düşünebilirsiniz.
Parametreler
Parametre | Açıklama |
---|---|
output
|
required Çıkış dosyası. |
content
|
dize veya Args;
zorunlu dosyanın içeriği. Dize veya actions.args() nesnesi olabilir.
|
is_executable
|
varsayılan değer False Çıkış dosyasının yürütülebilir olup olmayacağı. |