Tệp MODULE.bazel

Bản dựng chạy vào ban đêm · 9.1 · 9.0 · 8.6 · 8.5 · 8.4 · 8.3 · 8.2 · 8.1
Các phương thức có trong tệp MODULE.bazel.

Hội viên

archive_override

None archive_override(*, module_name, **kwargs)

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.) ở một vị trí nhất định, thay vì từ một sổ đăng ký. Trên thực tế, phần phụ thuộc này sẽ được hỗ trợ bằng quy tắc http_archive.

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 các mô-đun khác dùng làm phần phụ thuộc, thì các chế độ ghi đè riêng của mô-đun đó sẽ bị bỏ qua.

Tham số

Tham 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.
kwargs bắt buộc
Tất cả các đối số khác đều được chuyển tiếp đến quy tắc http_archive repo cơ bản. Xin lưu ý rằng bạn không nên chỉ định thuộc tính name; hãy sử dụng module_name.

bazel_dep

None bazel_dep(*, name, version='', max_compatibility_level=-1, repo_name='', dev_dependency=False)

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

Tham số

Tham số Mô tả
name chuỗi; bắt buộc
Tên của mô-đun sẽ được thêm dưới dạng phần phụ thuộc trực tiếp.
version string; default is ''
Phiên bản của mô-đun sẽ được thêm dưới dạng phần phụ thuộc trực tiếp.
max_compatibility_level int; mặc định là -1
Không dùng nữa. Đây hiện là một thao tác không có hiệu lực và không ảnh hưởng gì.
repo_name chuỗi; hoặc None; 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. Đây là tên của mô-đun theo mặc định. Có thể đặt thành None để biến phần phụ thuộc này thành phần phụ thuộc "nodep": trong trường hợp này, quy cách bazel_dep này chỉ được tuân thủ nếu mô-đun đích đã tồn tại trong biểu đồ phần phụ thuộc bằng một số phương tiện khác.
dev_dependency bool; mặc định là False
Nếu là true, 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_dependency được bật.

flag_alias

None flag_alias(*, name, starlark_flag)

Ánh xạ cờ dòng lệnh --foo sang cờ Starlark --@repo//defs:foo. Bazel sẽ dịch tất cả các phiên bản của $ bazel build //target --foo thành $ bazel build //target --@repo//defs:foo.

Tham số

Tham số Mô tả
name chuỗi; bắt buộc
Tên của cờ.
starlark_flag chuỗi; bắt buộc
Nhãn của cờ Starlark cần đặt bí danh.

git_override

None git_override(*, module_name, **kwargs)

Chỉ định rằng phần phụ thuộc này phải đến từ một cam kết nhất định trong kho lưu trữ Git, thay vì đến từ một sổ đăng ký. Trên thực tế, phần phụ thuộc này sẽ được hỗ trợ bởi quy tắc git_repository.

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 các mô-đun khác dùng làm phần phụ thuộc, thì các chế độ ghi đè riêng của mô-đun đó sẽ bị bỏ qua.

Tham số

Tham 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.
kwargs bắt buộc
Tất cả các đối số khác sẽ được chuyển tiếp đến quy tắc git_repositoryrepo cơ bản. Xin lưu ý rằng bạn không nên chỉ định thuộc tính name; hãy sử dụng module_name.

bao gồm

None include(label)

Bao gồm nội dung của một tệp khác tương tự như MODULE.bazel. Trên thực tế, include() hoạt động như thể tệp được đưa vào được đặt bằng 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ỉ xuất hiện trong tệp mà chúng xuất hiện, chứ không xuất hiện trong bất kỳ tệp nào được đưa vào hoặc đưa vào.

Chỉ mô-đun gốc và các mô-đun chịu sự ghi đè không đăng ký mới có thể sử dụng include().

Bạn chỉ có thể đưa các tệp trong kho lưu trữ của mô-đun hiện tại vào.

include() cho phép bạn phân đoạn một tệp mô-đun thành nhiều phần, để tránh có một tệp MODULE.bazel khổng lồ hoặc để quản lý quyền kiểm soát truy cập tốt hơn cho từng phân đoạn ngữ nghĩa.

Tham số

Tham số Mô tả
label chuỗi; 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 kép (//). Tên của tệp phải kết thúc bằng .MODULE.bazel và không được bắt đầu bằng ..

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 tiện ích mô-đun đã cho. Tham số 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 dùng override_repo để ghi đè một kho lưu trữ hiện có.

Tham số

Tham số Mô tả
extension_proxy module_extension_proxy; required
Một đối tượng proxy 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ữ mà mô-đun hiện tại có thể thấy và cần đượ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 cần 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à các khoá là tên mà chúng sẽ xuất hiện trong tiện ích.

Bạn có thể chỉ định các khoá không phải là giá trị nhận dạng hợp lệ thông qua một dict chữ được truyền dưới dạng đối số từ khoá bổ sung, ví dụ: inject_repo(extension_proxy, **{"foo.2": "foo"}).

local_path_override

None local_path_override(*, module_name, path)

Chỉ định rằng phần phụ thuộc này phải đến từ một thư mục nhất định trên đĩa cục bộ, thay vì từ một sổ đăng ký. Trên thực tế, phần phụ thuộc này sẽ được hỗ trợ bởi quy tắc local_repository.

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 các mô-đun khác dùng làm phần phụ thuộc, thì các chế độ ghi đè riêng của mô-đun đó sẽ bị bỏ qua.

Tham số

Tham 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 chuỗi; 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=-1, repo_name='', bazel_compatibility=[])

Khai báo một số thuộc tính của mô-đun Bazel do kho lưu trữ Bazel hiện tại đại diện. Những thuộc tính này 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 thành phần phụ thuộc của mô-đun đó.

Bạn chỉ nên gọi chỉ thị này tối đa một lần và nếu gọi, thì đây phải là chỉ thị đầu tiên trong tệp MODULE.bazel. Bạn chỉ có thể bỏ qua thuộc tính này nếu mô-đun này là mô-đun gốc (tức là nếu không có mô-đun nào khác phụ thuộc vào mô-đun này).

Tham số

Tham số Mô tả
name chuỗi; mặc định là ''
Tên của mô-đun. Bạn chỉ có thể bỏ qua 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ột 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 ngang (-) 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; default is ''
Phiên bản của mô-đun. Bạn chỉ có thể bỏ qua 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ộ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à -1
Không dùng nữa. Đây hiện là một thao tác không có hiệu lực và không ảnh hưởng gì.
repo_name string; default is ''
Tên của kho lưu trữ đại diện cho mô-đun này, do 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 cho các dự án đã sử dụng tên kho lưu trữ cho chính dự án đó, khác với tên mô-đun.
bazel_compatibility Có thể lặp lại strings; mặc định là []
Danh sách các phiên bản bazel cho phép người dùng khai báo những phiên bản Bazel nào tương thích với mô-đun này. Thông tin 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 quy tắc 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. Được dùng khi có một thay đổi không tương thích đã biết trong phiên bản mới hơn. >=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ừ 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 không thể sử dụng, 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 nhiều phiên bản của phần phụ thuộc đó phải được phép 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 các mô-đun khác dùng làm phần phụ thuộc, thì các chế độ ghi đè riêng của mô-đun đó sẽ bị bỏ qua.

Tham số

Tham 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 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. Những phiên bản này phải có sẵn trong danh sách 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 được phép cao hơn gần nhất ở 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 bất kỳ phiên bản được phép nào ở cùng cấp độ tương thích sẽ gây ra lỗi.
registry chuỗi; 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.

override_repo

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

Ghi đè một hoặc nhiều kho lưu trữ do tiện ích mô-đun đã cho xác định bằng các kho lưu trữ đã cho mà mô-đun hiện tại có thể nhìn thấy. Tham số 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 `--ignore_dev_dependency`.

Thay vào đó, hãy dùng inject_repo để thêm một kho lưu trữ mới.

Tham số

Tham số Mô tả
extension_proxy module_extension_proxy; required
Một đối tượng proxy 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 cần được ghi đè bằng các kho lưu trữ có cùng tên trong mô-đun hiện tại.
kwargs required
Các chế độ ghi đè cần á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 các kho lưu trữ trong phạm vi của mô-đun hiện tại và các khoá là tên của các kho lưu trữ mà chúng sẽ ghi đè trong tiện ích.

Bạn có thể chỉ định các khoá không phải là giá trị nhận dạng hợp lệ thông qua một dict chữ được truyền dưới dạng đối số từ khoá bổ sung, ví dụ: override_repo(extension_proxy, **{"foo.2": "foo"}).

register_execution_platforms

None register_execution_platforms(*platform_labels, dev_dependency=False)

Chỉ định các nền tảng thực thi đã 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 //). Hãy xem độ phân giải chuỗi công cụ để biết thêm thông tin. Các mẫu mở rộng thành nhiều mục tiêu, chẳng hạn như :all, sẽ được đăng ký theo thứ tự từ điển theo tên.

Tham số

Tham 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` được bật.
platform_labels trình tự của các chuỗi; bắt buộc
Các mẫu mục tiêu cần đăng ký.

register_toolchains

None register_toolchains(*toolchain_labels, dev_dependency=False)

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 //). Hãy xem độ phân giải chuỗi công cụ để biết thêm thông tin. Các mẫu mở rộng thành nhiều mục tiêu, chẳng hạn như :all, sẽ được đăng ký theo thứ tự từ điển theo tên mục tiêu (không phải tên của việc triển khai chuỗi công cụ).

Tham số

Tham 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` được bật.
toolchain_labels trình tự của các 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 một phần phụ thuộc vẫn phải đến từ mộ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ý của phần phụ thuộc đó bị ghi đè, hoặc một danh sách các bản vá được áp dụng. 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 các mô-đun khác dùng làm phần phụ thuộc, thì các chế độ ghi đè riêng của mô-đun đó sẽ bị bỏ qua.

Tham số

Tham 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 chuỗi; 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 bạn chỉ muốn ghi đè sổ đăng ký hoặc các bản vá.
registry chuỗi; 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 chuỗis; mặc định là []
Danh sách các nhãn trỏ đến các tệp vá để áp dụng cho mô-đun này. Các tệp vá phải có trong cây nguồn của dự án cấp cao nhất. Các quy tắc này được áp dụng theo thứ tự trong danh sách.

Nếu bản vá thực hiện các 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 bản vá do mô-đun gốc cung cấp.

patch_cmds Có thể lặp lại các 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á.

Những thay đổi đối với tệp MODULE.bazel sẽ không có hiệu lực.

patch_strip số nguyên; 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)

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

Tham số

Tham số Mô tả
extension_bzl_file chuỗi; bắt buộc
Nhãn cho tệp Starlark xác định tiện ích mô-đun.
extension_name chuỗi; 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 biểu tượng 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_dependency` được bật.
isolate bool; mặc định là False
Thử nghiệm. Đây là một thông số 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 thông tin 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ì việc sử dụng tiện ích mô-đun này sẽ 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 các mục đích sử dụng khác và các 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ả các kho lưu trữ khác do tiện ích tạo.

Tham số này hiện đang ở giai đoạn thử nghiệm và chỉ dùng được 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ữ do tiện ích mô-đun đã cho tạo vào phạm vi của mô-đun hiện tại.

Tham số

Tham số Mô tả
extension_proxy module_extension_proxy; required
Một đố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 required
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 bằng 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 giá trị phải là tên ban đầu do tiện ích mô-đun xuất.

Bạn có thể chỉ định các khoá không phải là giá trị nhận dạng hợp lệ thông qua một dict chữ được truyền dưới dạng đối số từ khoá bổ sung, ví dụ: use_repo(extension_proxy, **{"foo.2": "foo"}).

use_repo_rule

repo_rule_proxy use_repo_rule(repo_rule_bzl_file, repo_rule_name)

Trả về một giá trị proxy có thể được gọi trực tiếp trong tệp MODULE.bazel dưới dạng một 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ể dùng thuộc tính Boolean dev_dependency ngầm 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.

Tham số

Tham số Mô tả
repo_rule_bzl_file chuỗi; bắt buộc
Nhãn cho tệp Starlark xác định quy tắc kho lưu trữ.
repo_rule_name chuỗi; 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 biểu tượng có tên này.