modül_kalori

7.3 · 7.2 · 7.1 · 7.0 · 6.5

Bağımlılıklar grafiğindeki alakalı etiketlerle ilgili yardımcı işlevleri ve bilgileri içeren modül uzantısının bağlamı. Modül uzantısı oluşturduğunuzda implementation işlevine bağımsız değişken olarak bir module_ctx nesnesi alırsınız.

Üyeler

indir

unknown module_ctx.download(url, output='', sha256='', executable=False, allow_fail=False, canonical_id='', auth={}, headers={}, *, integrity='', block=True)

Bir dosyayı, sağlanan URL'nin çıkış yoluna indirir ve success içeren bir yapı döndürür. Bu yapı, indirme işlemi başarıyla tamamlanırsa true olan bir işarettir. İndirme işlemi başarılı olursa sha256 ve integrity alanlarını içeren dosyanın karmasını döndürür. sha256 veya integrity kullanıcı tarafından belirtildiğinde açık bir canonical_id ayarlanması önemle tavsiye edilir. ör. get_default_canonical_id

Parametreler

Parametre Açıklama
url dize veya dize öğelerinin Iterable dizisi; zorunlu
Aynı dosyaya atıfta bulunan ayna URL'lerin listesi.
output dize; veya Etiket; veya yol; varsayılan, depo dizinine göre çıkış dosyasının ''
yoludur.
sha256 varsayılan değer ''
İndirilen dosyanın beklenen SHA-256 karmasıdır. Bu değer, indirilen dosyanın SHA-256 karmasıyla eşleşmelidir. Uzak dosyalar değişebileceğinden SHA-256'yı çıkarmak güvenlik riski oluşturur. Bu alanın atlanması, en iyi ihtimalle derlemenizin hermetik olmasını engeller. Geliştirmeyi kolaylaştırmak için isteğe bağlıdır ancak göndermeden önce ayarlanmalıdır. Kod deposu önbelleği sağlanmışsa öncelikle belirtilen karmaya sahip bir dosya olup olmadığı kontrol edilir. İndirme işlemi yalnızca dosya önbellekte bulunamadığında denenir. İndirme işlemi başarılı olduktan sonra dosya önbelleğe eklenir.
executable varsayılan değer False
Oluşturulan dosyada yürütülebilir işaretini varsayılan olarak false olarak ayarlayın.
allow_fail varsayılan değer False şeklindedir
Ayarlanırsa, başarısız indirmeler için hata mesajı göndermek yerine döndürülen değerde hatayı belirtin.
canonical_id varsayılan değer ''
Ayarlanırsa önbellek isabetlerini, dosyanın önbelleğe aynı kanonikal kimlikle eklendiği durumlarla kısıtlayın. Önbelleğe alma varsayılan olarak sağlama toplamını (sha256 veya integrity) kullanır.
auth varsayılan değer {}
Bazı URL'ler için kimlik doğrulama bilgilerini belirten isteğe bağlı bir sözlük.
headers varsayılan değer {}
Tüm URL'ler için http üstbilgilerini belirten isteğe bağlı bir sözlük.
integrity varsayılan '' şeklindedir
İndirilen dosyanın Alt Kaynak Bütünlüğü biçiminde beklenen sağlama toplamı. Bu, indirilen dosyanın sağlama toplamıyla eşleşmelidir. Uzak dosyalar değişebileceği için sağlama toplamının atlanması güvenlik riski oluşturur. Bu alanın atlanması, en iyi ihtimalle derlemenizin hermetik olmasını engeller. Geliştirmeyi kolaylaştırmak için isteğe bağlıdır ancak göndermeden önce ayarlanmalıdır. Sağlanırsa depo önbelleği, önce belirtilen sağlama toplamına sahip bir dosya olup olmadığı açısından kontrol edilir. İndirme işlemi yalnızca dosya önbellekte bulunamazsa denenir. İndirme işlemi başarılı olduğunda dosya önbelleğe eklenir.
block varsayılan değer True
Yanlış olarak ayarlanırsa çağrı hemen döndürülür ve normal döndürülen değer yerine, indirme işlemi tamamlanana kadar engelleyen ve normal döndürülen değeri döndüren veya her zamanki gibi hata atan tek bir yöntemi (wait()) içeren bir jeton döndürülür.

download_and_extract

struct module_ctx.download_and_extract(url, output='', sha256='', type='', stripPrefix='', allow_fail=False, canonical_id='', auth={}, headers={}, *, integrity='', rename_files={})

Bir dosyayı, sağlanan URL'nin çıkış yoluna indirir, dosyayı çıkarır ve success içeren bir yapı döndürür. Bu yapı, indirme işlemi başarıyla tamamlanırsa true olan bir işarettir. İşlem başarılı olursa sha256 ve integrity alanlarını içeren dosyanın karmasını döndürür. sha256 veya integrity kullanıcı tarafından belirtildiğinde açık bir canonical_id ayarlanması önemle tavsiye edilir. Ör. get_default_canonical_id

Parametreler

Parametre Açıklama
url dize veya dize öğelerinin Iterable dizisi; zorunlu
Aynı dosyaya atıfta bulunan ayna URL'lerin listesi.
output dize; veya etiket; veya yol; varsayılan değer ''
Arşivin, depo dizine göre açılacağı dizinin yolu.
sha256 varsayılan değer ''
İndirilen dosyanın beklenen SHA-256 karması. Bu değer, indirilen dosyanın SHA-256 karmasıyla eşleşmelidir. Uzak dosyalar değişebileceğinden SHA-256'yı çıkarmak güvenlik riski oluşturur. Bu alanın atlanması, en iyi ihtimalle derlemenizin hermetik olmasını engeller. Geliştirmeyi kolaylaştırmak için isteğe bağlıdır ancak göndermeden önce ayarlanmalıdır. Sağlanırsa ilk olarak depo önbelleği, belirtilen karmaya sahip bir dosya olup olmadığını kontrol eder. İndirme işlemi yalnızca dosya önbellekte bulunamazsa denenir. İndirme işlemi başarılı olduğunda dosya önbelleğe eklenir.
type varsayılan değer ''
İndirilen dosyanın arşiv türü. Arşiv türü varsayılan olarak URL'nin dosya uzantısından belirlenir. Dosyanın uzantısı yoksa "zip", "jar", "war", "aar", "nupkg", "tar", "tar.gz", "tgz", "tar.xz", "txz", ".tar.zst", ".tzst", "tar.bz2", ".tbz", ".ar" veya ".deb" uzantılarını burada açıkça belirtebilirsiniz.
stripPrefix varsayılan ayar ''
Çıkarılan dosyalardan kaldırılacak bir dizin ön eki. Birçok arşiv, arşivdeki tüm dosyaları içeren bir üst düzey dizin içerir. Bu ön eki build_file içinde tekrar tekrar belirtmek yerine bu alan, ayıklanan dosyalardan onu ayırmak için kullanılabilir.
allow_fail varsayılan değer False
Ayarlanırsa başarısız indirmeler için hata oluşturmak yerine hatayı döndürülen değerde belirtin.
canonical_id varsayılan değer ''
Ayarlanırsa önbellek isabetlerini, dosyanın önbelleğe aynı kanonikal kimlikle eklendiği durumlarla kısıtlayın. Varsayılan olarak önbelleğe alma işleminde sağlama toplamı kullanılır" (sha256 veya integrity).
auth varsayılan değer {}
Bazı URL'ler için kimlik doğrulama bilgilerini belirten isteğe bağlı bir sözlük.
headers varsayılan değer {}
Tüm URL'ler için http üstbilgilerini belirten isteğe bağlı bir sözlük.
integrity varsayılan '' şeklindedir
İndirilen dosyanın Alt Kaynak Bütünlüğü biçiminde beklenen sağlama toplamı. Bu, indirilen dosyanın sağlama toplamıyla eşleşmelidir. Uzak dosyalar değişebileceğinden sağlama toplamını çıkarmak güvenlik açısından risklidir. Bu alanın atlanması, en iyi ihtimalle derlemenizin hermetik olmasını engeller. Geliştirmeyi kolaylaştırmak için isteğe bağlıdır ancak göndermeden önce ayarlanmalıdır. Sağlanmışsa, depo önbelleği öncelikle belirtilen sağlama toplamına sahip bir dosya için kontrol edilir; indirme işlemi yalnızca dosya önbellekte bulunamadığında denenir. İndirme işlemi başarılı olduktan sonra dosya önbelleğe eklenir.
rename_files varsayılan değer {}
Çıkarma sırasında yeniden adlandırılacak dosyaları belirten isteğe bağlı bir sözlük. Adları bir anahtarla tam olarak eşleşen arşiv girişleri, dizin ön ek düzenlemesinden önce değerle yeniden adlandırılır. Bu seçenek, Unicode olmayan dosya adları içeren veya büyük/küçük harf duyarlı olmayan dosya sistemlerinde aynı yola ayıklanacak dosyalar içeren arşivleri ayıklamak için kullanılabilir.

execute

exec_result module_ctx.execute(arguments, timeout=600, environment={}, quiet=True, working_directory="")

Bağımsız değişkenler listesi tarafından verilen komutu yürütür. Komutun yürütülme süresi timeout ile sınırlıdır (saniye cinsinden, varsayılan 600 saniye). Bu yöntem, komutun çıktısını içeren bir exec_result yapısı döndürür. environment haritası, işleme iletilecek bazı ortam değişkenlerini geçersiz kılmak için kullanılabilir.

Parametreler

Parametre Açıklama
arguments required
Parametre listesi. İlk öğe, çalıştırılacak programın yolu olmalıdır.
timeout varsayılan değer 600
Komutun saniye cinsinden maksimum süresi (varsayılan değer 600 saniyedir).
environment varsayılan değer {}
Bazı ortam değişkenlerinin, sürece aktarılacak şekilde ayarlanmasını zorunlu kılar.
quiet varsayılan değer True şeklindedir
stdout ve stderr'in terminale yazdırılması gerekiyorsa.
working_directory varsayılan ""
Komut yürütme için çalışma dizini. Depo köküne göre göreli veya mutlak olabilir. Varsayılan dizin, depo köküdür.

extension_metadata

extension_metadata module_ctx.extension_metadata(root_module_direct_deps=None, root_module_direct_dev_deps=None, reproducible=False)

Modül uzantısının uygulama işlevinden döndürülebilecek opak bir nesne oluşturur. Bu nesne, uzantı tarafından oluşturulan depolarla ilgili meta verileri Bazel'e sağlar.

Parametreler

Parametre Açıklama
root_module_direct_deps Dize dizisi; veya dize; veya None; varsayılan değer None
Uzantı tarafından kök modülün doğrudan bağımlılıkları olarak kabul edilen depoların adları. Kök modül ek depolar içe aktarırsa veya bu depoların tümünü use_repo aracılığıyla içe aktarmazsa Bazel, uzantı değerlendirilirken kullanıcıya use_repo çağrılarını otomatik olarak düzeltmek için bazel mod tidy'ı çalıştırmasını bildiren bir uyarı yazdırır.

root_module_direct_deps değerlerinden biriyse ve uzantı değerlendirildiğinde bir uyarı ve düzeltme komutu yazdırır.

root_module_direct_deps ve root_module_direct_dev_deps'den biri belirtilirse diğeri de belirtilmelidir. Bu iki parametre tarafından belirtilen listeler kesişmemelidir.

root_module_direct_deps ve root_module_direct_dev_deps özelliklerinden tam olarak biri, "all" özel değerine ayarlanabilir. Bu durumda, uzantı tarafından oluşturulan tüm depoların adlarını içeren bir liste değer olarak belirtilmiş gibi değerlendirilir.

root_module_direct_dev_deps dize'lerin sequence; veya dize; veya None; varsayılan olarak None
Uzantının kök modülünün doğrudan geliştirici bağımlılığı olarak kabul ettiği depoların adları. Kök modül ek depolar içe aktarırsa veya use_extension(..., dev_dependency = True) ile oluşturulan bir uzantı proxy'sinde bu depoların tümünü use_repo aracılığıyla içe aktarmazsa Bazel, uzantı değerlendirilirken kullanıcıya use_repo çağrılarını otomatik olarak düzeltmek için bazel mod tidy'i çalıştırmasını bildiren bir uyarı yazdırır.

root_module_direct_deps ve root_module_direct_dev_deps özelliklerinden biri belirtilirse diğerinin de belirtilmesi gerekir. Bu iki parametre tarafından belirtilen listeler kesişmemelidir.

root_module_direct_deps ve root_module_direct_dev_deps özelliklerinden tam olarak biri, "all" özel değerine ayarlanabilir. Bu durumda, uzantı tarafından oluşturulan tüm depoların adlarını içeren bir liste değer olarak belirtilmiş gibi değerlendirilir.

reproducible bool; varsayılan olarak False
Bu modül uzantısının tam bir yeniden oluşturulabilirlik sağladığı ve bu nedenle kilit dosyasında depolanmaması gerektiğini belirtir.

ayıklamak

None module_ctx.extract(archive, output='', stripPrefix='', *, rename_files={}, watch_archive='auto')

Arşivi depo dizinine çıkarın.

Parametreler

Parametre Açıklama
archive dize; veya Etiket; veya yol; zorunlu
Arşivin, depolama alanı dizine göreli yolu.
output dize; veya etiket; veya yol; varsayılan değer ''
Arşivin, depo dizine göre paketten çıkarılacağı dizinin yolu.
stripPrefix varsayılan değer ''
olup ayıklanan dosyalardan ayıklanacak bir dizin önekidir. Birçok arşiv, arşivdeki tüm dosyaları içeren bir üst düzey dizin içerir. Bu ön eki build_file içinde tekrar tekrar belirtmek yerine, bu alan çıkarılan dosyalardan kaldırmak için kullanılabilir.
rename_files varsayılan değer {}
Çıkarma sırasında yeniden adlandırılacak dosyaları belirten isteğe bağlı bir sözlük. Bir anahtarla tam olarak eşleşen adlara sahip arşiv girişleri, herhangi bir dizin öneki ayarlamasından önce değer olarak yeniden adlandırılır. Bu seçenek, Unicode olmayan dosya adları içeren veya büyük/küçük harf duyarlı olmayan dosya sistemlerinde aynı yola ayıklanacak dosyalar içeren arşivleri ayıklamak için kullanılabilir.
watch_archive varsayılan ayar 'auto'
arşiv dosyasının izlenip izlenmeyeceği. "yes", "no" veya "auto" dizesi olabilir. "Evet"i iletmek, watch() yöntemini hemen çağırmak anlamına gelir. 'no' iletildiğinde dosyayı izlemeye çalışmaz, 'auto' (otomatik) komutu iletildiğinde yalnızca yasal olduğu durumlarda izlenmeye çalışılır (daha fazla bilgi için watch() dokümanlarına bakın).

dosya

None module_ctx.file(path, content='', executable=True, legacy_utf8=True)

Depo dizininde, sağlanan içeriği içeren bir dosya oluşturur.

Parametreler

Parametre Açıklama
path dize; veya Etiket; veya yol; zorunlu
Repo dizine göre oluşturulacak dosyanın yolu.
content varsayılan değer ''
Oluşturulacak dosyanın içeriğidir. Varsayılan olarak boştur.
executable varsayılan değer True
Oluşturulan dosyada yürütülebilir işaretini varsayılan olarak true olarak ayarlayın.
legacy_utf8 varsayılan değer True
Dosya içeriğini UTF-8 olarak kodlayın. Varsayılan olarak doğrudur. Gelecek sürümlerde varsayılan ayar değiştirilecek ve bu parametre kaldırılacaktır.

getenv

string module_ctx.getenv(name, default=None)

Bir ortam değişkeninin değerini name varsa dize olarak, yoksa default değerini döndürür.

Artımlı derleme sırasında name tarafından adlandırılan değişkenin değerinde yapılan herhangi bir değişiklik, bu deposunun yeniden getirilmesine neden olur.

Parametreler

Parametre Açıklama
name string; gerekli
İstenen ortam değişkeninin adı.
default dize veya None; varsayılan değer None
name bulunamazsa döndürülecek varsayılan değer.
None değerini döndürebilir.

is_dev_dependency

bool module_ctx.is_dev_dependency(tag)

Belirtilen etiketin, devDependency = True ile bir use_extension çağrısının sonucunda belirtilip belirtilmediğini döndürür.

Parametreler

Parametre Açıklama
tag bazel_module_tag; zorunlu
bazel_module.tags kaynağından alınan bir etiket.

modüllerin

list module_ctx.modules

Harici bağımlılık grafiğinde, bu modül uzantısını kullanan tüm Bazel modüllerinin listesi. Bunların her biri, uzantı için belirttiği tüm etiketleri gösteren bir bazel_module nesnesidir. Bu sözlüğün iterasyon sırasının, kök modülden başlayarak geniş kapsamlı aramayla aynı olacağı garanti edilir.

os

repository_os module_ctx.os

Sistemdeki bilgilere erişmek için kullanılan bir yapı.

yol

path module_ctx.path(path)

Bir dizeden, etiketten veya yoldan bir yol döndürür. Yol göreceliyse kod deposu dizinine göre çözümlenir. Yol bir etiketse ilgili dosyanın yoluna çözümlenir. Uzak depoların analiz aşamasında yürütüldüğünü ve dolayısıyla bir hedef sonuca bağlı olamayacağını unutmayın (etiket, oluşturulmamış bir dosyaya işaret etmelidir). Yol bir yolsa bu yolu olduğu gibi döndürür.

Parametreler

Parametre Açıklama
path dize; veya Etiket; veya yol; zorunlu
string, Label veya path'ten yol oluşturma.

okuma

string module_ctx.read(path, *, watch='auto')

Dosya sistemindeki bir dosyanın içeriğini okur.

Parametreler

Parametre Açıklama
path dize; veya Etiket; veya yol; zorunlu
İçinden okunacak dosyanın yolu.
watch varsayılan değer 'auto'
Dosyanın izlenip izlenmeyeceği. "yes", "no" veya "auto" dizesi olabilir. "yes" değerini iletmek, watch() yönteminin hemen çağrılmasına eşdeğerdir; "no" değerini iletmek, dosyayı izlemeye çalışmaz; "auto" değerini iletmek, dosyayı yalnızca izlemenin yasal olduğu durumlarda izlemeye çalışır (daha fazla bilgi için watch() belgelerine bakın).

report_progress

None module_ctx.report_progress(status='')

Bu deposunun veya modül uzantısının getirilmesi işleminin ilerleme durumunu günceller.

Parametreler

Parametre Açıklama
status dize; varsayılan olarak ''
string, getirme işleminin mevcut durumunu açıklar.

root_module_has_non_dev_dependency

bool module_ctx.root_module_has_non_dev_dependency

Kök modülün bu uzantıyı geliştirici dışı bir bağımlılık olarak kullanıp kullanmadığı.

kol saati

None module_ctx.watch(path)

Bazel'e, belirtilen yoldaki değişiklikleri (var olup olmadığı veya dosya ya da dizin olup olmadığı fark etmeksizin) izlemesini söyler. Dosyada veya dizinde yapılan değişiklikler bu deposu veya modül uzantısını geçersiz kılar ve bir sonraki sefer yeniden getirilmesine ya da yeniden değerlendirilmesine neden olur.

"Değişiklikler", dosyanın içeriğindeki değişiklikleri (yol bir dosyaysa), yolun dosya iken dizin haline gelmesini veya bunun tam tersini, yolun var olmaya başlamasını ya da varlığını sonlandırmasını içerir. Yol bir dizinse bu, dizin altındaki dosyalarda yapılan değişiklikleri kapsamaz. Bunun için path.readdir() değerini kullanın.

Şu anda getirilmekte olan deponun veya mevcut modül uzantısının çalışma dizininin içindeki yolları izlemeye çalışmanın hatayla sonuçlanacağını unutmayın. Mevcut Bazel çalışma alanının dışındaki yolu izlemeye çalışan modül uzantıları da hatayla sonuçlanır.

Parametreler

Parametre Açıklama
path dize; veya Etiket; veya yol; zorunlu
İzlenecek dosyanın yolu.

hangi

path module_ctx.which(program)

İlgili programın path değerini veya yolda böyle bir program yoksa None değerini döndürür.

Parametreler

Parametre Açıklama
program required
Yolda bulunacak program.
None sonucunu döndürebilir.