implementation
saat membuat ekstensi modul.
Anggota
- download
- download_and_extract
- eksekusi
- extension_metadata
- file
- is_dev_dependency
- is_isolated
- module
- os
- path
- baca
- report_progress
- root_module_has_non_dev_dependency
- yang
download
struct module_ctx.download(url, output='', sha256='', executable=False, allow_fail=False, canonical_id='', auth={}, *, integrity='')
success
, tanda berupa true
jika download berhasil diselesaikan, dan jika berhasil, hash file dengan kolom sha256
dan integrity
.
Parameter
Parameter | Deskripsi |
---|---|
url
|
string; or Iterable of strings ;
wajibDaftar URL hasil duplikasi yang merujuk pada file yang sama. |
output
|
string; or Label; or path ;
default = ''jalur ke file output, relatif terhadap direktori repositori. |
sha256
|
default = '' {i>hash<i} SHA-256 yang diharapkan dari file yang didownload. Ini harus cocok dengan hash SHA-256 file yang didownload. Menghilangkan SHA-256 karena file jarak jauh dapat berubah merupakan risiko keamanan. Sebaiknya menghilangkan kolom ini akan membuat build Anda menjadi non-hermetik. Hal ini bersifat opsional untuk mempermudah pengembangan, tetapi harus ditetapkan sebelum pengiriman. |
executable
|
default = Salah mengatur penanda yang dapat dieksekusi pada file yang dibuat, {i>false<i} secara {i>default<i}. |
allow_fail
|
default = Salah Jika ditetapkan, tunjukkan error dalam nilai yang ditampilkan, bukan menampilkan error untuk download yang gagal |
canonical_id
|
default = '' Jika ditetapkan, batasi hit cache ke kasus ketika file ditambahkan ke cache dengan ID kanonis yang sama |
auth
|
default = {} Dikte opsional yang menentukan informasi autentikasi untuk beberapa URL. |
integrity
|
default = '' Checksum yang diharapkan dari file yang didownload, dalam format Integritas Subresource. Ini harus cocok dengan checksum file yang didownload. Menghilangkan checksum karena file jarak jauh dapat berubah merupakan risiko keamanan. Sebaiknya menghilangkan kolom ini akan membuat build Anda menjadi non-hermetik. Hal ini bersifat opsional untuk mempermudah pengembangan, tetapi harus ditetapkan sebelum pengiriman. |
download_and_extract
struct module_ctx.download_and_extract(url, output='', sha256='', type='', stripPrefix='', allow_fail=False, canonical_id='', auth={}, *, integrity='', rename_files={})
success
, flag berupa true
jika download berhasil diselesaikan, dan jika berhasil, hash file dengan kolom sha256
dan integrity
.
Parameter
Parameter | Deskripsi |
---|---|
url
|
string; or Iterable of strings ;
wajibDaftar URL hasil duplikasi yang merujuk pada file yang sama. |
output
|
string; or Label; or path ;
default = ''jalur ke direktori tempat arsip akan dibongkar, relatif terhadap direktori repositori. |
sha256
|
default = '' {i>hash<i} SHA-256 yang diharapkan dari file yang didownload. Ini harus cocok dengan hash SHA-256 file yang didownload. Menghilangkan SHA-256 karena file jarak jauh dapat berubah merupakan risiko keamanan. Sebaiknya menghilangkan kolom ini akan membuat build Anda menjadi non-hermetik. Hal ini bersifat opsional untuk mempermudah pengembangan, tetapi harus ditetapkan sebelum pengiriman. Jika disediakan, cache repositori akan diperiksa terlebih dahulu untuk menemukan file dengan hash yang diberikan; download hanya akan dicoba jika file tidak ditemukan dalam cache. Setelah download berhasil, file akan ditambahkan ke cache. |
type
|
default = '' jenis arsip file yang diunduh. Secara default, jenis arsip ditentukan dari ekstensi file URL. Jika file tidak memiliki ekstensi, Anda dapat secara eksplisit menentukan "zip", "jar", "war", "aar", "tar", "tar.gz", "tgz", "tar.xz", "txz", ".tar.zst", ".tzst", "tar.bz2", ".ar", atau ".deb" di sini. |
stripPrefix
|
default = '' awalan direktori yang dihapus dari file yang diekstrak. Banyak arsip berisi direktori tingkat atas yang berisi semua file dalam arsip. Daripada harus menentukan awalan ini berulang kali di build_file , kolom ini dapat digunakan untuk menghapusnya dari file yang diekstrak.
|
allow_fail
|
default = Salah Jika ditetapkan, tunjukkan error dalam nilai yang ditampilkan, bukan menampilkan error untuk download yang gagal |
canonical_id
|
default = '' Jika ditetapkan, batasi hit cache ke kasus ketika file ditambahkan ke cache dengan ID kanonis yang sama |
auth
|
default = {} Dikte opsional yang menentukan informasi autentikasi untuk beberapa URL. |
integrity
|
default = '' Checksum yang diharapkan dari file yang didownload, dalam format Integritas Subresource. Ini harus cocok dengan checksum file yang didownload. Menghilangkan checksum karena file jarak jauh dapat berubah merupakan risiko keamanan. Sebaiknya menghilangkan kolom ini akan membuat build Anda menjadi non-hermetik. Hal ini bersifat opsional untuk mempermudah pengembangan, tetapi harus ditetapkan sebelum pengiriman. |
rename_files
|
default = {} Dik opsional yang menentukan file yang akan diganti namanya selama ekstraksi. Entri arsip dengan nama yang sama persis dengan kunci akan diganti namanya menjadi nilai sebelum penyesuaian awalan direktori apa pun. Ini dapat digunakan untuk mengekstrak arsip yang berisi nama file non-Unicode, atau yang memiliki file yang akan diekstrak ke jalur yang sama pada sistem file yang tidak peka huruf besar/kecil. |
execute
exec_result module_ctx.execute(arguments, timeout=600, environment={}, quiet=True, working_directory="")
timeout
(dalam detik, default 600 detik). Metode ini menampilkan struktur exec_result
yang berisi output perintah. Peta environment
dapat digunakan untuk mengganti beberapa variabel lingkungan yang akan diteruskan ke proses.
Parameter
Parameter | Deskripsi |
---|---|
arguments
|
wajib Daftar argumen, elemen pertama harus berupa jalur ke program yang akan dieksekusi. |
timeout
|
default = 600 durasi maksimum perintah dalam detik (defaultnya adalah 600 detik). |
environment
|
default = {} memaksa beberapa variabel lingkungan diatur untuk diteruskan ke proses. |
quiet
|
default = Benar Jika stdout dan stderr harus dicetak ke terminal. |
working_directory
|
default = "" Direktori kerja untuk eksekusi perintah. Dapat relatif terhadap root repositori atau absolut. |
extension_metadata
extension_metadata module_ctx.extension_metadata(root_module_direct_deps=None, root_module_direct_dev_deps=None)
Parameter
Parameter | Deskripsi |
---|---|
root_module_direct_deps
|
sequence of strings; or string; or None ;
default = Tidak adaNama-nama repositori yang dianggap ekstensi sebagai dependensi langsung dari modul root. Jika modul root mengimpor repositori tambahan atau tidak mengimpor semua repositori ini melalui use_repo , Bazel akan mencetak peringatan dan perintah perbaikan saat ekstensi dievaluasi.Jika salah satu dari Salah satu dari |
root_module_direct_dev_deps
|
sequence of strings; or string; or None ;
default = Tidak adaNama-nama repositori yang dianggap ekstensi sebagai dependensi dev langsung dari modul root. Jika modul root mengimpor repositori tambahan atau tidak mengimpor semua repositori ini melalui use_repo pada proxy ekstensi yang dibuat dengan use_extension(..., dev_dependency = True) , Bazel akan mencetak peringatan dan perintah perbaikan saat ekstensi dievaluasi.Jika salah satu dari Salah satu dari |
file
None module_ctx.file(path, content='', executable=True, legacy_utf8=True)
Parameter
Parameter | Deskripsi |
---|---|
path
|
string; or Label; or path ;
wajibjalur file yang akan dibuat, relatif terhadap direktori repositori. |
content
|
default = '' isi file yang akan dibuat, kosong secara {i>default<i}. |
executable
|
default = Benar menetapkan penanda yang dapat dieksekusi pada file yang dibuat, {i>true<i} secara {i>default<i}. |
legacy_utf8
|
default = Benar mengenkode konten file ke UTF-8, true secara default. Versi mendatang akan mengubah default dan menghapus parameter ini. |
is_dev_dependency
bool module_ctx.is_dev_dependency(tag)
devDependency = True
.
Parameter
Parameter | Deskripsi |
---|---|
tag
|
bazel_module_tag ;
wajibTag yang diperoleh dari bazel_module.tags. |
is_isolated
bool module_ctx.is_isolated
isolate = True
sehingga diisolasi dari semua penggunaan lainnya.
modul
list module_ctx.modules
OS
repository_os module_ctx.os
jalur
path module_ctx.path(path)
Parameter
Parameter | Deskripsi |
---|---|
path
|
string; or Label; or path ;
wajib{i>string<i}, label, atau jalur yang menjadi asal pembuatan jalur |
baca
string module_ctx.read(path)
Parameter
Parameter | Deskripsi |
---|---|
path
|
string; or Label; or path ;
wajibjalur file yang akan dibaca. |
report_progress
None module_ctx.report_progress(status='')
Parameter
Parameter | Deskripsi |
---|---|
status
|
string ;
default = ''string yang menjelaskan status progres pengambilan saat ini |
root_module_has_non_dev_dependency
bool module_ctx.root_module_has_non_dev_dependency
yang mana
path module_ctx.which(program)
Parameter
Parameter | Deskripsi |
---|---|
program
|
wajib Program yang akan ditemukan di jalur. |
None
.