mô-đun_doanh_nghiệp

Báo cáo vấn đề Xem nguồn Nightly · 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

Ngữ cảnh của phần mở rộng mô-đun có chứa các hàm trợ giúp và thông tin về các thẻ liên quan 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.

Hội viên

tải xuống

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

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

Thông số

Thông số Mô tả
url chuỗi; hoặc Iterable của chuỗi; bắt buộc
Danh sách URL phản chiếu tham chiếu đến cùng một tệp.
output chuỗi; hoặc Nhãn; hoặc đường dẫn; giá trị 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 giá trị mặc định là ''
hàm băm SHA-256 dự kiến của tệp được 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 sẽ gây rủi ro bảo mật vì các tệp từ xa có thể thay đổi. Tốt nhất là bạn không nên bỏ qua trường này vì sẽ khiến bản dựng của bạn không kín. Bạn không bắt buộc phải thiết lập để phát triển ứng dụng dễ dàng hơn, nhưng nên thiết lập trước khi vận chuyển.
executable mặc định là False
đặt cờ thực thi trên tệp đã tạo, false theo mặc định.
allow_fail mặc định là False
Nế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 vào bộ nhớ đệm ở những trường hợp 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 lệnh chính tả (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à ''
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 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à bạn không nên bỏ qua trường này vì sẽ khiến bản dựng của bạn không kín. Bạn không bắt buộc phải làm việc này để việc phát triển trở nên dễ dàng hơn, nhưng bạn nên thiết lập trước khi xuất bả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 tệp xuống đường dẫn đầu ra cho URL đã cung cấp, trích xuất tệp đó và trả về một cấu trúc chứa 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, một hàm băm của tệp có các trường sha256integrity.

Thông số

Thông số Mô tả
url chuỗi; hoặc Iterable của chuỗi; bắt buộc
Danh sách URL phản chiếu tham chiếu đến cùng một tệp.
output chuỗi; hoặc Nhãn; hoặc đường dẫn; giá trị mặc định là ''
đường dẫn đến thư mục nơi giải nén tệp lưu trữ, 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. Hàm băm 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 sẽ gây rủi ro bảo mật vì các tệp từ xa có thể thay đổi. Tốt nhất là bạn không nên bỏ qua trường này vì sẽ khiến bản dựng của bạn không kín. Bạn không bắt buộc phải làm việc này để việc phát triển trở nên dễ dàng hơn, nhưng bạn nên thiết lập trước khi xuất bản. Trước tiên, bộ nhớ đệm kho lưu trữ sẽ được kiểm tra để tìm tệp có hàm băm đã cho (nếu có); 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 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 thì bạn có thể chỉ định rõ ràng là "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à ''
tiền tố thư mục để 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ì cần chỉ định tiền tố này nhiều lần trong build_file, bạn có thể dùng trường này để xoá tiền tố đó khỏi các tệp đã trích xuất.
allow_fail mặc định là False
Nế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 vào bộ nhớ đệm ở những trường hợp 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 lệnh chính tả (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à ''
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 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à bạn không nên bỏ qua trường này vì sẽ khiến bản dựng của bạn không kín. Bạn không bắt buộc phải thiết lập để phát triển ứng dụng dễ dàng hơn, nhưng nên thiết lập trước khi vận chuyển.
rename_files mặc định là {}
Một dict 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 điều chỉnh tiền tố thư mục. Bạn có thể dùng tính năng 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ác 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 hiện

exec_result module_ctx.execute(arguments, timeout=600, environment={}, quiet=True, working_directory="")

Thực thi lệnh do danh sách đối số cung cấp. Thời gian thực thi lệnh này được giới hạn trong 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 kết quả 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 vào quy trình.

Thông số

Thông số Mô tả
arguments bắt buộc
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à 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 mặc định là {}
buộc một số biến môi trường được đặt để truyền vào quy trình.
quiet mặc định là True
Nếu stdout và stderr được in ra trên 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 so 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)

Tạo một đối tượng mờ có thể được trả về qua hàm triển khai của tiện ích mô-đun để cung cấp siêu dữ liệu về những kho lưu trữ do tiện ích tạo ra cho Bazel.

Thông số

Thông số Mô tả
root_module_direct_deps trình tự của chuỗi; hoặc chuỗi; hay None; mặc định là None
Tên của những 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 qua use_repo, thì 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 một trong hai giá trị root_module_direct_depsroot_module_direct_dev_deps được chỉ định, thì giá trị còn lại cũng phải được chỉ định. Các danh sách do hai tham số này chỉ định phải tách biệt với nhau.

Chính xác, một trong hai giá trị root_module_direct_depsroot_module_direct_dev_deps có thể được đặt thành giá trị đặc biệt "all". Giá trị này được coi như thể một danh sách có tên của tất cả kho lưu trữ do tiện ích tạo ra được chỉ định làm giá trị.

root_module_direct_dev_deps trình tự của chuỗi; hoặc chuỗi; hoặc None; mặc định là None
Tên của các kho lưu trữ mà tiện ích coi là phần phụ thuộc phát triển 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 trên một proxy mở rộng được tạo bằng use_extension(..., dev_dependency = True), thì Bazel sẽ in một cảnh báo và lệnh khắc phục khi đánh giá phần mở rộng.

Nếu một trong hai giá trị root_module_direct_depsroot_module_direct_dev_deps được chỉ định, thì giá trị còn lại cũng phải được chỉ định. Những danh sách do 2 tham số này chỉ định phải rời nhau.

Bạn có thể đặt chính xác một trong hai giá trị root_module_direct_depsroot_module_direct_dev_deps thành giá trị đặc biệt "all". Giá trị này được coi như một danh sách có tên của tất cả các kho lưu trữ do tiện ích tạo ra.

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ữ bằng nội dung được cung cấp.

Thông số

Thông số Mô tả
path chuỗi; hoặc Nhãn; hoặc đường dẫn; bắt buộc
đườ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, trống theo mặc định.
executable mặc định là True
đặt cờ thực thi trên tệp được tạo, true theo mặc định.
legacy_utf8 mặc định là True
mã hoá nội dung tệp thành UTF-8, đúng theo mặc định. 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)

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

Thông số

Thông số Mô tả
tag bazel_module_tag; bắt buộc
Thẻ lấy 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 sử dụng tiện ích mô-đun này, mỗi mô-đun là một đối tượng bazel_module hiển thị tất cả các thẻ mà mô-đun đã chỉ định cho tiện ích 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 bắt đầu từ mô-đun gốc.

hệ điều hành

repository_os module_ctx.os

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

đường dẫn

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 là tương đối, thì đường dẫn đó sẽ phân giải tương ứng với thư mục kho lưu trữ. Nếu đường dẫn là một nhãn, thì đường dẫn đó sẽ phân giải thành đường dẫn của tệp tương ứng. Xin lưu ý rằng các kho lưu trữ từ xa được thực thi trong giai đoạn phân tích và do đó không thể phụ thuộc vào kết quả mục tiêu (nhãn phải trỏ đến một tệp không được tạo). Nếu path là một đường dẫn, thì hàm này sẽ trả về đường dẫn đó nguyên trạng.

Thông số

Thông số Mô tả
path chuỗi; hoặc Nhãn; hoặc đường dẫn; bắt buộc
chuỗi, nhãn hoặc đường dẫn để tạo đường dẫn từ đó

đọc

string module_ctx.read(path)

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

Thông số

Thông số Mô tả
path string; hoặc Label; hoặc path; đường dẫn bắt buộc
của tệp cần đọc.

report_progress

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 tiện ích mô-đun này

Thông số

Thông số Mô tả
status chuỗi; giá trị mặc định là chuỗi ''
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

Liệu mô-đun gốc có sử dụng tiện ích này dưới dạng phần phụ thuộc không phải của nhà phát triển hay không.

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 có nếu không có chương trình nào như vậy trong đường dẫn.

Thông số

Thông số Mô tả
program bắt buộc
Chương trình cần tìm trong đường dẫn.
Có thể trả về None.