mô-đun_lợi_dụng_của_người_dùng

Báo cáo vấn đề Xem nguồn

Ngữ cảnh của tiện ích mô-đun chứa các hàm trợ giúp và thông tin về các thẻ thích hợp trên biểu đồ phần phụ thuộc. Bạn sẽ nhận được đối tượng module_ctx làm đối số cho hàm implementation khi tạo tiện ích mô-đun.

Thành viên

tải xuống

struct module_ctx.download(url, output='', sha256='', executable=False, allow_fail=False, canonical_id='', auth={}, *, integrity='')

Tải tệp xuống đường dẫn đầu ra cho url được cung cấp và trả về cấu trúc có chứa success, cờ này 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, hàm băm của tệp có các trường sha256 và integrity.

Các tham số

Thông số Nội dung mô tả
url string; or Iterable of strings; bắt buộc
Danh sách các URL phản chiếu tham chiếu cùng một tệp.
output string; or Label; or path; default = ''
đường dẫn đến tệp đầu ra, liên quan đến thư mục kho lưu trữ.
sha256 default = ''
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 được 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à bỏ qua trường này sẽ tạo bản dựng không có dấu vết. Bạn không bắt buộc phải thiết lập để phát triển dễ dàng hơn nhưng nên đặt trước khi vận chuyển.
executable default = False
đặt cờ thực thi trên tệp đã tạo, false theo mặc định.
allow_fail default = False
Nếu được đặt, hãy chỉ ra 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 default = ''
Nếu được đặt, hãy hạn chế lượt truy cập bộ nhớ đệm vào các trường hợp tệp được thêm vào bộ nhớ đệm có cùng mã chuẩn
auth default = {}
Lệnh không bắt buộc xác định thông tin xác thực cho một số URL.
integrity default = ''
Giá trị tổng kiểm 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 giá trị tổng 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à bỏ qua trường này sẽ tạo bản dựng không có dấu vết. Bạn không bắt buộc phải thiết lập để phát triển dễ dàng hơn nhưng 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={})

Tải một tệp xuống đường dẫn đầu ra cho URL được cung cấp, trích xuất tệp đó và trả về cấu trúc có chứa success. Cờ này 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, hàm băm của tệp có các trường sha256 và integrity.

Các tham số

Thông số Nội dung mô tả
url string; or Iterable of strings; bắt buộc
Danh sách các URL phản chiếu tham chiếu cùng một tệp.
output string; or Label; or path; default = ''
đường dẫn đến thư mục nơi kho lưu trữ sẽ được giải nén, liên quan đến thư mục kho lưu trữ.
sha256 default = ''
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 được 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à bỏ qua trường này sẽ tạo bản dựng không có dấu vết. Bạn không bắt buộc phải thiết lập để phát triển dễ dàng hơn nhưng nên đặt trước khi vận chuyển. Nếu được cung cấp, trước tiên, bộ nhớ cache của kho lưu trữ sẽ được kiểm tra xem có tệp đã cho hay không; hệ thống sẽ chỉ thử tải xuống 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 default = ''
loại lưu trữ của tệp đã tải xuống. Theo mặc định, loại 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 default = ''
là tiền tố thư mục cần tách khỏi các tệp được trích xuất. Nhiều lưu trữ chứa thư mục cấp cao nhất chứa tất cả các tệp trong lưu trữ. Thay vì phải chỉ định nhiều lần tiền tố này trong build_file, bạn có thể sử dụng trường này để tách tiền khỏi các tệp được trích xuất.
allow_fail default = False
Nếu được đặt, hãy chỉ ra 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 default = ''
Nếu được đặt, hãy hạn chế lượt truy cập bộ nhớ đệm vào các trường hợp tệp được thêm vào bộ nhớ đệm có cùng mã chuẩn
auth default = {}
Lệnh không bắt buộc xác định thông tin xác thực cho một số URL.
integrity default = ''
Giá trị tổng kiểm 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 giá trị tổng 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à bỏ qua trường này sẽ tạo bản dựng không có dấu vết. Bạn không bắt buộc phải thiết lập để phát triển dễ dàng hơn nhưng nên đặt trước khi vận chuyển.
rename_files default = {}
Lệnh chính tả 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. Mục nhập lưu trữ với tên khớp chính xác với một khóa sẽ được đổi tên thành giá trị, trước bất kỳ điều chỉnh tiền tố thư mục nào. Bạn có thể sử dụng tệp này để trích xuất các tệp lưu trữ chứa tên tệp không phải Unicode hoặc các tệp có chứa tệp sẽ 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="")

Thực thi lệnh được cung cấp trong danh sách các đối số. Thời gian thực thi lệnh sẽ có giới hạn là 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 dữ liệu đầu ra của lệnh. Bản đồ environment có thể dùng để ghi đè một số biến môi trường cần chuyển vào quy trình.

Các tham số

Thông số Nội dung mô tả
arguments bắt buộc
Danh sách các đối số, phần tử đầu tiên phải là đường dẫn đến chương trình để thực thi.
timeout default = 600
thời lượng tối đa của lệnh tính bằng giây (mặc định là 600 giây).
environment default = {}
buộc một số biến môi trường cần được đặt để được chuyển vào quy trình.
quiet default = True
Nếu stdout và stderr nên được in trên thiết bị đầu cuối.
working_directory default = ""
Thư mục đang làm việc để thực thi lệnh. Có thể liên quan đến thư mục gốc hoặc tuyệt đối của kho lưu trữ.

tệp

None module_ctx.file(path, content='', executable=True, legacy_utf8=True)

Tạo một tệp trong thư mục kho lưu trữ có nội dung được cung cấp.

Các tham số

Thông số Nội dung mô tả
path string; or Label; or path; bắt buộc
đường dẫn của tệp cần tạo, so với thư mục kho lưu trữ.
content default = ''
nội dung của tệp cần tạo, trống theo mặc định.
executable default = True
đặt cờ thực thi trên tệp đã tạo, true theo mặc định.
legacy_utf8 default = True
mã hoá nội dung tệp thành UTF-8, true theo mặc định. Các phiên bản trong tương lai sẽ thay đổi mặc định và xóa thông số này.

is_dev_dependency

bool module_ctx.is_dev_dependency(tag)

Trả về việc thẻ đã cho có được chỉ định dựa trên kết quả của lệnh gọi use_extension với devDependency = True hay không.

Các tham số

Thông số Nội dung mô tả
tag bazel_module_tag; bắt buộc
Một thẻ nhận được từ bazel_module.tags.

mô-đun

list module_ctx.modules

Danh sách tất cả các mô-đun Bazel trong biểu đồ phần phụ thuộc bên ngoài, mỗi mô-đun là một đối tượng bazel_modules cho thấy tất cả các thẻ đã chỉ định cho tiện ích mô-đun này. Thứ tự lặp lại của từ điển này được đảm bảo giống với tìm kiếm theo chiều rộng đầu tiên bắt đầu từ mô-đun gốc.

hệ điều hành

repository_os module_ctx.os

Cấu trúc để truy cập thông tin từ hệ thống.

path

path module_ctx.path(path)

Trả về một đường dẫn từ một chuỗi, nhãn hoặc đường dẫn. Nếu đường dẫn tương đối, nó sẽ phân giải tương đối so với thư mục lưu trữ. Nếu đường dẫn là một nhãn, nó sẽ phân giải thành đường dẫn của tệp tương ứng. Lưu ý rằng các kho lưu trữ từ xa được thực thi trong giai đoạn phân tích nên không thể phụ thuộc vào kết quả mục tiêu (nhãn phải trỏ đến tệp không được tạo). Nếu là một đường dẫn, đường dẫn đó sẽ trả về đường dẫn đó như hiện tại.

Các tham số

Thông số Nội dung mô tả
path string; or Label; or path; bắt buộc
chuỗi, nhãn hoặc đường dẫn để tạo đường dẫn

đọc

string module_ctx.read(path)

Đọc nội dung của một tệp trên hệ thống tệp.

Các tham số

Thông số Nội dung mô tả
path string; or Label; or path; đường dẫn
bắt buộc của tệp để đọc.

tiến_độ_báo_cáo

None module_ctx.report_progress(status='')

Cập nhật trạng thái tiến trình tìm nạp kho lưu trữ hoặc phần mở rộng mô-đun

Các tham số

Thông số Nội dung mô tả
status string; default = ''
chuỗi mô tả trạng thái hiện tại của tiến trình tìm nạp

thiết bị nào

path module_ctx.which(program)

Trả về đường dẫn của chương trình tương ứng hoặc Không nếu không có chương trình nào như vậy trong đường dẫn.

Các tham số

Thông số Nội dung mô tả
program bắt buộc
Chương trình cần tìm trong đường dẫn.
Có thể trả lại hàng vào None.