.
Bağımlılık grafiğindeki ilgili etiketler hakkında yardımcı işlevleri ve bilgileri içeren modül uzantısının bağlamı. Bir modül uzantısı oluşturduğunuzda, implementation
işlevinin bağımsız değişkeni olarak bir modül_ctx nesnesi alırsınız.
Üyeler
- indirin
- download_and_extract
- yürütme
- extension_metadata
- dosya
- is_dev_dependency
- modül
- işletim sistemi
- path
- oku
- report_progress
- root_module_has_non_dev_dependency
- hangi
indirme
struct module_ctx.download(url, output='', sha256='', executable=False, allow_fail=False, canonical_id='', auth={}, *, integrity='')Sağlanan URL için çıkış yoluna bir dosya indirir ve
success
öğesini içeren bir struct döndürür. Bu işaret, indirme işlemi başarıyla tamamlandıysa true
ve başarılıysa sha256
ile integrity
alanlarını içeren karma bir dosyadır.
Parametreler
Parametre | Açıklama |
---|---|
url
|
string; veya dizeler yinelenebilir;
gerekli Aynı dosyaya referansta bulunan yansıtma URL'lerinin listesi. |
output
|
string; veya Etiket; veya yol;
varsayılan ayar '' yolunu işaret eder. |
sha256
|
varsayılan değer '' İndirilen dosyanın beklenen SHA-256 karma değeri. 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ı atlamak, derlemenizi hermetik hale getirmez. Geliştirmeyi kolaylaştırmak isteğe bağlıdır ancak gönderimden önce ayarlanmalıdır. |
executable
|
varsayılan değer False oluşturulan dosyada yürütülebilir bayrağı varsayılan olarak false (yanlış) değerine ayarlayın. |
allow_fail
|
varsayılan değer False Ayarlanırsa, başarısız indirmeler için hata mesajı iletmek yerine döndürülen değerde hatayı belirtin |
canonical_id
|
varsayılan değer '' Ayarlanırsa önbellek isabetlerini, dosyanın önbelleğe aynı standart kimlikle eklendiği durumlarla sınırlandırın |
auth
|
varsayılan değer {} Bazı URL'lerin kimlik doğrulama bilgilerini belirten isteğe bağlı bir metin. |
integrity
|
varsayılan değer '' İndirilen dosyanın, Alt Kaynak 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ği için sağlama toplamının atlanması güvenlik riski oluşturur. Bu alanı atlamak, derlemenizi hermetik hale getirmez. Geliştirmeyi kolaylaştırmak isteğe bağlıdır ancak gönderimden önce ayarlanmalıdır. |
download_and_extract
struct module_ctx.download_and_extract(url, output='', sha256='', type='', stripPrefix='', allow_fail=False, canonical_id='', auth={}, *, integrity='', rename_files={})Sağlanan URL'nin çıkış yoluna bir dosya indirir, dosyayı ayıklar ve
success
içeren bir struct'ı döndürür. Bu işaret, indirme işlemi başarıyla tamamlandıysa true
ve başarılıysa sha256
ile integrity
alanlarında dosyanın karmasını oluşturur.
Parametreler
Parametre | Açıklama |
---|---|
url
|
string; veya dizeler yinelenebilir;
gerekli Aynı dosyaya referansta bulunan yansıtma URL'lerinin listesi. |
output
|
string; veya Etiket; veya yol;
varsayılan ayar '' arşivin paketten çıkarılacağı dizine giden yol. |
sha256
|
varsayılan değer '' İndirilen dosyanın beklenen SHA-256 karma değeri. 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ı atlamak, derlemenizi hermetik hale getirmez. Geliştirmeyi kolaylaştırmak isteğe bağlıdır ancak gönderimden önce ayarlanmalıdır. Kod deposu önbelleği, sağlanırsa öncelikle verilen karmaya sahip bir dosya için kontrol edilir. İndirme işlemi yalnızca dosya önbellekte bulunmazsa denenir. İndirme işlemi başarılı olduktan sonra dosya önbelleğe eklenir. |
type
|
varsayılan değer '' indirilen dosyanın arşiv türü. Varsayılan olarak, arşiv türü URL'nin dosya uzantısına göre belirlenir. Dosyanın uzantısı yoksa, açık bir şekilde "zip", "jar", "war", "aar", "tar", "tar.gz", "tgz", "tar.xz", "txz", ".tar.zst", ".tzst", "tar.bz2", ".tbz", ".deb" veya ".debz" değerlerini belirtebilirsiniz. burayı tıklayın. |
stripPrefix
|
varsayılan değer '' ayıklanmış dosyalardan ayırmak için bir dizin öneki. 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, 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 mesajı iletmek yerine döndürülen değerde hatayı belirtin |
canonical_id
|
varsayılan değer '' Ayarlanırsa önbellek isabetlerini, dosyanın önbelleğe aynı standart kimlikle eklendiği durumlarla sınırlandırın |
auth
|
varsayılan değer {} Bazı URL'lerin kimlik doğrulama bilgilerini belirten isteğe bağlı bir metin. |
integrity
|
varsayılan değer '' İndirilen dosyanın, Alt Kaynak 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ği için sağlama toplamının atlanması güvenlik riski oluşturur. Bu alanı atlamak, derlemenizi hermetik hale getirmez. Geliştirmeyi kolaylaştırmak isteğe bağlıdır ancak gönderimden önce ayarlanmalıdır. |
rename_files
|
varsayılan değer {} Ayıklama sırasında yeniden adlandırılacak dosyaları belirten isteğe bağlı bir dikt. 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 komut, Unicode olmayan dosya adları veya büyük/küçük harfe duyarlı olmayan dosya sistemlerinde aynı yola çıkarılacak dosyalara sahip 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, komut çıkışını içeren bir exec_result
yapısı döndürür. environment
eşlemesi, işleme iletilecek bazı ortam değişkenlerini geçersiz kılmak için kullanılabilir.
Parametreler
Parametre | Açıklama |
---|---|
arguments
|
zorunlu Bağımsız değişkenler listesi, ilk öğe yürütülecek programa giden yol 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 {} işleme tabi tutulması için bazı ortam değişkenlerinin ayarlanmasını zorunlu kılar. |
quiet
|
varsayılan değer True stdout ve stderr'in terminale yazdırılması gerekiyorsa. |
working_directory
|
varsayılan değer "" Komut yürütme için çalışma dizini. Depo kökü veya mutlak ile göreli olabilir. |
extension_metadata
extension_metadata module_ctx.extension_metadata(root_module_direct_deps=None, root_module_direct_dev_deps=None)Bazel uzantısı tarafından oluşturulan depolar hakkında meta veri sağlamak için modül uzantısının uygulama işlevinden döndürülebilecek opak bir nesne oluşturur.
Parametreler
Parametre | Açıklama |
---|---|
root_module_direct_deps
|
sequence of dize; veya dize; veya None ;
varsayılan ayar 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 use_repo aracılığıyla bu depoların tümünü içe aktarmazsa Bazel uzantı değerlendirildiğinde bir uyarı ve düzeltme komutu yazdırır.
|
root_module_direct_dev_deps
|
sequence of dize; veya dize; veya None ;
varsayılan ayar None Uzantının, kök modülün doğrudan geliştirici bağımlıları 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 uzantı proxy'sinde use_repo aracılığıyla bu depoların tümünü içe aktarmazsa Bazel uzantı değerlendirildiğinde bir uyarı ve düzeltme komutu yazdırır.
|
dosya
None
module_ctx.file(path, content='', executable=True, legacy_utf8=True)
Depo dizininde, sağlanan içerikle bir dosya oluşturur.
Parametreler
Parametre | Açıklama |
---|---|
path
|
string; veya Etiket; veya yol;
gerekli depo dizininize göre belirlenecek dosyanın yolu. |
content
|
varsayılan değer '' dosyanın içeriği varsayılan olarak boştur. |
executable
|
varsayılan değer True oluşturulan dosyada yürütülebilir işareti varsayılan olarak true olarak ayarlayın. |
legacy_utf8
|
varsayılan değer True dosya içeriğini varsayılan olarak true (doğru) olarak UTF-8 olarak kodlayın. Gelecekteki sürümlerde varsayılan ayar değiştirilecek ve bu parametre kaldırılacaktır. |
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 belirtilmeyeceğini döndürür.
Parametreler
Parametre | Açıklama |
---|---|
tag
|
bazel_module_tag;
zorunlu bazel_module.tags adresinden alınan bir etiket. |
modüllerin
list module_ctx.modulesHarici 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 kapsama öncelik veren aramayla aynı olması garanti edilmektedir.
işletim sistemi
repository_os module_ctx.osSistemdeki bilgilere erişmek için bir struct.
yol
path module_ctx.path(path)Bir dize, etiket veya yoldan yol döndürür. Yol göreceliyse, depo dizinine göre çözümlenir. Yol bir etiketse karşılık gelen 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 yol ise bu yolu olduğu gibi döndürür. .
Parametreler
Parametre | Açıklama |
---|---|
path
|
string; veya Etiket; veya yol;
gerekli içinden yol oluşturacağınız dize, etiket veya yol |
okuma
string module_ctx.read(path)Dosya sistemindeki bir dosyanın içeriğini okur.
Parametreler
Parametre | Açıklama |
---|---|
path
|
string; veya Etiket; veya yol;
gerekli dosyanın yolunu ekler. |
report_progress
None
module_ctx.report_progress(status='')
Bu depo veya modül uzantısının getirilmesiyle ilgili ilerleme durumunu günceller
.
Parametreler
Parametre | Açıklama |
---|---|
status
|
string;
varsayılan değer: '' getirme işleminin mevcut durumunu açıklayan dize |
root_module_has_non_dev_dependency
bool module_ctx.root_module_has_non_dev_dependencyKök modülün bu uzantıyı geliştirici dışı bir bağımlılık olarak kullanıp kullanmadığı.
hangi
path module_ctx.which(program)İlgili programın yolunu veya yolda böyle bir program yoksa Yok değerini döndürür.
Parametreler
Parametre | Açıklama |
---|---|
program
|
zorunlu programda bulabilirsiniz. |
None
sonucunu döndürebilir.