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
- download
- download_and_extract
- yürütme
- extension_metadata
- extract
- file
- getenv
- is_dev_dependency
- modules
- işletim sistemi
- path
- oku
- report_progress
- root_module_has_non_dev_dependency
- watch
- hangi
indir
unknown module_ctx.download(url, output='', sha256='', executable=False, allow_fail=False, canonical_id='', auth={}, headers={}, *, integrity='', block=True)
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.
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 '' depolama alanı dizine göre çıkış dosyasının yolu. |
sha256
|
varsayılan değer '' indirilen dosyanın beklenen SHA-256 karması. Bu, indirilen dosyanın SHA-256 karmasıyla eşleşmelidir. Uzak dosyalar değişebileceğinden SHA-256'nın atlanması güvenlik riski oluşturur. Bu alanı atlamak, derlemenizi hermetik hale getirmez. 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. |
executable
|
varsayılan değer False oluşturulan dosyada yürütülebilir işaretini ayarlar, varsayılan olarak yanlıştır. |
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ı( sha256 veya integrity ) kullanılı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 {} 'tir.Tüm URL'ler için http başlıkları belirten isteğe bağlı bir ifadedir. |
integrity
|
varsayılan değer '' İndirilen dosyanın, alt öğe 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ı olduktan sonra 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={})
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.
Parametreler
Parametre | Açıklama |
---|---|
url
|
string; veya dizelerin yinelenebilir;
gerekli Aynı dosyaya referans veren yansıtma URL'lerinin listesi. |
output
|
dize; veya etiket; veya yol;
varsayılan değer '' Arşivin, depo dizine göre paketten çıkarılacağı dizinin yolu. |
sha256
|
varsayılan değer '' indirilen 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'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 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 olarak '' indirilen 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", "tar", "tar.gz", "tgz", "tar.xz", "txz", ".tar.zst", ".tzst", "tar.bz2", ".tbz", ".ar" veya ".deb" uzantılarından birini burada açıkça belirtebilirsiniz. |
stripPrefix
|
varsayılan olarak '' çı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 şeklindedirAyarlanı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. Varsayılan olarak önbelleğe alma işleminde sağlama toplamı( sha256 veya integrity ) kullanılı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 {} 'tir.Tüm URL'ler için http başlıkları belirten isteğe bağlı bir ifadedir. |
integrity
|
varsayılan değer '' İndirilen dosyanın, alt öğe bütünlüğü biçiminde beklenen sağlama toplamı. Bu değer, 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ı olduğunda 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="")
timeout
ile sınırlıdır (saniye cinsinden, varsayılan olarak 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üresidir (varsayılan değer 600 saniyedir). |
environment
|
varsayılan olarak {} şeklindedirbazı ortam değişkenlerinin sürece geçirilmeye ayarlanmasını zorunlu kılar. |
quiet
|
varsayılan değer True stdout ve stderr'nin terminale yazdırılıp yazdırılmayacağı. |
working_directory
|
varsayılan olarak "" şeklindedirKomut yürütme için çalışma dizini. Depo köküne göre göreli veya mutlak olabilir. |
extension_metadata
extension_metadata module_ctx.extension_metadata(root_module_direct_deps=None, root_module_direct_dev_deps=None, reproducible=False)
Parametreler
Parametre | Açıklama |
---|---|
root_module_direct_deps
|
dize'lerin sequence; veya dize; veya None ;
varsayılan olarak None Uzantının kök modülün doğrudan bağımlılığı olarak kabul ettiği 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_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.
|
reproducible
|
bool;
varsayılan değer False Bu modül uzantısının tamamen yeniden üretilebilir olduğunu ve bu nedenle kilit dosyasında depolanmamasını belirtir. |
ayıklama
None
module_ctx.extract(archive, output='', stripPrefix='', *, rename_files={}, watch_archive='auto')
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 olarak, depo dizinine göre arşivin paketinin açılacağı dizine giden '' yoludur. |
stripPrefix
|
varsayılan olarak '' çıkarılan dosyalardan kaldırılacak bir dizin ön eki. Birçok arşiv, arşivdeki tüm dosyaları içeren üst düzey bir 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: {} Ayıklama sırasında yeniden adlandırılacak dosyaları belirten isteğe bağlı bir komut. 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. |
watch_archive
|
varsayılan ayar 'auto' arşiv dosyasını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).
|
dosya
None
module_ctx.file(path, content='', executable=True, legacy_utf8=True)
Parametreler
Parametre | Açıklama |
---|---|
path
|
dize; veya Etiket; veya yol;
zorunlu Oluşturulacak dosyanın, depolama alanı dizine göre yolu. |
content
|
'' varsayılan olarak boş olacak şekilde oluşturulacak dosyanın içeriğidir. |
executable
|
varsayılan değer True oluşturulan dosyada yürütülebilirlik işaretini ayarlar, varsayılan olarak doğrudur. |
legacy_utf8
|
True dosya içeriğini UTF-8 olarak kodlayın (varsayılan olarak true). 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)
name
) değerini 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;
required istenen ortam değişkeninin adı |
default
|
dize veya None ;
varsayılan değer None "ad" 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)
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
os
repository_os module_ctx.os
yol
path module_ctx.path(path)
Parametreler
Parametre | Açıklama |
---|---|
path
|
dize; veya Etiket; veya yol; gerekli içinden yol oluşturulacak dize, etiket veya yol |
okuma
string module_ctx.read(path, *, watch='auto')
Parametreler
Parametre | Açıklama |
---|---|
path
|
dize; veya Etiket; veya yol;
zorunlu 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='')
Parametreler
Parametre | Açıklama |
---|---|
status
|
dize; varsayılan olarak getirme işleminin mevcut durumunu açıklayan '' dizesidir |
root_module_has_non_dev_dependency
bool module_ctx.root_module_has_non_dev_dependency
kol saati
None
module_ctx.watch(path)
"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()
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 bir 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)
Parametreler
Parametre | Açıklama |
---|---|
program
|
gerekli Yolda bulunacak programı kullanın. |
None
değerini döndürebilir.