depo

Yardımcı işlevler ve özelliklerle ilgili bilgileri içeren depo kuralının bağlamı. Depo kuralı oluşturduğunuzda implementation işlevine bağımsız değişken olarak bir repository_ctx nesnesi iletilir.

Üyeler

attr

struct repository_ctx.attr

Özelliklerin değerlerine erişmek için kullanılan bir yapı. Değerler kullanıcı tarafından sağlanır (sağlanmazsa varsayılan değer kullanılır).

delete

bool repository_ctx.delete(path)

Bir dosyayı veya dizini siler. Dosyanın veya dizinin bu çağrı tarafından gerçekten silinip silinmediğini belirten bir bool değeri döndürür.

Parametreler

Parametre Açıklama
path dize veya yol; zorunlu
Silinecek dosyanın, depo dizinine göre göreli veya mutlak yolu. Yol veya dize olabilir.

indir

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

Belirtilen URL'deki dosyayı çıkış yoluna indirir ve success içeren bir yapı döndürür. Bu yapı, indirme işlemi başarıyla tamamlandıysa true olan bir işarettir. Başarılı olursa sha256 ve integrity alanlarıyla birlikte dosyanın karmasını içerir. sha256 veya integrity kullanıcı tarafından belirtildiğinde açık bir canonical_id ayarlanması önemle tavsiye edilir. Örneğin: get_default_canonical_id

Parametreler

Parametre Açıklama
url dize veya dize yinelemesi; zorunlu
Aynı dosyaya referans veren yansıtma URL'lerinin listesi.
output string; veya Label; veya path; varsayılan değer ''
çıktı dosyasının yolu (depo dizinine göre).
sha256 Varsayılan değer ''
'dir. İndirilen 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'yı atlamak güvenlik riski oluşturur. Bu alanın atlanması, en iyi ihtimalle derlemenizin hermetik olmamasına neden olur. Geliştirmeyi kolaylaştırmak için isteğe bağlıdır ancak gönderimden önce ayarlanmalıdır. Sağlanırsa önce verilen karma ile bir dosya için depo önbelleği kontrol edilir. Yalnızca dosya önbellekte bulunamazsa indirme işlemi denenir. Başarılı bir indirme işleminden sonra dosya önbelleğe eklenir.
executable Varsayılan değer False
'dir. Oluşturulan dosyada yürütülebilir işaretini ayarlayın. Varsayılan olarak false değerini alır.
allow_fail Varsayılan değer False
'dir. Ayarlanırsa başarısız indirmeler için hata oluşturmak yerine döndürülen değerde hatayı belirtin.
canonical_id Varsayılan değer ''
Ayarlanırsa önbellek isabetlerini, dosyanın önbelleğe aynı kanonik kimlikle eklendiği durumlarla sınırlandırı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 {}
Tüm URL'ler için HTTP üstbilgilerini belirten isteğe bağlı bir sözlük.
integrity Varsayılan değer ''
'dir. İndirilen dosyanın, alt kaynak bütünlüğü biçimindeki 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ı atlamak güvenlik riski oluşturur. Bu alanın atlanması, en iyi ihtimalle derlemenizin hermetik olmamasına neden olur. Geliştirmeyi kolaylaştırmak için isteğe bağlıdır ancak gönderimden önce ayarlanmalıdır. Sağlanırsa önce verilen sağlama toplamına sahip bir dosya için depo önbelleği kontrol edilir. Yalnızca dosya önbellekte bulunamazsa indirme işlemi denenir. Başarılı bir indirme işleminden sonra dosya önbelleğe eklenir.
block varsayılan değer True
false olarak ayarlanırsa çağrı hemen döndürülür ve normal dönüş değeri yerine, indirme işlemi tamamlanana kadar engellenen ve normal dönüş değerini döndüren veya her zamanki gibi hata veren tek bir yönteme (wait()) sahip 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={})

Belirtilen URL için bir dosyayı çıkış yoluna indirir, dosyayı ayıklar ve success içeren bir yapı döndürür. Bu yapı, indirme işlemi başarıyla tamamlandıysa true olan bir işaret ve başarılıysa sha256 ve integrity alanlarını içeren dosyanın karmasını içerir. sha256 veya integrity kullanıcı tarafından belirtildiğinde açık bir canonical_id ayarlanması önemle tavsiye edilir. Örneğin: get_default_canonical_id

Parametreler

Parametre Açıklama
url dize veya dize yinelemesi; zorunlu
Aynı dosyaya referans veren yansıtma URL'lerinin listesi.
output string; veya Label; veya path; varsayılan değer ''
Arşivin açılacağı dizinin yolu (depo dizinine göre).
sha256 Varsayılan değer ''
'dir. İndirilen 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'yı atlamak güvenlik riski oluşturur. Bu alanın atlanması, en iyi ihtimalle derlemenizin hermetik olmamasına neden olur. Geliştirmeyi kolaylaştırmak için isteğe bağlıdır ancak gönderimden önce ayarlanmalıdır. Sağlanırsa önce verilen karma ile bir dosya için depo önbelleği kontrol edilir. Yalnızca dosya önbellekte bulunamazsa indirme işlemi denenir. Başarılı bir indirme işleminden sonra dosya önbelleğe eklenir.
type Varsayılan değer ''
'dir. İndirilen dosyanın arşiv türü. Varsayılan olarak, arşiv türü 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ı açıkça belirtebilirsiniz.
stripPrefix Varsayılan değer ''
'dir. Çıkarılan dosyalardan kaldırılacak bir dizin öneki. Birçok arşivde, arşivdeki tüm dosyaları içeren üst düzey bir dizin bulunur. Bu öneki build_file içinde tekrar tekrar belirtmek yerine, bu alan çıkarılan dosyalardan öneki kaldırmak için kullanılabilir.
allow_fail Varsayılan değer False
'dir. Ayarlanırsa başarısız indirmeler için hata oluşturmak yerine döndürülen değerde hatayı belirtin.
canonical_id Varsayılan değer ''
Ayarlanırsa önbellek isabetlerini, dosyanın önbelleğe aynı kanonik kimlikle eklendiği durumlarla sınırlandırı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 değer ''
'dir. İndirilen dosyanın, alt kaynak bütünlüğü biçimindeki 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ı atlamak güvenlik riski oluşturur. Bu alanın atlanması, en iyi ihtimalle derlemenizin hermetik olmamasına neden olur. Geliştirmeyi kolaylaştırmak için isteğe bağlıdır ancak gönderimden önce ayarlanmalıdır. Sağlanırsa önce verilen sağlama toplamına sahip bir dosya için depo önbelleği kontrol edilir. Yalnızca dosya önbellekte bulunamazsa indirme işlemi denenir. Başarılı bir indirme işleminden sonra dosya önbelleğe eklenir.
rename_files Varsayılan değer {}
'dir. Çıkarma işlemi 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 öneki ayarlanmadan önce değer olarak yeniden adlandırılır. Bu seçenek, Unicode olmayan dosya adları içeren veya büyük/küçük harfe duyarsız dosya sistemlerinde aynı yola çıkarılacak dosyaları olan arşivleri çıkarmak için kullanılabilir.

execute

exec_result repository_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ütme süresi timeout ile sınırlıdır (saniye cinsinden, varsayılan değer 600 saniyedir). Bu yöntem, komutun çıkışı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 zorunlu
Bağımsız değişkenlerin listesi. İlk öğe, yürütülecek 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 {}
'dir. Bazı ortam değişkenlerinin işleme iletilecek şekilde ayarlanmasını zorlar.
quiet Varsayılan değer True
'dir. stdout ve stderr'in terminale yazdırılıp yazdırılmayacağı.
working_directory Varsayılan değer ""
'dir. 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.

ayıklama

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

Arşivi depo dizinine çıkarın.

Parametreler

Parametre Açıklama
archive string; veya Label; veya path; required
path to the archive that will be unpacked, relative to the repository directory.
output string; veya Label; veya path; varsayılan değer ''
arşivin açılacağı dizinin yolu (depo dizinine göre).
stripPrefix Varsayılan değer ''
çıkarılan dosyalardan kaldırılacak bir dizin önekidir. Birçok arşivde, arşivdeki tüm dosyaları içeren üst düzey bir dizin bulunur. Bu öneki build_file içinde tekrar tekrar belirtmek yerine, bu alan çıkarılan dosyalardan öneki kaldırmak için kullanılabilir.
rename_files Varsayılan değer {}
'dir. Çıkarma işlemi 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 öneki ayarlanmadan önce değer olarak yeniden adlandırılır. Bu seçenek, Unicode olmayan dosya adları içeren veya büyük/küçük harfe duyarsız dosya sistemlerinde aynı yola çıkarılacak dosyaları olan arşivleri çıkarmak için kullanılabilir.
watch_archive varsayılan değer 'auto'
Arşiv dosyasının izlenip izlenmeyeceği. "yes", "no" veya "auto" dizesi olabilir. "yes" değerini iletmek, watch() yöntemini hemen çağırmaya eşdeğerdir; "no" değerini iletmek, dosyayı izlemeye çalışmaz; "auto" değerini iletmek ise dosyayı yalnızca yasal olarak izlemek mümkün olduğunda izlemeye çalışır (daha fazla bilgi için watch() belgelerine bakın).

dosya

None repository_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 Label; veya path; required
Depo dizinine göre oluşturulacak dosyanın yolu.
content varsayılan değer ''
Oluşturulacak dosyanın içeriği. Varsayılan olarak boştur.
executable varsayılan değer True
Oluşturulan dosyada yürütülebilir işaretini ayarlayın (varsayılan olarak true).
legacy_utf8 varsayılan değer True
Dosya içeriğini UTF-8 olarak kodlayın. Varsayılan olarak true değerini alır. Gelecekteki sürümlerde varsayılan değer değiştirilecek ve bu parametre kaldırılacak.

getenv

string repository_ctx.getenv(name, default=None)

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

Artımlı olarak oluştururken name ile adlandırılan değişkenin değerinde yapılan herhangi bir değişiklik, bu deponun yeniden getirilmesine neden olur.

Parametreler

Parametre Açıklama
name string; required
Name of desired environment variable.
default dize veya None; varsayılan değer None
name bulunamazsa döndürülecek varsayılan değer.
İade edilebilir None.

ad

string repository_ctx.name

Bu kural tarafından oluşturulan harici deponun adı.

os

repository_os repository_ctx.os

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

patch

None repository_ctx.patch(patch_file, strip=0, *, watch_patch='auto')

Harici deponun kök dizinine bir yama dosyası uygulayın. Yama dosyası, standart bir birleştirilmiş farklılık biçimi dosyası olmalıdır. Bazel'e özgü yama uygulaması, yama komut satırı aracı gibi yaklaşık eşleşmeyi ve ikili yamayı desteklemez.

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 yol ise depo dizinine çözümlenir.
strip Varsayılan değer 0
Belirtilen sayıda öndeki bileşeni dosya adlarından kaldırın.
watch_patch Varsayılan değer 'auto'
'dir. Yama dosyasının izlenip izlenmeyeceği. "yes", "no" veya "auto" dizesi olabilir. "yes" değerini iletmek, watch() yöntemini hemen çağırmaya eşdeğerdir; "no" değerini iletmek, dosyayı izlemeye çalışmaz; "auto" değerini iletmek ise dosyayı yalnızca yasal olarak izlemek mümkün olduğunda izlemeye çalışır (daha fazla bilgi için watch() belgelerine bakın).

yol

path repository_ctx.path(path)

Dize, etiket veya yoldan bir yol döndürür. Yol göreliyse depo 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 bu nedenle hedef sonuca bağlı olamayacağını unutmayın (etiket, oluşturulmamış bir dosyayı işaret etmelidir). Yol bir yol ise bu yolu olduğu gibi döndürür.

Parametreler

Parametre Açıklama
path string; veya Label; veya path; required
string, Label veya path.

okuma

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

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

Parametreler

Parametre Açıklama
path string; veya Label; veya path; required
Okunacak dosyanın yolu.
watch Varsayılan değer 'auto'
'dir. Dosyanın izlenip izlenmeyeceği. "yes", "no" veya "auto" dizesi olabilir. "yes" değerini iletmek, watch() yöntemini hemen çağırmaya eşdeğerdir; "no" değerini iletmek, dosyayı izlemeye çalışmaz; "auto" değerini iletmek ise dosyayı yalnızca yasal olarak izlemek mümkün olduğunda izlemeye çalışır (daha fazla bilgi için watch() belgelerine bakın).

report_progress

None repository_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 ''
string getirme işleminin mevcut durumunu açıklar. 

None repository_ctx.symlink(target, link_name)

Dosya sisteminde sembolik bağlantı oluşturur.

Parametreler

Parametre Açıklama
target dize; veya Etiket; veya yol; zorunlu
Sembolik bağlantının işaret etmesi gereken yol.
string; veya Label; veya path; required
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 her substitutions anahtarı, ilgili değerle değiştirilir. Sonuç, path dilinde yazılır. Yürütülebilir biti açmak veya kapatmak için isteğe bağlı bir executable bağımsız değişken (varsayılan olarak doğru) ayarlanabilir.

Parametreler

Parametre Açıklama
path string; veya Label; veya path; required
Depo dizinine göre oluşturulacak dosyanın yolu.
template string; veya Label; veya path; required
Şablon dosyasının yolu.
substitutions varsayılan değer {}
Şablon genişletilirken yapılacak değiştirmeler.
executable varsayılan değer True
Oluşturulan dosyada yürütülebilir işaretini ayarlayın (varsayılan olarak true).
watch_template Varsayılan değer 'auto'
'dir. Şablon dosyasının izlenip izlenmeyeceği. "yes", "no" veya "auto" dizesi olabilir. "yes" değerini iletmek, watch() yöntemini hemen çağırmaya eşdeğerdir; "no" değerini iletmek, dosyayı izlemeye çalışmaz; "auto" değerini iletmek ise dosyayı yalnızca yasal olarak izlemek mümkün olduğunda izlemeye çalışır (daha fazla bilgi için watch() belgelerine bakın).

kol saati

None repository_ctx.watch(path)

Bazel'e, belirtilen yolda değişiklik olup olmadığını (yolun mevcut olup olmadığı veya dosya ya da dizin olup olmadığına bakılmaksızın) izlemesini söyler. Dosyada veya dizinde yapılan değişiklikler bu depo ya da modül uzantısını geçersiz kılar ve bir sonraki sefer yeniden getirilmesine veya yeniden değerlendirilmesine neden olur.

"Değişiklikler" arasında dosyanın içeriğinde yapılan değişiklikler (yol bir dosya ise), yolun daha önce dosya olup şimdi dizin olması veya tam tersi ve yolun var olmaya başlaması ya da sonlanması yer alır. Özellikle, yol bir dizinse bu işlem dizin altındaki dosyalarda yapılan değişiklikleri içermez. Bunun için path.readdir() politikasını kullanın.

Şu anda getirilen depodaki veya mevcut modül uzantısının çalışma dizinindeki yolları izlemeye çalışmanın hataya neden olacağını unutmayın. Geçerli Bazel çalışma alanının dışındaki bir yolu izlemeye çalışan bir modül uzantısı da hataya neden olur.

Parametreler

Parametre Açıklama
path string; veya Label; veya path; required
İzlenecek dosyanın yolu.

watch_tree

None repository_ctx.watch_tree(path)

Bazel'e, belirtilen yolun altında geçişli olarak bulunan dosya veya dizinlerdeki değişiklikleri izlemesini söyler. Dosya içeriklerinde, dosya veya dizinlerin varlığında, dosya adlarında ya da dizin adlarında yapılan değişiklikler bu deponun yeniden getirilmesine neden olur.

Şu anda getirilen depodaki yolları izlemeye çalışmanın hataya neden olacağını unutmayın.

Parametreler

Parametre Açıklama
path string; veya Label; veya path; required
İzlenecek dizin ağacının yolu.

hangi

path repository_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 gerekli
Yolda bulunacak program.
İade edilebilir None.

workspace_root

path repository_ctx.workspace_root

Bazel çağrısının kök çalışma alanının yolu.