Các phương thức có trong tệp MODULE.bazel.
Hội viên
- archive_override
- bazel_dep
- git_override
- local_path_override
- mô-đun
- multiple_version_override
- register_execution_platforms
- register_toolchains
- single_version_override
- use_extension
- use_repo
- use_repo_rule
archive_override
None
archive_override(module_name, urls, integrity='', strip_prefix='', patches=[], patch_cmds=[], patch_strip=0)
Thông số
Thông số | Mô tả |
---|---|
module_name
|
bắt buộc Tên của phần phụ thuộc mô-đun Bazel để áp dụng chế độ ghi đè này. |
urls
|
string; hoặc Iterable của string;
bắt buộc URL của tệp lưu trữ; có thể là URL http(s):// hoặc file://. |
integrity
|
mặc định là '' Checksum dự kiến của tệp lưu trữ, ở định dạng Tính toàn vẹn của tài nguyên phụ. |
strip_prefix
|
mặc định là '' Tiền tố thư mục để loại bỏ khỏi các tệp đã trích xuất. |
patches
|
Tập hợp lặp lại của chuỗi; giá trị mặc định là [] Danh sách nhãn trỏ đến các tệp bản vá để áp dụng cho mô-đun này. Các tệp bản vá phải tồn tại trong cây nguồn của dự án cấp cao nhất. Các giá trị này được áp dụng theo thứ tự trong danh sách. |
patch_cmds
|
Tập hợp lặp lại của chuỗi;
mặc định là [] Trình tự các lệnh Bash sẽ được áp dụng trên Linux/Macos sau khi áp dụng các bản vá. |
patch_strip
|
mặc định là 0 Giống như đối số --strip của bản vá Unix. |
bazel_dep
None
bazel_dep(name, version='', max_compatibility_level=-1, repo_name='', dev_dependency=False)
Thông số
Thông số | Mô tả |
---|---|
name
|
bắt buộc Tên của mô-đun cần thêm làm phần phụ thuộc trực tiếp. |
version
|
mặc định là '' Phiên bản của mô-đun sẽ được thêm làm phần phụ thuộc trực tiếp. |
max_compatibility_level
|
mặc định là -1 compatibility_level tối đa được hỗ trợ để mô-đun được thêm dưới dạng phần phụ thuộc trực tiếp. Phiên bản của mô-đun ngụ ý cấp độ tương thích_tối thiểu được hỗ trợ, cũng như cấp độ tối đa nếu không chỉ định thuộc tính này.
|
repo_name
|
mặc định là '' Tên của kho lưu trữ bên ngoài đại diện cho phần phụ thuộc này. Theo mặc định, đây là tên của mô-đun. |
dev_dependency
|
giá trị mặc định là False Nếu đúng, phần phụ thuộc này sẽ bị bỏ qua nếu mô-đun hiện tại không phải là mô-đun gốc hoặc `--ignore_dev_Dependencies` được bật. |
git_override
None
git_override(module_name, remote, commit='', patches=[], patch_cmds=[], patch_strip=0, init_submodules=False)
Thông số
Thông số | Mô tả |
---|---|
module_name
|
bắt buộc Tên của phần phụ thuộc mô-đun Bazel để áp dụng chế độ ghi đè này. |
remote
|
bắt buộc URL của kho lưu trữ Git từ xa. |
commit
|
mặc định là '' Cam kết cần được kiểm tra. |
patches
|
Tập hợp lặp lại của chuỗi; giá trị mặc định là [] Danh sách nhãn trỏ đến các tệp bản vá để áp dụng cho mô-đun này. Các tệp bản vá phải tồn tại trong cây nguồn của dự án cấp cao nhất. Các đề xuất được áp dụng theo thứ tự danh sách. |
patch_cmds
|
Tập hợp lặp lại của chuỗi;
mặc định là [] Trình tự các lệnh Bash sẽ được áp dụng trên Linux/Macos sau khi áp dụng các bản vá. |
patch_strip
|
mặc định là 0 Tương tự như đối số --strip của bản vá Unix. |
init_submodules
|
mặc định là False Liệu các mô-đun con trong kho lưu trữ đã tìm nạp có được khởi tạo theo quy tắc đệ quy hay không. |
local_path_override
None
local_path_override(module_name, path)
Thông số
Thông số | Mô tả |
---|---|
module_name
|
bắt buộc Tên của phần phụ thuộc mô-đun Bazel để áp dụng chế độ ghi đè này. |
path
|
bắt buộc Đường dẫn đến thư mục chứa mô-đun này. |
mô-đun
None
module(name='', version='', compatibility_level=0, repo_name='', bazel_compatibility=[])
Bạn chỉ nên gọi phương thức này một lần. Bạn chỉ có thể bỏ qua phần này nếu mô-đun này là mô-đun gốc (tức là nếu mô-đun này không phụ thuộc vào mô-đun khác).
Thông số
Thông số | Mô tả |
---|---|
name
|
mặc định là '' Tên của mô-đun. Chỉ có thể bỏ qua nếu mô-đun này là mô-đun gốc (chẳng hạn như nếu mô-đun này không phụ thuộc vào mô-đun khác). Tên mô-đun hợp lệ phải: 1) chỉ chứa chữ cái viết thường (a-z), chữ số (0-9), dấu chấm (.), dấu gạch nối (-) và dấu gạch dưới (_); 2) bắt đầu bằng chữ cái viết thường; 3) kết thúc bằng chữ cái viết thường hoặc chữ số. |
version
|
mặc định là '' Phiên bản của mô-đun. Chỉ có thể bỏ qua nếu mô-đun này là mô-đun gốc (chẳng hạn như nếu mô-đun này không phụ thuộc vào mô-đun khác). Phiên bản phải ở định dạng SemVer linh hoạt; hãy xem tài liệu để biết thêm thông tin chi tiết. |
compatibility_level
|
mặc định là 0 Cấp độ tương thích của mô-đun; bạn nên thay đổi cấp độ này mỗi khi có thay đổi lớn không tương thích. Về cơ bản, đây là "phiên bản chính" của mô-đun theo SemVer, ngoại trừ việc phiên bản này không được nhúng trong chuỗi phiên bản mà tồn tại dưới dạng một trường riêng biệt. Các mô-đun có các cấp độ tương thích khác nhau sẽ tham gia vào việc phân giải phiên bản như thể chúng là các mô-đun có tên khác nhau, nhưng biểu đồ phần phụ thuộc cuối cùng không thể chứa nhiều mô-đun có cùng tên nhưng có các cấp độ tương thích khác nhau (trừ khi multiple_version_override có hiệu lực). Hãy xem tài liệu để biết thêm chi tiết.
|
repo_name
|
mặc định là '' Tên của kho lưu trữ đại diện cho mô-đun này, như được nhìn thấy từ chính mô-đun đó. Theo mặc định, tên của kho lưu trữ là tên của mô-đun. Bạn có thể chỉ định tên này để dễ dàng di chuyển các dự án đã sử dụng tên kho lưu trữ khác với tên mô-đun. |
bazel_compatibility
|
Đối tượng có thể lặp lại của chuỗi; giá trị mặc định là [] Danh sách các phiên bản bazel cho phép người dùng khai báo phiên bản Bazel nào tương thích với mô-đun này. Việc này KHÔNG ảnh hưởng đến việc giải quyết phần phụ thuộc, nhưng bzlmod sẽ sử dụng thông tin này để kiểm tra xem phiên bản Bazel hiện tại của bạn có tương thích hay không. Định dạng của giá trị này là một chuỗi gồm một số giá trị ràng buộc được phân tách bằng dấu phẩy. Có 3 điều kiện ràng buộc được hỗ trợ: <=X.X.X: Phiên bản Bazel phải bằng hoặc cũ hơn X.X.X. Dùng khi có thay đổi không tương thích đã biết trong phiên bản mới. >=X.X.X: Phiên bản Bazel phải bằng hoặc mới hơn X.X.X.Được dùng khi bạn phụ thuộc vào một số tính năng chỉ có từ phiên bản X.X.X. -X.X.X: Phiên bản Bazel X.X.X không tương thích. Dùng khi xảy ra lỗi trong X.X.X khiến bạn gặp lỗi nhưng đã được khắc phục trong các phiên bản sau này. |
multiple_version_override
None
multiple_version_override(module_name, versions, registry='')
Thông số
Thông số | Mô tả |
---|---|
module_name
|
bắt buộc Tên của phần phụ thuộc mô-đun Bazel để áp dụng chế độ ghi đè này. |
versions
|
Có thể lặp lại các chuỗi; bắt buộc Chỉ định rõ ràng các phiên bản được phép cùng tồn tại. Các phiên bản này phải có trong lựa chọn trước của biểu đồ phần phụ thuộc. Các phần phụ thuộc trên mô-đun này sẽ được "nâng cấp" lên phiên bản gần nhất được cho phép ở cùng mức độ tương thích. Trong khi đó, các phần phụ thuộc có phiên bản cao hơn bất kỳ phiên bản nào được cho phép ở cùng mức độ tương thích sẽ gây ra lỗi. |
registry
|
mặc định là '' Ghi đè sổ đăng ký cho mô-đun này; thay vì tìm mô-đun này trong danh sách sổ đăng ký mặc định, bạn nên sử dụng sổ đăng ký đã cho. |
register_execution_platforms
None
register_execution_platforms(dev_dependency=False, *platform_labels)
@
hoặc //
). Hãy xem phần độ phân giải chuỗi công cụ để biết thêm thông tin.
Thông số
Thông số | Mô tả |
---|---|
dev_dependency
|
mặc định là False Nếu đúng, các nền tảng thực thi sẽ không được đăng ký nếu mô-đun hiện tại không phải là mô-đun gốc hoặc `--ignore_dev_dependency` đang bật. |
platform_labels
|
trình tự các chuỗi;
bắt buộc Nhãn của các nền tảng cần đăng ký. |
register_toolchains
None
register_toolchains(dev_dependency=False, *toolchain_labels)
@
hoặc //
). Hãy xem phần độ phân giải chuỗi công cụ để biết thêm thông tin.
Thông số
Thông số | Mô tả |
---|---|
dev_dependency
|
mặc định là False Nếu đúng, các chuỗi công cụ sẽ không được đăng ký nếu mô-đun hiện tại không phải là mô-đun gốc hoặc `--ignore_dev_dependency` đang bật. |
toolchain_labels
|
trình tự của chuỗi;
bắt buộc Nhãn của chuỗi công cụ cần đăng ký. Nhãn có thể bao gồm :all , trong trường hợp này, tất cả mục tiêu cung cấp chuỗi công cụ trong gói sẽ được đăng ký theo thứ tự bảng chữ cái theo tên.
|
single_version_override
None
single_version_override(module_name, version='', registry='', patches=[], patch_cmds=[], patch_strip=0)
Thông số
Thông số | Mô tả |
---|---|
module_name
|
bắt buộc Tên của phần phụ thuộc mô-đun Bazel để áp dụng chế độ ghi đè này. |
version
|
mặc định là '' Ghi đè phiên bản đã khai báo của mô-đun này trong biểu đồ phần phụ thuộc. Nói cách khác, mô-đun này sẽ được "ghim" vào phiên bản ghi đè này. Bạn có thể bỏ qua thuộc tính này nếu chỉ muốn ghi đè sổ đăng ký hoặc bản vá. |
registry
|
mặc định là '' Ghi đè sổ đăng ký cho mô-đun này; thay vì tìm mô-đun này trong danh sách sổ đăng ký mặc định, bạn nên sử dụng sổ đăng ký đã cho. |
patches
|
Tập hợp lặp lại của chuỗi; giá trị mặc định là [] Danh sách nhãn trỏ đến các tệp bản vá để áp dụng cho mô-đun này. Các tệp bản vá phải tồn tại trong cây nguồn của dự án cấp cao nhất. Các giá trị này được áp dụng theo thứ tự trong danh sách. |
patch_cmds
|
Tập hợp lặp lại của chuỗi;
mặc định là [] Trình tự các lệnh Bash sẽ được áp dụng trên Linux/Macos sau khi áp dụng các bản vá. |
patch_strip
|
mặc định là 0 Tương tự như đối số --strip của bản vá Unix. |
use_extension
module_extension_proxy use_extension(extension_bzl_file, extension_name, *, dev_dependency=False, isolate=False)
Thông số
Thông số | Mô tả |
---|---|
extension_bzl_file
|
bắt buộc Nhãn cho tệp Starlark xác định phần mở rộng mô-đun. |
extension_name
|
bắt buộc Tên của phần mở rộng mô-đun cần sử dụng. Biểu tượng có tên này phải được tệp Starlark xuất. |
dev_dependency
|
mặc định là False Nếu đúng, việc sử dụng tiện ích mô-đun này sẽ bị bỏ qua nếu mô-đun hiện tại không phải là mô-đun gốc hoặc `--ignore_dev_dependency` đang bật. |
isolate
|
mặc định là False Thử nghiệm. Tham số này đang trong giai đoạn thử nghiệm và có thể thay đổi bất cứ lúc nào. Vui lòng không phụ thuộc vào tính năng này. Bạn có thể bật tính năng này trên cơ sở thử nghiệm bằng cách đặt ---experimental_isolated_extension_usages Nếu đúng, việc sử dụng tiện ích mô-đun này sẽ được tách biệt với tất cả cách sử dụng khác, cả trong mô-đun này và các mô-đun khác. Các thẻ được tạo cho mục đích sử dụng này không ảnh hưởng đến các mục đích sử dụng khác và kho lưu trữ do tiện ích tạo cho mục đích sử dụng này sẽ khác với tất cả các kho lưu trữ khác do tiện ích tạo. Thông số này hiện đang trong giai đoạn thử nghiệm và chỉ dùng được với cờ |
use_repo
None
use_repo(extension_proxy, *args, **kwargs)
Thông số
Thông số | Mô tả |
---|---|
extension_proxy
|
bắt buộc Đối tượng proxy tiện ích mô-đun do lệnh gọi use_extension trả về.
|
args
|
bắt buộc Tên của các kho lưu trữ cần nhập. |
kwargs
|
bắt buộc Chỉ định một số kho lưu trữ nhất định để nhập vào phạm vi của mô-đun hiện tại với các tên khác nhau. Khoá phải là tên để sử dụng trong phạm vi hiện tại, trong khi các giá trị phải là tên gốc mà tiện ích mô-đun xuất. |
use_repo_rule
repo_rule_proxy use_repo_rule(repo_rule_bzl_file, repo_rule_name)
name
trên proxy. Bạn cũng có thể sử dụng thuộc tính dev_dependency
Boolean ngầm ẩn trên proxy để biểu thị rằng một kho lưu trữ nhất định chỉ được tạo khi mô-đun hiện tại là mô-đun gốc.
Thông số
Thông số | Mô tả |
---|---|
repo_rule_bzl_file
|
bắt buộc Nhãn cho tệp Starlark xác định quy tắc kho lưu trữ. |
repo_rule_name
|
bắt buộc Tên của quy tắc kho lưu trữ cần sử dụng. Tệp Starlark phải xuất một ký hiệu có tên này. |