işlemler

7.3 · 7.2 · 7.1 · 7.0 · 6.5

İşlem oluşturmak için işlevler sağlayan modül. Bu modüle ctx.actions adresinden erişebilirsiniz.

Üyeler

args

Args actions.args()

Bellek açısından verimli komut satırları oluşturmak için kullanılabilecek bir Args nesnesi döndürür.

declare_directory

File actions.declare_directory(filename, *, sibling=None)

Kuralın veya özelliğin, geçerli pakette belirtilen ada sahip bir dizin oluşturduğunu belirtir. Dizini oluşturan bir işlem oluşturmanız gerekir. Dizinin içeriğine Starlark'tan doğrudan erişilemez ancak 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)

Kuralın veya özelliğin, belirtilen dosya adıyla bir dosya oluşturduğunu belirtir. 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. 

File actions.declare_symlink(filename, *, sibling=None)

Kuralın veya özelliğin, geçerli pakette belirtilen adla bir sembolik bağlantı oluşturduğunu belirtir. Bu sembolik bağlantıyı oluşturan bir işlem oluşturmanız gerekir. Bazel bu sembolik bağlantının referansını hiçbir zaman kaldırmaz ve tam olarak korumalı alanlara veya uzaktan yürütücülere aktarır. Ağ yapıları içindeki sembolik bağlantılar şu anda desteklenmiyor.

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=[])

Ne komut yürüten ne de çıkış oluşturan ancak "ek işlemler" eklemek için yararlı olan boş bir işlem oluşturur.

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)

Şablon genişletme işlemi oluşturur. İşlem yürütüldüğünde, şablona dayalı bir dosya oluşturulur. Şablonun bazı bölümleri, değişikliklerin belirtildiği sırayla 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)

Yürütülebilir dosya çalıştıran bir işlem oluşturur. Kullanım örneğini inceleyin.

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 use_default_shell_env hem de env, True olarak ayarlanırsa env ürününde ayarlanan değerler, --incompatible_merge_fixed_and_default_shell_env etkinse varsayılan kabuk ortamının üzerine yazılır. İşaret etkinleştirilmezse env yoksayılır.

env dict veya None; varsayılan değer None
Ortam değişkenleri sözlüğünü ayarlar.

Hem use_default_shell_env hem de env True olarak ayarlanırsa --incompatible_merge_fixed_and_default_shell_env etkinse (varsayılan) env'te ayarlanan değerler varsayılan kabuk ortamının üzerine yazılır. Bayrak etkinleştirilmezse env yoksayılır.

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:

  • "cpu": CPU sayısı; varsayılan 1
  • "memory": MB cinsinden; varsayılan 250
  • "local_test": yerel testlerin sayısı; varsayılan değer 1

Bu parametre None olarak ayarlanırsa veya --experimental_action_resource_set yanlışsa varsayılan değerler kullanılır.

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)

Kabuk komutu çalıştıran bir işlem oluşturur. Kullanım örneğini inceleyin.

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, $1, $2 vb. kabuk değişkeni ikamelerini kullanarak bu bağımsız değişkenlere erişebilir. Bağımsız değişkenler nesneleri dizine eklenmeden önce düzeltildiğinden, bilinmeyen boyutta bir Args nesnesi varsa sonraki tüm dizelerin tahmin edilemeyen dizinlerde olacağını unutmayın. Belirsiz boyutlu bağımsız değişken nesneleriyle birlikte $@ özelliğinin (tüm bağımsız değişkenleri almak için) kullanılması yararlı olabilir.

command bir dize listesiyse bu parametre kullanılamaz.

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.

command bir dizeyse sh -c <command> "" <arguments> tarafından yürütülür. Yani arguments'deki öğeler komuta $1, $2 (veya Windows toplu komut dosyası kullanılıyorsa %1, %2) vb. olarak sunulur. arguments herhangi bir actions.args() nesnesi içeriyorsa bu nesnelerin içerikleri komut satırına tek tek eklenir. Bu nedenle $i, bir Args nesnesinde ayrı dizeleri referans alabilir. arguments kapsamında bilinmeyen boyuttaki bir Args nesnesi iletilirse dizelerin bilinmeyen dizinlerde olacağını unutmayın. Bu durumda $@ kabuk değiştirme işlemi (tüm bağımsız değişkenleri alma) yararlı olabilir.

(Desteği sonlandırıldı) command bir dize dizisiyse ilk öğe çalıştırılacak yürütülebilir dosya, kalan öğeler ise bu dosyanın bağımsız değişkenleridir. Bu form kullanılırsa arguments parametresi sağlanmamalıdır. Bu formun artık kullanılmadığını ve yakında kaldırılacağını unutmayın. "--inuyumlu_run_shell_command_string" ile devre dışı bırakıldı. Kodunuzun uyumlu olduğunu doğrulamak için bu işareti kullanın.

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 use_default_shell_env hem de env True olarak ayarlanırsa --incompatible_merge_fixed_and_default_shell_env etkinse (varsayılan) env'te ayarlanan değerler varsayılan kabuk ortamının üzerine yazılır. İşaret etkinleştirilmezse env yoksayılır.

env dict; veya None; varsayılan değer None'dir
Ortam değişkenlerinin sözlüğünü ayarlar.

Hem use_default_shell_env hem de env True olarak ayarlanırsa --incompatible_merge_fixed_and_default_shell_env etkinse (varsayılan) env'te ayarlanan değerler varsayılan kabuk ortamının üzerine yazılır. İşaret etkinleştirilmezse env yoksayılır.

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.

 

None actions.symlink(output, target_file=None, target_path=None, is_executable=False, progress_message=None)

Dosya sistemine sembolik bağlantı yazan bir işlem oluşturur.

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 target_path için anlamlı değildir.
progress_message string; veya None; varsayılan olarak None şeklindedir
Derleme sırasında kullanıcıya gösterilecek ilerleme mesajı.

template_dict

TemplateDict actions.template_dict()

Hafıza açısından verimli şablon genişletmesi için bir TemplateDict nesnesi döndürür.

write

None actions.write(output, content, is_executable=False)

Dosya yazma işlemi oluşturur. İşlem yürütüldüğünde, belirtilen içerik bir dosyaya yazılır. Bu, analiz aşamasında bulunan bilgileri kullanarak dosya oluşturmak için kullanılır. Dosya büyükse ve çok fazla statik içerik içeriyorsa 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ğı.