Tệp MODULE.bazel

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

Các phương thức có trong tệp MODULE.bazel.

Hội viên

archive_override

None archive_override(module_name, urls, integrity='', strip_prefix='', patches=[], patch_cmds=[], patch_strip=0)

Chỉ định rằng phần phụ thuộc này phải đến từ một tệp lưu trữ (zip, gzip, v.v.) tại một vị trí nhất định, thay vì từ một sổ đăng ký. Lệnh này chỉ có hiệu lực trong mô-đun gốc. Nói cách khác, nếu một mô-đun được người khác sử dụng làm phần phụ thuộc thì các lượt ghi đè của chính mô-đun đó sẽ bị bỏ qua.

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; 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 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.
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)

Khai báo phần phụ thuộc trực tiếp trên một mô-đun Bazel khác.

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; giá trị 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 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ụ ý mức tương thích tối thiểu được hỗ trợ cũng như mức tối đa nếu thuộc tính này không được chỉ định.
repo_name string; mặc định là ''
Tên của kho lưu trữ bên ngoài biểu thị 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='')

Chỉ định rằng một phần phụ thuộc phải đến từ một thay đổi cụ thể của kho lưu trữ Git. Lệnh này chỉ có hiệu lực trong mô-đun gốc. Nói cách khác, nếu một mô-đun được người khác sử dụng làm phần phụ thuộc thì các lượt ghi đè của chính mô-đun đó sẽ bị bỏ qua.

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 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.
init_submodules bool; mặc định là False
Liệu các mô-đun con git trong kho lưu trữ đã tìm nạp có được khởi động theo quy tắc đệ 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)

Bao gồm nội dung của một tệp MODULE.bazel khác. Về cơ bản, 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ý tốt hơn quyền kiểm soát truy cập cho từng phân đoạn ngữ nghĩa.

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 phải bắt đầu bằng dấu gạch chéo đôi (//).

inject_repo

None inject_repo(extension_proxy, *args, **kwargs)

Chèn một hoặc nhiều kho lưu trữ mới vào phần mở rộng mô-đun đã cho. 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" được bật.

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 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ữ 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
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à chúng sẽ hiển thị trong tiện ích.

local_path_override

None local_path_override(module_name, path)

Chỉ định rằng phần phụ thuộc phải đến từ một thư mục nhất định trên ổ cục bộ. Chỉ thị này chỉ có hiệu lực trong mô-đun gốc; nói cách khác, nếu một mô-đun được dùng làm phần phụ thuộc của các mô-đun khác, thì các chế độ ghi đè của chính mô-đun đó sẽ bị bỏ qua.

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=[])

Khai báo một số thuộc tính nhất định của mô-đun Bazel được biểu thị bằng kho lưu trữ Bazel hiện tại. Các thuộc tính này có thể là siêu dữ liệu thiết yếu của mô-đun (chẳng hạn như tên và phiên bản) hoặc ảnh hưởng đến hành vi của mô-đun hiện tại và các phần phụ thuộc.

Bạn nên gọi lệnh này tối đa một lần và nếu được gọi, thì đó phải là lệnh đầu tiên trong tệp MODULE.bazel. 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).

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 (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 int; 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ó 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; mặc định là ''
Tên của kho lưu trữ đại diện cho mô-đun này, 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. Điều này KHÔNG ảnh hưởng đến việc phân giải 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. Đượ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='')

Chỉ định rằng một phần phụ thuộc vẫn phải đến từ một sổ đăng ký, nhưng cho phép nhiều phiên bản của phần phụ thuộc đó cùng tồn tại. Hãy xem tài liệu để biết thêm chi tiết. Chỉ thị này chỉ có hiệu lực trong mô-đun gốc; nói cách khác, nếu một mô-đun được dùng làm phần phụ thuộc của các mô-đun khác, thì các chế độ ghi đè của chính mô-đun đó sẽ bị bỏ qua.

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 Tập hợp lặp lại của chuỗi; bắt buộc
Chỉ định rõ ràng các phiên bản được phép tồn tại cùng nhau. 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 cao hơn gần nhất được phép ở cùng cấp độ tương thích, trong khi các phần phụ thuộc có phiên bản cao hơn mọi phiên bản được phép ở cùng cấp độ 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)

Ghi đè một hoặc nhiều kho lưu trữ do phần mở rộng mô-đun nhất định xác định bằng các kho lưu trữ nhất định mà mô-đun hiện tại có thể thấy. Điều 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`.

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 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ữ 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)

Chỉ định các nền tảng thực thi đã xác định để đăng ký khi mô-đun này được chọn. Phải là mẫu mục tiêu tuyệt đối (ví dụ: bắt đầu bằng @ hoặc //). Xem độ phân giải của 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)

Chỉ định các chuỗi công cụ đã xác định sẽ được đăng ký khi mô-đun này được chọn. Phải là mẫu mục tiêu tuyệt đối (tức là bắt đầu bằng @ 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)

Chỉ định rằng phần phụ thuộc vẫn phải đến từ sổ đăng ký, nhưng phiên bản của phần phụ thuộc phải được ghim hoặc sổ đăng ký bị ghi đè, hoặc danh sách bản vá được áp dụng. Lệnh này chỉ có hiệu lực trong mô-đun gốc. Nói cách khác, nếu một mô-đun được người khác sử dụng làm phần phụ thuộc thì các lượt ghi đè của chính mô-đun đó sẽ bị bỏ qua.

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; giá trị 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 tất cả những gì muốn ghi đè là 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 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.

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 Có thể 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 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)

Trả về một đối tượng proxy đại diện cho một tiện ích mô-đun; các phương thức của đối tượng này có thể được gọi để tạo thẻ tiện ích mô-đun.

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. Tệp Starlark phải xuất một ký hiệu có tên này.
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. Thông 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ỉ có thể sử dụng với cờ --experimental_isolated_extension_usages.

use_repo

None use_repo(extension_proxy, *args, **kwargs)

Nhập một hoặc nhiều kho lưu trữ được tạo bởi tiện ích mô-đun nhất định vào phạm vi của mô-đun hiện tạ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
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, còn giá trị phải là tên ban đầu do tiện ích mô-đun xuất.

use_repo_rule

repo_rule_proxy use_repo_rule(repo_rule_bzl_file, repo_rule_name)

Trả về giá trị proxy có thể được gọi trực tiếp trong tệp MODULE.bazel dưới dạng quy tắc kho lưu trữ, một hoặc nhiều lần. Các kho lưu trữ được tạo theo cách này chỉ hiển thị cho mô-đun hiện tại, theo tên được khai báo bằng thuộc tính 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. Tệp Starlark phải xuất một ký hiệu có tên này.