depo

. Özelliklerle ilgili yardımcı işlevleri ve bilgileri içeren depo 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

struct repository_ctx.attr

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

delete

bool repository_ctx.delete(path)

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

Parametreler

Parametre Açıklama
path string; or path; gerekli
Silinecek dosyanın yolu (depo dizinine göre) veya mutlaktır. Bir yol veya dize olabilir.

indirme

struct repository_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; or Iterable of strings; gerekli
Aynı dosyaya referansta bulunan yansıtma URL'lerinin listesi.
output string; or Label; or path; varsayılan = ''
yolunu işaret eder.
sha256 varsayılan = ''
İ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 = Yanlış
oluşturulan dosyada yürütülebilir bayrağı varsayılan olarak false (yanlış) değerine ayarlayın.
allow_fail varsayılan = Yanlış
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 = ''
Ayarlanırsa önbellek isabetlerini, dosyanın önbelleğe aynı standart kimlikle eklendiği durumlarla sınırlandırın
auth default = {}
Bazı URL'lerin kimlik doğrulama bilgilerini belirten isteğe bağlı bir metin.
integrity varsayılan = ''
İ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 repository_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; or Iterable of strings; gerekli
Aynı dosyaya referansta bulunan yansıtma URL'lerinin listesi.
output string; or Label; or path; varsayılan = ''
arşivin paketten çıkarılacağı dizine giden yol.
sha256 varsayılan = ''
İ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 = ''
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, "zip", "jar", "war", "aar", "tar", "tar.gz", "tgz", "tar.xz", "txz", ".tar.zst", ".tzst", "tar.bz2", ".ar" veya ".deb" öğesini belirtebilirsiniz. burayı tıklayın.
stripPrefix varsayılan = ''
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 = Yanlış
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 = ''
Ayarlanırsa önbellek isabetlerini, dosyanın önbelleğe aynı standart kimlikle eklendiği durumlarla sınırlandırın
auth default = {}
Bazı URL'lerin kimlik doğrulama bilgilerini belirten isteğe bağlı bir metin.
integrity varsayılan = ''
İ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 default = {}
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 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ü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 = 600
komutun saniye cinsinden maksimum süresi (varsayılan değer 600 saniyedir).
environment default = {}
işleme tabi tutulması için bazı ortam değişkenlerinin ayarlanmasını zorunlu kılar.
quiet varsayılan = Doğru
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ü veya mutlak ile göreli olabilir.

ayıklama

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

Depo dizinine bir arşiv çıkarın.

Parametreler

Parametre Açıklama
archive string; or Label; or path; gerekli
yolu.
output string; or Label; or path; varsayılan = ''
arşivin paketten çıkarılacağı dizine giden yol.
stripPrefix varsayılan = ''
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.
rename_files default = {}
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.

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; or Label; or path; gerekli
depo dizininize göre belirlenecek dosyanın yolu.
content varsayılan = ''
dosyanın içeriği varsayılan olarak boştur.
executable varsayılan = Doğru
oluşturulan dosyada yürütülebilir işareti varsayılan olarak true olarak ayarlayın.
legacy_utf8 varsayılan = Doğru
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.

ad

string repository_ctx.name

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

işletim sistemi

repository_os repository_ctx.os

Sistemdeki bilgilere erişmek için bir struct.

patch

None repository_ctx.patch(patch_file, strip=0)

Harici deponun kök dizinine bir yama dosyası uygulayın. Yama dosyası, standart bir birleştirilmiş fark biçimi dosyası olmalıdır. Bazel'de yerel yama uygulaması, fuzz eşlemeyi ve yama komut satırı aracı gibi ikili yamayı desteklemez.

Parametreler

Parametre Açıklama
patch_file string; or Label; or path; gerekli
Uygulanacak yama dosyası; etiket, göreli yol veya mutlak yol olabilir. Göreli bir yolsa, kod deposu dizinine çözümlenir.
strip varsayılan = 0
belirtilen sayıda önde gelen bileşeni dosya adlarından ayırır.

yol

path repository_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; or Label; or path; gerekli
içinden yol oluşturacağınız dize, etiket veya yol

okuma

string repository_ctx.read(path)

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

Parametreler

Parametre Açıklama
path string; or Label; or path; gerekli
dosyanın yolunu ekler.

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 = ''
getirme işleminin mevcut durumunu açıklayan dize 

None repository_ctx.symlink(target, link_name)

Dosya sisteminde sembolik bir bağlantı oluşturur.

Parametreler

Parametre Açıklama
target string; or Label; or path; gerekli
Sembolik bağlantının işaret etmesi gereken yol.
string; or Label; or path; gerekli
Oluşturulacak sembolik bağlantının yolu (kod deposu dizinine göre).

şablon

None repository_ctx.template(path, template, substitutions={}, executable=True)

template kullanarak yeni bir dosya oluşturur. substitutions anahtarının template politikasında her geçtiği yer, ilgili değerle değiştirilecek. Sonuç path dilinde yazılır. Yürütülebilir biti açmak veya kapatmak için isteğe bağlı executable bağımsız değişkeni (varsayılan olarak true değerine ayarlanır) ayarlanabilir.

Parametreler

Parametre Açıklama
path string; or Label; or path; gerekli
depo dizininize göre belirlenecek dosyanın yolu.
template string; or Label; or path; gerekli
şablon dosyasının yoludur.
substitutions default = {}
temel öğeleri içerir.
executable varsayılan = Doğru
oluşturulan dosyada yürütülebilir işareti varsayılan olarak true olarak ayarlayın.

hangi

path repository_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.

workspace_root

path repository_ctx.workspace_root

Bazel çağrısının kök çalışma alanına giden yol.