implementation khi tạo một tiện ích mô-đun.
Hội viên
- download
- download_and_extract
- thực thi
- extension_metadata
- tệp
- is_dev_dependency
- modules
- os
- path
- read
- report_progress
- root_module_has_non_dev_dependency
- which
tải xuống
struct module_ctx.download(url, output='', sha256='', executable=False, allow_fail=False, canonical_id='', auth={}, *, integrity='')
success, một cờ là true nếu quá trình tải xuống hoàn tất thành công và nếu thành công, thì đó là một hàm băm của tệp có các trường sha256 và integrity.
Thông số
| Thông số | Mô tả |
|---|---|
url
|
string; hoặc Iterable của strings; bắt buộc Danh sách các URL phản chiếu tham chiếu đến cùng một tệp. |
output
|
string; hoặc Label; hoặc path;
mặc định là ''đường dẫn đến tệp đầu ra, tương ứng với thư mục kho lưu trữ. |
sha256
|
mặc định là ''hàm băm SHA-256 dự kiến của tệp đã tải xuống. Giá trị này phải khớp với hàm băm SHA-256 của tệp đã tải xuống. Việc bỏ qua SHA-256 là một rủi ro bảo mật vì các tệp từ xa có thể thay đổi. Tốt nhất là việc bỏ qua trường này sẽ khiến bản dựng của bạn không khép kín. Bạn không bắt buộc phải đặt để phát triển dễ dàng hơn, nhưng bạn nên đặt trước khi vận chuyển. |
executable
|
mặc định là Falseđặt cờ thực thi trên tệp đã tạo, mặc định là false. |
allow_fail
|
mặc định là FalseNếu được đặt, hãy cho biết lỗi trong giá trị trả về thay vì báo lỗi cho các lượt tải xuống không thành công |
canonical_id
|
mặc định là ''Nếu được đặt, hãy hạn chế các lượt truy cập bộ nhớ đệm đối với những trường hợp mà tệp được thêm vào bộ nhớ đệm có cùng mã nhận dạng chuẩn |
auth
|
mặc định là {}Một từ điển không bắt buộc chỉ định thông tin xác thực cho một số URL. |
integrity
|
mặc định là ''Tổng kiểm tra dự kiến của tệp đã tải xuống, ở định dạng Tính toàn vẹn của tài nguyên phụ. Giá trị này phải khớp với tổng kiểm của tệp đã tải xuống. Việc bỏ qua tổng kiểm tra là một rủi ro bảo mật vì các tệp từ xa có thể thay đổi. Tốt nhất là việc bỏ qua trường này sẽ khiến bản dựng của bạn không khép kín. Bạn không bắt buộc phải đặt để phát triển dễ dàng hơn, nhưng bạn nên đặt trước khi vận chuyển. |
download_and_extract
struct module_ctx.download_and_extract(url, output='', sha256='', type='', stripPrefix='', allow_fail=False, canonical_id='', auth={}, *, integrity='', rename_files={})
success, một cờ là true nếu quá trình tải xuống hoàn tất thành công và nếu thành công, thì một hàm băm của tệp có các trường sha256 và integrity.
Thông số
| Thông số | Mô tả |
|---|---|
url
|
string; hoặc Iterable của strings; bắt buộc Danh sách các URL phản chiếu tham chiếu đến cùng một tệp. |
output
|
string; hoặc Label; hoặc path;
mặc định là ''đường dẫn đến thư mục nơi kho lưu trữ sẽ được giải nén, tương ứng với thư mục kho lưu trữ. |
sha256
|
mặc định là ''hàm băm SHA-256 dự kiến của tệp đã tải xuống. Giá trị này phải khớp với hàm băm SHA-256 của tệp đã tải xuống. Việc bỏ qua SHA-256 là một rủi ro bảo mật vì các tệp từ xa có thể thay đổi. Tốt nhất là việc bỏ qua trường này sẽ khiến bản dựng của bạn không khép kín. Bạn không bắt buộc phải đặt để phát triển dễ dàng hơn, nhưng bạn nên đặt trước khi vận chuyển. Nếu được cung cấp, trước tiên, bộ nhớ đệm kho lưu trữ sẽ được kiểm tra để tìm một tệp có hàm băm đã cho; quá trình tải xuống sẽ chỉ được thực hiện nếu không tìm thấy tệp trong bộ nhớ đệm. Sau khi tải xuống thành công, tệp sẽ được thêm vào bộ nhớ đệm. |
type
|
mặc định là ''loại tệp lưu trữ của tệp đã tải xuống. Theo mặc định, loại tệp lưu trữ được xác định từ đuôi tệp của URL. Nếu tệp không có đuôi, bạn có thể chỉ định rõ "zip", "jar", "war", "aar", "tar", "tar.gz", "tgz", "tar.xz", "txz", ".tar.zst", ".tzst", "tar.bz2", ".tbz", ".ar" hoặc ".deb" tại đây. |
stripPrefix
|
mặc định là '', một tiền tố thư mục cần loại bỏ khỏi các tệp đã trích xuất. Nhiều tệp lưu trữ chứa một thư mục cấp cao nhất chứa tất cả các tệp trong tệp lưu trữ. Thay vì phải chỉ định tiền tố này nhiều lần trong build_file, bạn có thể dùng trường này để loại bỏ tiền tố khỏi các tệp đã trích xuất.
|
allow_fail
|
mặc định là FalseNếu được đặt, hãy cho biết lỗi trong giá trị trả về thay vì báo lỗi cho các lượt tải xuống không thành công |
canonical_id
|
mặc định là ''Nếu được đặt, hãy hạn chế các lượt truy cập bộ nhớ đệm đối với những trường hợp mà tệp được thêm vào bộ nhớ đệm có cùng mã nhận dạng chuẩn |
auth
|
mặc định là {}Một từ điển không bắt buộc chỉ định thông tin xác thực cho một số URL. |
integrity
|
mặc định là ''Tổng kiểm tra dự kiến của tệp đã tải xuống, ở định dạng Tính toàn vẹn của tài nguyên phụ. Giá trị này phải khớp với tổng kiểm của tệp đã tải xuống. Việc bỏ qua tổng kiểm tra là một rủi ro bảo mật vì các tệp từ xa có thể thay đổi. Tốt nhất là việc bỏ qua trường này sẽ khiến bản dựng của bạn không khép kín. Bạn không bắt buộc phải đặt để phát triển dễ dàng hơn, nhưng bạn nên đặt trước khi vận chuyển. |
rename_files
|
mặc định là {}Một từ điển không bắt buộc chỉ định các tệp cần đổi tên trong quá trình trích xuất. Các mục lưu trữ có tên khớp chính xác với một khoá sẽ được đổi tên thành giá trị, trước khi có bất kỳ điều chỉnh nào về tiền tố thư mục. Bạn có thể dùng tuỳ chọn này để trích xuất những tệp lưu trữ có tên tệp không phải là Unicode hoặc có các tệp sẽ được trích xuất vào cùng một đường dẫn trên các hệ thống tệp không phân biệt chữ hoa chữ thường. |
thực thi
exec_result module_ctx.execute(arguments, timeout=600, environment={}, quiet=True, working_directory="")
timeout (tính bằng giây, mặc định là 600 giây). Phương thức này trả về một cấu trúc exec_result chứa đầu ra của lệnh. Bạn có thể dùng bản đồ environment để ghi đè một số biến môi trường sẽ được truyền đến quy trình.
Thông số
| Thông số | Mô tả |
|---|---|
arguments
|
required Danh sách đối số, phần tử đầu tiên phải là đường dẫn đến chương trình cần thực thi. |
timeout
|
mặc định là 600thời lượng tối đa của lệnh tính bằng giây (mặc định là 600 giây). |
environment
|
mặc định là {}buộc một số biến môi trường phải được đặt để truyền đến quy trình. |
quiet
|
mặc định là TrueNếu stdout và stderr sẽ được in ra thiết bị đầu cuối. |
working_directory
|
mặc định là ""Thư mục đang hoạt động để thực thi lệnh. Có thể tương đối với thư mục gốc của kho lưu trữ hoặc tuyệt đối. |
extension_metadata
extension_metadata module_ctx.extension_metadata(root_module_direct_deps=None, root_module_direct_dev_deps=None)
Thông số
| Thông số | Mô tả |
|---|---|
root_module_direct_deps
|
sequence của string; hoặc string; hoặc None;
mặc định là NoneTên của các kho lưu trữ mà tiện ích coi là phần phụ thuộc trực tiếp của mô-đun gốc. Nếu mô-đun gốc nhập các kho lưu trữ bổ sung hoặc không nhập tất cả các kho lưu trữ này thông qua use_repo, Bazel sẽ in một cảnh báo và lệnh sửa lỗi khi tiện ích được đánh giá.Nếu bạn chỉ định một trong hai thuộc tính Bạn có thể đặt chính xác một trong |
root_module_direct_dev_deps
|
sequence của string; hoặc string; hoặc None;
mặc định là NoneTên của các kho lưu trữ mà tiện ích coi là phần phụ thuộc trực tiếp của nhà phát triển đối với mô-đun gốc. Nếu mô-đun gốc nhập các kho lưu trữ bổ sung hoặc không nhập tất cả các kho lưu trữ này thông qua use_repo trên một proxy tiện ích được tạo bằng use_extension(..., dev_dependency = True), Bazel sẽ in một cảnh báo và một lệnh sửa lỗi khi tiện ích được đánh giá.Nếu bạn chỉ định một trong hai thuộc tính Bạn có thể đặt chính xác một trong |
tệp
None module_ctx.file(path, content='', executable=True, legacy_utf8=True)Thông số
| Thông số | Mô tả |
|---|---|
path
|
string; hoặc Label; hoặc path;
required đường dẫn của tệp cần tạo, tương ứng với thư mục kho lưu trữ. |
content
|
mặc định là ''nội dung của tệp cần tạo, theo mặc định là trống. |
executable
|
mặc định là Trueđặt cờ thực thi trên tệp đã tạo, theo mặc định là true. |
legacy_utf8
|
mặc định là Truemã hoá nội dung tệp thành UTF-8, mặc định là true. Các phiên bản trong tương lai sẽ thay đổi giá trị mặc định và xoá tham số này. |
is_dev_dependency
bool module_ctx.is_dev_dependency(tag)
devDependency = True hay không.
Thông số
| Thông số | Mô tả |
|---|---|
tag
|
bazel_module_tag;
required Thẻ nhận được từ bazel_module.tags. |
mô-đun
list module_ctx.modules
hệ điều hành
repository_os module_ctx.os
đường dẫn
path module_ctx.path(path)
Thông số
| Thông số | Mô tả |
|---|---|
path
|
string; hoặc Label; hoặc path;
required string, label hoặc path mà từ đó tạo ra một đường dẫn |
đọc
string module_ctx.read(path)
Thông số
| Thông số | Mô tả |
|---|---|
path
|
string; hoặc Label; hoặc path;
required đường dẫn của tệp cần đọc. |
report_progress
None module_ctx.report_progress(status='')Thông số
| Thông số | Mô tả |
|---|---|
status
|
string;
default is ''string mô tả trạng thái hiện tại của tiến trình tìm nạp |
root_module_has_non_dev_dependency
bool module_ctx.root_module_has_non_dev_dependency
thiết bị nào
path module_ctx.which(program)
Thông số
| Thông số | Mô tả |
|---|---|
program
|
required Chương trình cần tìm trong đường dẫn. |
None.