Baklavalar

. Sorun bildirin Kaynağı göster Gece · 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 belleği verimli bir şekilde kapsayan nesne.

Genellikle bir işlem, geçişli bağımlılıklardan toplanan değerleri içeren büyük bir komut satırı gerektirir. Örneğin, bir bağlayıcı komut satırı, bağlanan tüm kitaplıkların ihtiyaç duyduğu her nesne dosyasını listeleyebilir. En iyi uygulama, bu tür geçişli verilerin birden fazla hedef tarafından paylaşılabilmesi için depset'larda depolanmasıdır. Ancak, kural yazarının bir işlem komut satırı oluşturmak için bu ayrıntılı bölümleri dize listelerine dönüştürmesi gerektiyse bu, bellek paylaşımı optimizasyonunu geçersiz kılar.

Bu nedenle, işlem oluşturma işlevleri dizelere ek olarak Args nesneleri de kabul eder. Her Args nesnesi, verileri değiştirmek için isteğe bağlı dönüşümlerle birlikte dizelerin ve derinlerin birleşimini temsil eder. Args nesneleri, komut satırının hesaplanması zamanı geldiğinde yürütme aşamasına kadar içerdikleri depoları işlemez. Böylece, pahalı kopyalama işlemleri analiz aşaması tamamlanana kadar ertelenir. Daha fazla bilgi için Performansı Optimize Etme sayfasına bakabilirsiniz.

Args, ctx.actions.args() çağrısı yapılarak oluşturulur. Bunlar, ctx.actions.run() veya ctx.actions.run_shell() öğesinin 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ştirmenizi sağlar. 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 nesne, 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 gösterimi, bir deponun görünen adını kullanarak deponun standart adını kullanır. Bu da bu gösterimin BUILD dosyalarında kullanıma uygun olmasını sağlar. Temsilin tam biçimi garanti edilmese de tipik örnekler şunlardır: //foo:bar, @repo//foo:bar ve @@canonical_name+//foo:bar.bzl.
  • Diğer tüm türler, belirtilmemiş bir yöntemle dizelere dönüştürülür. Bu nedenle, add() öğesine dize veya File türü olmayan değerleri iletmekten kaçınmanız gerekir. Bunları add_all() veya add_joined()’e iletirseniz bir map_each işlevi sağlamanız gerekir.

Dize biçimlendirmesi (add*() yöntemlerinin format, format_each ve format_joined parametreleri) kullanılırken biçim şablonu, dizelerde % değiştirme ile aynı şekilde yorumlanır. Tek fark, şablonun tam olarak bir tane değiştirme yer tutucusu içermesi ve %s olması gerekir. Değişmez yüzde değerleri, %% olarak kod dışına alınabilir. Biçimlendirme, değer yukarıdaki gibi bir dizeye dönüştürüldükten sonra uygulanır.

add*() yöntemlerinin her birinin, ekstra konum parametresini (bağımsız değişken adı) kabul eden alternatif bir biçimi vardır. bağımsız değişkenlerin önüne eklenecek bir dize. add_all ve add_joined için sıra boş olursa fazladan dize eklenmez. Örneğin, aynı kullanım, belirtilen adım sırasının val1..val3 içermesine veya boş olmasına bağlı olarak komut satırına --foo val1 val2 val3 --bar veya yalnızca --bar ekleyebilir.

Komut satırının boyutu sistemin izin verdiği maksimum boyuttan daha uzun olursa bağımsız değişkenler parametre dosyalarına dökülebilir. Bkz. use_param_file() ve set_param_file_format().

Örnek: 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 zorunlu
İki konum parametresi iletilirse bu, bağımsız değişken 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 konum parametresi iletilirse value olarak yorumlanır (aşağıya bakın).
value varsayılan değer unbound
Eklenecek nesne. Bu değer, 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. File adlı liste, unsur, depset veya dizinin bu yöntem yerine add_all() veya add_joined() hizmetine iletilmesi gerekir.
format string; veya None; varsayılan değer: None
value öğesinin dizeleştirilmiş 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 çok bağımsız değişken ekler. Öğeler yürütme aşamasında geç işlenir.

İşlemin büyük kısmı, aşağıdaki adımlara göre eklenecek bir bağımsız değişkenler listesi üzerinden gerçekleştirilir:

  1. Her dizin File öğesi, söz konusu dizinde yinelenen şekilde bulunan tüm File öğeleri ile değiştirilir.
  2. map_each sağlanmışsa her bir öğeye uygulanır ve ortaya çıkan dize listeleri, ilk bağımsız değişken listesini oluşturmak üzere birleştirilir. Aksi takdirde, ilk bağımsız değişken listesi her bir öğeye standart dönüşümün uygulanması sonucunda elde edilir.
  3. Varsa listedeki her bağımsız değişken format_each ile biçimlendirilir.
  4. uniquify Doğru değerine ayarlanırsa yinelenen bağımsız değişkenler kaldırılır. İlk gerçekleşme, kalandı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. Böylece bu nokta tarafından eklenecek bağımsız değişken sayısı etkin bir şekilde ikiye katlanır.
  6. Listenin boş olması ve omit_if_empty değerinin doğru (varsayılan) olması dışında, bağımsız değişken adı ve terminate_with (varsa) sırasıyla ilk ve son bağımsız değişkenler 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 zorunlu
İki konum parametresi iletilirse bu, bağımsız değişken 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 true ise (varsayılan) ve başka hiçbir öğe eklenmezse (values boş olduğunda veya tüm öğeleri filtrelendiğinde 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
Öğeleri eklenecek olan liste, unsur veya depset.
map_each çağrılabilir; veya None; varsayılan değer None
Her bir öğeyi sıfır veya daha fazla dizeye dönüştüren ve eklemeden önce daha ayrıntılı şekilde işlenebilecek bir işlev. Bu parametre sağlanmazsa standart dönüşüm kullanılır.

İşleve bir veya iki konum bağımsız değişkeni aktarılır: 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ğil) ve birden fazla parametre bildirirse 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 bir öğenin 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 çok dizeye dönüşürse işlev, bu dizelerin bir listesini döndürür.
Tek bir dizenin veya None değerinin döndürülmesi, sırasıyla 1 veya 0 uzunluğunda bir liste döndürmeyle aynı etkiye sahiptir. Bununla birlikte, gereksiz bir liste oluşturmaktan kaçınmak için daha verimli ve okunabilir olur.

Normalde, expand_directories=True ayarlandığında dizin olan öğeler otomatik olarak içeriklerini içerecek şekilde genişletilir. Ancak bu işlem, diğer değerlerin içinde yer alan dizinleri genişletmez (örneğin, öğeler alan olarak dizinlere sahip struct olduğunda). Bu durumda, belirli bir dizindeki dosyaları manuel olarak almak için DirectoryExpander bağımsız değişkeni uygulanabilir.

Büyük analiz aşaması veri yapılarının, yürütme aşamasında amaçlanmayan bir şekilde saklanmasını önlemek için map_each işlevi, üst düzey bir def ifadesiyle bildirilmelidir; varsayılan olarak iç içe yerleştirilmiş bir işlev kapanışı olmayabilir.

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

format_each string; veya None; varsayılan değer: None
map_each işlevi tarafından döndürülen her dizeye uygulanan isteğe bağlı biçim dizesi kalıbı. Biçim dizesinde tam olarak bir '%s' bulunmalıdır yer tutucusu içerir.
before_each string; veya None; varsayılan değer: None
values öğesinden türetilen her bağımsız değişkenden önce eklenecek isteğe bağlı bir bağımsız değişken eklenir.
omit_if_empty bool; varsayılan değer: True
Doğru değerine ayarlanırsa values parametresinden türetilecek bağımsız değişken yoksa sonraki 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 bool; varsayılan değer: False
True (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 geçtiği yer kalır. Etiketler halihazırda yinelenen öğeleri atladığı için bu özellik genellikle gerekli değildir ancak map_each, birden fazla öğe için aynı dizeyi yayınlarsa bu özellik yararlı olabilir.
expand_directories bool; varsayılan değer: True
True (doğru) değerine ayarlanırsa values konumundaki tüm dizinler düz bir dosya listesine genişletilir. Bu işlem, map_each uygulanmadan önce gerçekleşir.
terminate_with string; 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ğru (varsayılan) ise ve başka hiçbir öğe eklenmezse (values boş olduğunda veya tüm öğeleri filtrelendiğinde olduğu gibi) bu bağımsız değişken eklenmez.
allow_closure bool; varsayılan değer: False
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 geç işlenir.

İşleme, add_all() işlevine benzer, ancak values öğesinden türetilen bağımsız değişkenler listesi, join_with.join(...) 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.

Filtrelemeden sonra bağımsız değişkene katılacak dize yoksa ve omit_if_empty doğru (varsayılan) ise 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 zorunlu
İki konum parametresi iletilirse bu, bağımsız değişken adı olarak yorumlanır. Bağımsız değişken adı, herhangi bir işlenmeden values öncesine eklenir. omit_if_empty doğru (varsayılan) ise ve birleştirilecek values alanından türetilmiş herhangi bir dize yoksa bu bağımsız değişken, values boşsa veya tüm öğeleri filtrelenirse 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 birleştirileceği liste, unsur veya kaldırma.
join_with string; gerekli
string.join() ile aynı şekilde, map_each ve format_each yöntemlerinin uygulanmasından 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 string; veya None; varsayılan değer: None
add_all ile aynıdır.
format_joined string; 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 '%s' bulunmalıdır yer tutucusu içerir.
omit_if_empty bool; varsayılan değer: True
Doğru değerine ayarlanırsa (values boş olduğu veya tüm öğeleri filtrelendiği için) birleştirilecek dize yoksa diğer tüm işlemler atlanır ve komut satırında değişiklik olmaz. Yanlış değeri döndürülürse 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ştirmesi).
uniquify bool; varsayılan değer: False
add_all ile aynıdır.
expand_directories bool; varsayılan değer: True
add_all ile aynıdır.
allow_closure bool; 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 param dosyasının biçimini ayarlar .

Parametreler

Parametre Açıklama
format string; gerekli
Şunlardan biri olmalıdır:
  • "multiline": Her öğe (bağımsız değişken adı veya değer), param dosyasına tam olarak yazılır ve arkasından yeni bir satır karakteri eklenir.
  • "shell" (kabuk): "çoklu" ile aynıdır, ancak öğeler kabuk tırnak içine alınmıştır
  • "flag_per_line": "multiline" ile aynıdır, ancak (1) param dosyasına yalnızca işaretler ("--" ile başlar) yazılır ve (2) flag'lerin değerleri (varsa) aynı satıra bir '=" ile yazılır. ayırıcı olarak sunar. Abseil bayrakları kitaplığı tarafından beklenen biçim budur.

Varsayılan biçim "shell"dir çağrılmaz.

use_param_file

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

Bağımsız değişkenleri, param dosyası işaretçisiyle değiştirerek bir params dosyasına aktarır. Bağımsız değişkenleriniz, sistemin komut uzunluğu sınırları için çok büyük olduğunda kullanın.

Bazel, verimlilik için yürütme sırasında parametre dosyasını çıkış ağacına yazmayı tercih edebilir. İş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 string; gerekli
Tek bir "%s" içeren biçim dizesi. Bağımsız değişkenler 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" params dosyasına döküldüyse "--file=%s" değeri belirtilir işlem komut satırının "--file=params.txt" içermesine neden olur.

use_always bool; varsayılan değer: False
Bağımsız değişkenlerin her zaman bir params dosyasına aktarılıp aktarılmayacağı. Yanlış değerine ayarlanırsa bazel, sisteminize ve bağımsız değişken uzunluğuna göre bağımsız değişkenlerin dökülmesi gerekip gerekmediğine karar verir.