Yardımcı işlevler ve özelliklerle ilgili bilgileri içeren depolama alanı kuralının bağlamı. Bir depo kuralı oluşturduğunuzda, implementation
işlevinin bağımsız değişkeni olarak bir repository_ctx nesnesi alırsınız.
Üyeler
- attr
- sil
- download
- download_and_extract
- yürütme
- extract
- file
- getenv
- name
- os
- yama
- path
- oku
- report_progress
- symlink
- şablonu
- watch
- watch_tree
- which
- workspace_root
özlk
struct repository_ctx.attr
delete
bool repository_ctx.delete(path)
Parametreler
Parametre | Açıklama |
---|---|
path
|
dize veya yol;
zorunlu Depo dizine göre veya mutlak olarak silinecek dosyanın yolu. Bir yol veya dize olabilir. |
indir
unknown repository_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 '' olan , indirilen 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. |
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 |
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ğ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. |
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 repository_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
|
dize veya dize öğelerinin Iterable dizisi;
zorunlu Aynı dosyaya atıfta bulunan ayna URL'lerin listesi. |
output
|
dize; veya Etiket; veya yol; varsayılan olarak, depo dizinine göre arşivin paketinin açılacağı dizine giden '' yoludur. |
sha256
|
varsayılan değer '' olan , indirilen 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. 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 '' olup indirilen dosyanın arşiv türüdü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", ".debar" veya ".debz" değerlerini açık bir şekilde 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 ü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.
|
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 |
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. |
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 repository_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
eşlemesi, 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 "" Komut yürütme için çalışma dizini. Depo köküne göre göreli veya mutlak olabilir. |
ayıklamak
None
repository_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 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. 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 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. |
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
repository_ctx.file(path, content='', executable=True, legacy_utf8=True)
Parametreler
Parametre | Açıklama |
---|---|
path
|
dize; veya Etiket; veya yol;
kod deposu dizinine göre oluşturulacak dosyanın gerekli yolu. |
content
|
varsayılan değer '' oluşturulacak dosyanın içeriğidir, varsayılan olarak boştur. |
executable
|
varsayılan olarak True şeklindediroluşturulan dosyadaki yürütülebilir işaret varsayılan olarak "doğru" olarak ayarlanır. |
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 repository_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.
ad
string repository_ctx.name
os
repository_os repository_ctx.os
patch
None
repository_ctx.patch(patch_file, strip=0, *, watch_patch='auto')
Parametreler
Parametre | Açıklama |
---|---|
patch_file
|
dize; veya Etiket; veya yol;
zorunlu Uygulanacak yama dosyası. Etiket, göreli yol veya mutlak yol olabilir. Göreli bir yolsa depo dizininde çözümlenir. |
strip
|
varsayılan olarak 0 şeklindedirbelirtilen sayıda önde gelen bileşeni dosya adlarından çıkarır. |
watch_patch
|
varsayılan değer 'auto' düzeltme 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).
|
yol
path repository_ctx.path(path)
Parametreler
Parametre | Açıklama |
---|---|
path
|
dize; veya Etiket; veya yol;
zorunlu yol oluşturmak için kullanılacak dize, etiket veya yol |
okuma
string repository_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
repository_ctx.report_progress(status='')
Parametreler
Parametre | Açıklama |
---|---|
status
|
string;
varsayılan değer '' getirme işleminin mevcut durumunu açıklayan dize |
sembolik bağlantı
None
repository_ctx.symlink(target, link_name)
Parametreler
Parametre | Açıklama |
---|---|
target
|
dize; veya Etiket; veya yol;
gerekli Sembolik bağlantının işaret etmesi gereken yol. |
link_name
|
dize; veya Etiket; veya yol;
gerekli Oluşturulacak sembolik bağlantının yolu. |
şablon
None
repository_ctx.template(path, template, substitutions={}, executable=True, *, watch_template='auto')
template
kullanarak yeni bir dosya oluşturur. template
içindeki substitutions
anahtarının her tekrarı, ilgili değerle değiştirilir. Sonuç path
dilinde yazılır. İsteğe bağlı birexecutable
bağımsız değişkeni (varsayılan olarak doğrudur) yürütülebilir bitini etkinleştirmek veya devre dışı bırakmak için ayarlanabilir.
Parametreler
Parametre | Açıklama |
---|---|
path
|
dize; veya Etiket; veya yol;
kod deposu dizinine göre oluşturulacak dosyanın gerekli yolu. |
template
|
dize; veya Etiket; veya yol;
zorunlu şablon dosyasının yolu. |
substitutions
|
varsayılan olarak şablon genişletilirken yapılacak {} değiştirme işlemidir. |
executable
|
varsayılan olarak True şeklindediroluşturulan dosyadaki yürütülebilir işaret varsayılan olarak "doğru" olarak ayarlanır. |
watch_template
|
varsayılan değer 'auto' şablon 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).
|
kol saati
None
repository_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 yolu izlemeye çalışan modül uzantıları da hatayla sonuçlanır.
Parametreler
Parametre | Açıklama |
---|---|
path
|
dize; veya Etiket; veya yol;
izlenecek dosyanın gerekli yoludur. |
watch_tree
None
repository_ctx.watch_tree(path)
Şu anda getirilmekte olan depodaki yolları izlemeye çalışmanın hatayla sonuçlanacağını unutmayın.
Parametreler
Parametre | Açıklama |
---|---|
path
|
dize; veya Etiket; veya yol;
zorunlu İzlenecek dizin ağacının yolu. |
hangi
path repository_ctx.which(program)
Parametreler
Parametre | Açıklama |
---|---|
program
|
required Yolda bulunacak program. |
None
değerini döndürebilir.
workspace_root
path repository_ctx.workspace_root