Các phương thức có trong tệp MODULE.bazel.
Hội viên
- archive_override
- bazel_dep
- git_override
- include
- inject_repo
- local_path_override
- mô-đun
- multiple_version_override
- override_repo
- 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
|
string;
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
|
string; giá trị mặc định là '' Giá trị tổng kiểm 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
|
string; giá trị mặc định là '' Tiền tố thư mục cần xoá 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
|
int; giá trị mặc định là 0 giống với đố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
|
string;
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
|
string;
mặc định là '' Phiên bản của mô-đun cần thêm dưới dạng phần phụ thuộc trực tiếp. |
max_compatibility_level
|
int; giá trị mặc định là -1 compatibility_level tối đa được hỗ trợ để thêm mô-đun 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
|
string;
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
|
bool; 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 nếu bạn bật tuỳ chọn `--ignore_dev_dependency`. |
git_override
None
git_override(module_name, remote, commit='', patches=[], patch_cmds=[], patch_strip=0, init_submodules=False, strip_prefix='')
Thông số
Thông số | Mô tả |
---|---|
module_name
|
string;
bắt buộc Tên của phần phụ thuộc mô-đun Bazel để áp dụng chế độ ghi đè này. |
remote
|
string;
bắt buộc URL của kho lưu trữ Git từ xa. |
commit
|
string;
mặc định là '' Thay đổi cần được kiểm tra. |
patches
|
Có thể lặp lại của chuỗi; mặc định là [] Danh sách các nhãn trỏ đến 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
|
int; giá trị mặc định là 0 Tương tự như đối số --strip của bản vá Unix. |
init_submodules
|
bool; giá trị mặc định là False . Cho biết liệu các mô-đun con git trong kho lưu trữ đã tìm nạp có được khởi tạo đệ quy hay không. |
strip_prefix
|
string; giá trị mặc định là '' Tiền tố thư mục cần xoá khỏi các tệp đã trích xuất. Bạn có thể dùng tính năng này để nhắm đến một thư mục con của kho lưu trữ git. Xin lưu ý rằng thư mục con phải có tệp `MODULE.bazel` riêng với tên mô-đun giống với đối số `module_name` được truyền đến `git_override` này. |
bao gồm
None
include(label)
include()
hoạt động như thể tệp được đưa vào được đặt theo văn bản tại vị trí của lệnh gọi include()
, ngoại trừ việc các liên kết biến (chẳng hạn như các liên kết được dùng cho use_extension
) chỉ hiển thị trong tệp mà chúng xuất hiện, chứ không phải trong bất kỳ tệp nào được đưa vào hoặc bao gồm.Chỉ mô-đun gốc mới có thể sử dụng include()
; sẽ xảy ra lỗi nếu tệp MODULE của bazel_dep
sử dụng include()
.
Chỉ có thể thêm các tệp trong kho lưu trữ chính.
include()
cho phép bạn phân đoạn tệp mô-đun gốc thành nhiều phần để tránh có một tệp MODULE.bazel khổng lồ hoặc để quản lý hiệu quả hơn khả năng kiểm soát quyền truy cập cho từng phân đoạn ngữ nghĩa riêng lẻ.
Thông số
Thông số | Mô tả |
---|---|
label
|
string;
bắt buộc Nhãn trỏ đến tệp cần đưa vào. Nhãn phải trỏ đến một tệp trong kho lưu trữ chính; nói cách khác, nhãn này phải bắt đầu bằng dấu gạch chéo đôi ( // ).
|
inject_repo
None
inject_repo(extension_proxy, *args, **kwargs)
Thay vào đó, hãy sử dụng override_repo
để ghi đè kho lưu trữ hiện có.
Thông số
Thông số | Mô tả |
---|---|
extension_proxy
|
mô-đun_extension_proxy; bắt buộc Đối tượng proxy mở rộng mô-đun được lệnh gọi use_extension trả về.
|
args
|
bắt buộc Các kho lưu trữ hiển thị cho mô-đun hiện tại sẽ được chèn vào tiện ích có cùng tên. |
kwargs
|
bắt buộc Các kho lưu trữ mới để chèn vào tiện ích, trong đó các giá trị là tên của kho lưu trữ trong phạm vi của mô-đun hiện tại và khoá là tên mà các kho lưu trữ đó sẽ xuất hiện trong tiện ích. |
local_path_override
None
local_path_override(module_name, path)
Thông số
Thông số | Mô tả |
---|---|
module_name
|
string;
bắt buộc Tên của phần phụ thuộc mô-đun Bazel để áp dụng chế độ ghi đè này. |
path
|
string;
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 lệnh này một lần và nếu được gọi, lệnh này phải là lệnh đầu tiên trong tệp MODULE.bazel. 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
|
string;
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
|
string;
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 (như trong, nếu mô-đun không bị phụ thuộc bởi một 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
|
int; mặc định là 0 Mức độ tương thích của mô-đun; nên thay đổi giá trị 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ó mức độ tương thích khác nhau sẽ tham gia vào quá trình phân giải phiên bản như thể đó 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 được chứa nhiều mô-đun có cùng tên nhưng khác mức độ tương thích (trừ phi multiple_version_override có hiệu lực). Hãy xem tài liệu để biết thêm chi tiết.
|
repo_name
|
string; giá trị mặc định là '' Tên của kho lưu trữ đại diện cho mô-đun này, như chính mô-đun nhìn thấy. 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 sử dụng khi bạn phụ thuộc vào một số tính năng chỉ có từ X.X.X. -X.X.X: Phiên bản Bazel X.X.X không tương thích. Được dùng khi có lỗi trong X.X.X khiến bạn gặp sự cố, nhưng đã được khắc phục trong các phiên bản sau. |
multiple_version_override
None
multiple_version_override(module_name, versions, registry='')
Thông số
Thông số | Mô tả |
---|---|
module_name
|
string;
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ó sẵn trong quá trình lựa chọn trước 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
|
string; mặc định là '' Ghi đè sổ đăng ký cho mô-đun này; thay vì tìm mô-đun này từ danh sách sổ đăng ký mặc định, bạn nên sử dụng sổ đăng ký có sẵn. |
override_repo
None
override_repo(extension_proxy, *args, **kwargs)
Thay vào đó, hãy sử dụng inject_repo
để thêm một kho lưu trữ mới.
Thông số
Thông số | Mô tả |
---|---|
extension_proxy
|
module_extension_proxy;
bắt buộc Đối tượng proxy của tiện ích mô-đun do lệnh gọi use_extension trả về.
|
args
|
bắt buộc Các kho lưu trữ trong tiện ích sẽ được ghi đè bằng các kho lưu trữ có cùng tên trong mô-đun hiện tại. |
kwargs
|
bắt buộc Các chế độ ghi đè để áp dụng cho các kho lưu trữ do tiện ích tạo, trong đó các giá trị là tên của kho lưu trữ trong phạm vi của mô-đun hiện tại và khoá là tên của kho lưu trữ mà chúng sẽ ghi đè trong tiện ích. |
register_execution_platforms
None
register_execution_platforms(dev_dependency=False, *platform_labels)
@
hoặc //
). Xem độ phân giải chuỗi công cụ để biết thêm thông tin. Các mẫu mở rộng sang nhiều mục tiêu, chẳng hạn như :all
, sẽ được đăng ký theo thứ tự từ điển học theo tên.
Thông số
Thông số | Mô tả |
---|---|
dev_dependency
|
bool;
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ủa chuỗi; bắt buộc Các mẫu mục tiêu cần đăng ký. |
register_toolchains
None
register_toolchains(dev_dependency=False, *toolchain_labels)
@
hoặc //
). Xem độ phân giải chuỗi công cụ để biết thêm thông tin. Các mẫu mở rộng đến nhiều mục tiêu, chẳng hạn như :all
, sẽ được đăng ký theo thứ tự bảng chữ cái theo tên mục tiêu (không phải tên của quá trình triển khai chuỗi công cụ).
Thông số
Thông số | Mô tả |
---|---|
dev_dependency
|
bool;
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 Các mẫu mục tiêu cần đăng ký. |
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
|
string;
bắt buộc Tên của phần phụ thuộc mô-đun Bazel để áp dụng chế độ ghi đè này. |
version
|
string; 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
|
string; giá trị 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
|
Có thể lặp lại của chuỗi; mặc định là [] Danh sách các nhãn trỏ đến 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. Nếu một bản vá thực hiện thay đổi đối với tệp MODULE.bazel, thì những thay đổi này sẽ chỉ có hiệu lực nếu tệp vá do mô-đun gốc cung cấp. |
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á. Các thay đổi đối với tệp MODULE.bazel sẽ không có hiệu lực. |
patch_strip
|
int; giá trị mặc định là 0 giống với đố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
|
string; bắt buộc Nhãn cho tệp Starlark xác định phần mở rộng mô-đun. |
extension_name
|
string;
bắt buộc Tên của tiện ích 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
|
bool; 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_Dependencies" được bật. |
isolate
|
bool; 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, thì cách sử dụng tiện ích mô-đun này sẽ được tách biệt với tất cả cá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 những trường hợp sử dụng khác, đồng thời kho lưu trữ do tiện ích tạo cho mục đích sử dụng này sẽ khác biệt với tất 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ỉ có thể sử dụng với cờ |
use_repo
None
use_repo(extension_proxy, *args, **kwargs)
Thông số
Thông số | Mô tả |
---|---|
extension_proxy
|
module_extension_proxy;
bắt buộc Đối tượng proxy của 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
|
string;
bắt buộc Nhãn cho tệp Starlark xác định quy tắc kho lưu trữ. |
repo_rule_name
|
string;
bắt buộc Tên của quy tắc kho lưu trữ cần sử dụng. Biểu tượng có tên này phải được tệp Starlark xuất. |