Baklavalar

7.3 · 7.2 · 7.1 · 7.0 · 6.5

Bir komut satırının bir kısmını veya tamamını oluşturmak için gereken verileri bellek açısından verimli bir şekilde kapsayan bir nesne.

Bir işlem için genellikle geçişli bağımlılıklardan toplanan değerleri içeren büyük bir komut satırı gerekir. Örneğin, bir bağlayıcı komut satırı, bağlanan tüm kitaplıkların ihtiyaç duyduğu her nesne dosyasını listeleyebilir. Bu tür geçişli verileri birden fazla hedef tarafından paylaşılabilmesi için depset'lerde depolamak en iyi uygulamadır. Ancak kural yazarının bir işlem komut satırı oluşturmak için bu depset'leri dize listelerine dönüştürmesi gerekirse bu bellek paylaşımı optimizasyonu geçersiz olur.

Bu nedenle, işlem oluşturan işlevler dizelere ek olarak Args nesnelerini de kabul eder. Her Args nesnesi, verileri değiştirmek için isteğe bağlı dönüşümler içeren dize ve depset dizilişi temsil eder. Args nesneleri, komut satırının hesaplanması zamanı geldiğinde yürütme aşamasına kadar içerdikleri belgeleri işlemez. Böylece, pahalı kopyalama işlemleri analiz aşaması tamamlanana kadar ertelenir. Daha fazla bilgi için Performansı Optimize Etme sayfasına bakın.

Args, ctx.actions.args() çağrılarak oluşturulur. Bunlar, ctx.actions.run() veya ctx.actions.run_shell() için arguments parametresi olarak iletilebilir. Bir Args nesnesinin her mutasyonu, nihai komut satırına değer ekler.

map_each özelliği, öğelerin dizelere nasıl dönüştürüleceğini özelleştirmenize olanak tanır. map_each işlevi sağlamazsanız standart dönüşüm aşağıdaki gibi olur:

  • Zaten dize olan değerler olduğu gibi bırakılır.
  • File nesneleri, File.path değerlerine dönüştürülür.
  • Label nesneleri, ana depo bağlamında çözümlendiğinde aynı nesneye çözümlenen bir dize gösterimine dönüştürülür. Mümkünse dize temsilinde, deposunun kanon adı yerine deposunun görünen adı kullanılır. Bu, söz konusu temsilin BUILD dosyalarında kullanılmasına olanak tanır. Temsil biçiminin tam olarak ne olacağı garanti edilmez. Bununla birlikte, //foo:bar, @repo//foo:bar ve @@canonical_name~//foo:bar.bzl tipik örneklerdir.
  • Diğer tüm türler belirtilmemiş bir şekilde dizelere dönüştürülür. Bu nedenle, dize veya File türü dışındaki değerleri add()'a göndermekten kaçınmalısınız. Bu tür değerleri add_all() veya add_joined()'a gönderirseniz bir map_each işlevi sağlamanız gerekir.

Dize biçimlendirmesi (add*() yöntemlerinin format, format_each ve format_joined parametreleri) kullanıldığında, biçim şablonu dizelerdeki % yerine koyma işleviyle aynı şekilde yorumlanır. Tek fark, şablonun tam olarak bir yer tutucu içermesi ve bu yer tutucunun %s olmasıdır. Değişmez yüzdeler %% olarak kaçış karakteri ile kullanılabilir. Biçimlendirme, değer yukarıda belirtildiği gibi bir dizeye dönüştürüldükten sonra uygulanır.

add*() yöntemlerinin her biri, ek bir konumsal parametre (diğer bağımsız değişkenlerden önce eklenecek bir "arg name" dizesi) kabul eden alternatif bir forma sahiptir. add_all ve add_joined için, dizi boşsa ek dize eklenmez. Örneğin, aynı kullanım, belirli bir dizinin val1..val3 içerip içermediğine veya boş olup olmadığına bağlı olarak komut satırına --foo val1 val2 val3 --bar veya yalnızca --bar ekleyebilir.

Komut satırının boyutu, sistem tarafından izin verilen maksimum boyuttan daha uzun olabilir. Bu durumda bağımsız değişkenler parametre dosyalarına aktarılabilir. use_param_file() ve set_param_file_format() başlıklı makaleleri inceleyin.

Örnek: Şu komut satırını oluşturmak istediğimizi varsayalım: 

--foo foo1.txt foo2.txt ... fooN.txt --bar bar1.txt,bar2.txt,...,barM.txt --baz
Şu Args nesnesini kullanabiliriz: 
# foo_deps and bar_deps are depsets containing
# File objects for the foo and bar .txt files.
args = ctx.actions.args()
args.add_all("--foo", foo_deps)
args.add_joined("--bar", bar_deps, join_with=",")
args.add("--baz")
ctx.actions.run(
  ...
  arguments = [args],
  ...
)

Üyeler

add

Args Args.add(arg_name_or_value, value=unbound, *, format=None)

Bu komut satırına bir bağımsız değişken ekler.

Parametreler

Parametre Açıklama
arg_name_or_value required
İki konumsal parametre iletilirse bu, arg adı olarak yorumlanır. Bağımsız değişken adı, herhangi bir işlem yapılmadan değerin önüne eklenir. Yalnızca bir konumsal parametre iletilirse bu parametre value olarak yorumlanır (aşağıya bakın).
value varsayılan değer unbound
Eklenecek nesne. Yukarıda belirtilen standart dönüşüm kullanılarak bir dizeye dönüştürülür. Bu işlev için map_each parametresi olmadığından value bir dize veya File olmalıdır. Bu yöntem yerine add_all() veya add_joined()'e bir liste, tuple, depset veya dizin File gönderilmelidir.
format dize veya None; varsayılan değer None
value değerinin dize haline getirilmiş sürümüne uygulanacak bir biçim dizesi kalıbı.

add_all

Args Args.add_all(arg_name_or_values, values=unbound, *, map_each=None, format_each=None, before_each=None, omit_if_empty=True, uniquify=False, expand_directories=True, terminate_with=None, allow_closure=False)

Bu komut satırına birden fazla bağımsız değişken ekler. Öğeler, yürütme aşamasında yavaşça işlenir.

İşlemenin çoğu, aşağıdaki adımlara göre eklenecek bağımsız değişkenler listesi üzerinde gerçekleşir:

  1. Her dizin File öğesi, söz konusu dizinde yinelenen şekilde bulunan tüm File öğeleriyle değiştirilir.
  2. map_each sağlanırsa her öğeye uygulanır ve elde edilen dize listeleri, ilk bağımsız değişken listesini oluşturmak için birleştirilir. Aksi takdirde, ilk bağımsız değişken listesi, standart dönüşümün her öğeye uygulanmasının sonucudur.
  3. Listede bulunan her bağımsız değişken (varsa) format_each ile biçimlendirilir.
  4. uniquify doğruysa yinelenen bağımsız değişkenler kaldırılır. İlk kullanım kalır.
  5. Bir before_each dizesi sağlanırsa listedeki mevcut her bağımsız değişkenin önüne yeni bir bağımsız değişken olarak eklenir. Bu, bu noktaya kadar eklenecek bağımsız değişken sayısını etkili bir şekilde ikiye katlar.
  6. Listenin boş olması ve omit_if_empty değerinin true (varsayılan) olması dışında, arg adı ve terminate_with (varsa) sırasıyla ilk ve son bağımsız değişken olarak eklenir.
Boş dizelerin, tüm bu işleme adımlarına tabi olan geçerli bağımsız değişkenler olduğunu unutmayın.

Parametreler

Parametre Açıklama
arg_name_or_values required
İki konumsal parametre iletilirse bu, arg adı olarak yorumlanır. Bağımsız değişken adı, values öğesinden önce, herhangi bir işlem yapılmadan ayrı bir bağımsız değişken olarak eklenir. omit_if_empty doğruysa (varsayılan) ve başka öğe eklenmezse (values boşsa veya tüm öğeleri filtrelenirse olduğu gibi) bu bağımsız değişken adı eklenmez. Yalnızca bir konum parametresi iletilirse values olarak yorumlanır (aşağıya bakın).
values sequence veya depset; varsayılan değer unbound
Öğelerinin ekleneceği liste, tuple veya depset.
map_each çağrılabilir; veya None; varsayılan değer None
Her öğeyi sıfır veya daha fazla dizeye dönüştüren bir işlevdir. Bu işlev, eklenmeden önce daha fazla işlenebilir. Bu parametre sağlanmazsa standart dönüşüm kullanılır.

İşleve bir veya iki konumsal bağımsız değişken iletilir: dönüştürülecek öğe ve ardından isteğe bağlı bir DirectoryExpander. İkinci bağımsız değişken yalnızca sağlanan işlev kullanıcı tanımlıysa (yerleşik değilse) ve birden fazla parametre tanımlamışsa iletilir.

Döndürülen değerin türü, öğe için kaç bağımsız değişkenin oluşturulacağına bağlıdır:

  • Her öğenin tek bir dizeye dönüştüğü yaygın durumda işlev bu dizeyi döndürmelidir.
  • Öğe tamamen filtrelenecekse işlev None değerini döndürmelidir.
  • Öğe birden fazla dizeye dönüşürse işlev bu dizelerin listesini döndürür.
Tek bir dize veya None döndürmek, sırasıyla 1 veya 0 uzunluğunda bir liste döndürmekle aynı etkiye sahiptir. Ancak, gerekli olmayan bir liste oluşturmamak için daha verimli ve okunabilir olur.

Normalde, dizin olan öğeler expand_directories=True ayarlandığında otomatik olarak içeriklerine genişletilir. Ancak bu işlem, diğer değerlerin içinde bulunan dizinleri genişletmez. Örneğin, öğeler alan olarak dizin içeren yapılardır. Bu durumda, belirli bir dizinin dosyalarını manuel olarak almak için DirectoryExpander bağımsız değişkeni uygulanabilir.

Analiz aşamasındaki büyük veri yapılarının yürütme aşamasında istenmeden tutulmasını önlemek için map_each işlevi üst düzey bir def ifadesiyle tanımlanmalıdır; varsayılan olarak iç içe yerleştirilmiş bir işlev kapatma olamaz.

Uyarı: map_each çağrısı sırasında yürütülen print() ifadeleri görünür bir çıkış oluşturmaz.

format_each dize; veya None; varsayılan olarak None
İsteğe bağlı bir biçim dizesi kalıbı. map_each işlevi tarafından döndürülen her dizeye uygulanır. Biçim dizesinde tam olarak bir tane "%s" yer tutucu olmalıdır.
before_each dize; veya None; varsayılan değer None
values kaynağından türetilen her bağımsız değişken eklenmeden önce eklenecek isteğe bağlı bir bağımsız değişken.
omit_if_empty varsayılan değer True olur
True (doğru) değerine ayarlanırsa values kaynağından türetilmiş hiçbir bağımsız değişken yoksa diğer tüm işlemler atlanır ve komut satırında değişiklik olmaz. Yanlış değerine ayarlanırsa bağımsız değişken adı ve sağlandığı takdirde terminate_with, başka bağımsız değişken olup olmadığına bakılmaksızın yine eklenir.
uniquify varsayılan değer False
Doğru ise values öğesinden türetilen yinelenen bağımsız değişkenler atlanır. Her bağımsız değişkenin yalnızca ilk örneği kalır. Depset'ler zaten yinelenenleri atladığı için genellikle bu özelliğe ihtiyaç duyulmaz ancak map_each birden fazla öğe için aynı dizeyi gönderiyorsa bu özellik yararlı olabilir.
expand_directories varsayılan değer True
Değer true ise values içindeki tüm dizinler düz bir dosya listesine genişletilir. Bu, map_each uygulanmadan önce gerçekleşir.
terminate_with dize; veya None; varsayılan değer None
Diğer tüm bağımsız değişkenlerden sonra eklenecek isteğe bağlı bir bağımsız değişken. omit_if_empty doğruysa (varsayılan) ve başka öğe eklenmezse (values boşsa veya tüm öğeleri filtrelenirse olduğu gibi) bu bağımsız değişken eklenmez.
allow_closure varsayılan değer False şeklindedir
True (doğru) ise map_each gibi işlev parametrelerinde kapanışların kullanılmasına izin verir. Genellikle bu gerekli değildir ve analiz aşamasındaki büyük veri yapılarını yürütme aşamasında tutma riskini alır.

add_joined

Args Args.add_joined(arg_name_or_values, values=unbound, *, join_with, map_each=None, format_each=None, format_joined=None, omit_if_empty=True, uniquify=False, expand_directories=True, allow_closure=False)

Ayırıcı kullanarak birden fazla değeri birleştirerek bu komut satırına bir bağımsız değişken ekler. Öğeler, yürütme aşamasında yavaşça işlenir.

İşleme, add_all() işlevine benzer ancak values bağımsız değişkeninden türetilen bağımsız değişken listesi, join_with.join(...) işlevi gibi tek bir bağımsız değişkende birleştirilir ve ardından belirtilen format_joined dize şablonu kullanılarak biçimlendirilir. Öğeler tek bir bağımsız değişkende birleştirildiğinde genellikle kullanışlı olmadıkları için add_all() parametresinden farklı olarak before_each veya terminate_with parametresi yoktur.

Filtreleme işleminden sonra bir bağımsız değişkene birleştirilecek dize yoksa ve omit_if_empty doğruysa (varsayılan) herhangi bir işlem yapılmaz. Aksi takdirde, birleştirilecek dize yoksa ancak omit_if_empty yanlışsa birleştirilen dize boş bir dize olur.

Parametreler

Parametre Açıklama
arg_name_or_values required
İki konumsal parametre iletilirse bu, arg adı olarak yorumlanır. Arg adı, herhangi bir işlem yapılmadan values öğesinden önce eklenir. omit_if_empty doğruysa (varsayılan) ve values'ten birleştirilecek dize yoksa (values boşsa veya tüm öğeleri filtrelenmişse bu durum oluşabilir) bu bağımsız değişken eklenmez. Yalnızca bir konum parametresi iletilirse values olarak yorumlanır (aşağıya bakın).
values sequence veya depset; varsayılan değer unbound
Öğeleri birleştirilecek liste, tuple veya depset.
join_with gerekli
string.join() ile aynı şekilde, map_each ve format_each uygulanarak elde edilen dizeleri birleştirmek için kullanılan ayırıcı dize.
map_each çağrılabilir; veya None; varsayılan değer None
add_all ile aynıdır.
format_each dize veya None; varsayılan değer None
add_all ile aynıdır.
format_joined dize; veya None; varsayılan değer None
Birleştirilen dizeye uygulanan isteğe bağlı bir biçim dizesi kalıbı. Biçim dizesinde tam olarak bir tane "%s" yer tutucusu olmalıdır.
omit_if_empty varsayılan değer True
Doğruysa ve birleştirilecek dize yoksa (values boş olduğu veya tüm öğeleri filtrelendiği için) diğer tüm işlemler atlanır ve komut satırı değişmez. Yanlış ise birleştirilecek dize olmasa bile iki bağımsız değişken eklenir: bağımsız değişken adı ve ardından boş bir dize (sıfır dizelerin mantıksal birleşimi).
uniquify varsayılan değer False
add_all ile aynıdır.
expand_directories varsayılan değer True
add_all ile aynıdır.
allow_closure varsayılan değer False
add_all ile aynıdır.

set_param_file_format

Args Args.set_param_file_format(format)

Kullanılıyorsa parametre dosyasının biçimini ayarlar

Parametreler

Parametre Açıklama
format required
Şu değerlerden biri olmalıdır:
  • "multiline": Her öğe (bağımsız değişken adı veya değeri), param dosyasına aynen yazılır ve ardından yeni satır karakteri eklenir.
  • "shell": "multiline" ile aynıdır ancak öğeler kabuk tırnak içine alınır
  • "flag_per_line": "multiline" ile aynıdır ancak (1) parametre dosyasına yalnızca işaretler ("--" ile başlayan) yazılır ve (2) varsa işaretlerin değerleri aynı satıra "=" ayırıcıyla yazılır. Abseil bayrakları kitaplığı tarafından beklenen biçim budur.

Çağırılmazsa biçim varsayılan olarak "shell" olur.

use_param_file

Args Args.use_param_file(param_file_arg, *, use_always=False)

Arg'leri bir params dosyasına aktarır ve bunları param dosyasına işaret eden bir işaretçiyle değiştirir. args parametreniz sistemdeki komut uzunluğu sınırları için çok büyük olabileceğinde kullanın.

Bazel, verimlilik için yürütme sırasında params dosyasının çıkış ağacına yazılmasını atlayabilir. İşlemlerde hata ayıklıyor ve parametre dosyasını incelemek istiyorsanız --materialize_param_files öğesini derlemenize iletin.

Parametreler

Parametre Açıklama
param_file_arg required
Tek bir "%s" içeren bir biçim dizesi. args bir params dosyasına dökülürse params dosyasının yoluyla biçimlendirilmiş bu dizeden oluşan bir bağımsız değişkenle değiştirilir.

Örneğin, bağımsız değişkenler "params.txt" adlı bir parametre dosyasına dökülürse "--file=%s" belirtildiğinde işlem komut satırında "--file=params.txt" yer alır.

use_always varsayılan değer False
Parametrelerin her zaman bir parametreler dosyasına aktarılıp aktarılmayacağını belirtir. Yanlış ise bazel, sisteminize ve arg uzunluğuna göre bağımsız değişkenlerin dökülmesi gerekip gerekmediğine karar verir.