Nội dung
gói hàng
package(default_deprecation, default_package_metadata, default_testonly, default_visibility, features)
Hàm này khai báo siêu dữ liệu áp dụng cho mọi quy tắc trong gói. Hàm này được dùng tối đa một lần trong một gói (tệp BUILD).
Đối với đối tác khai báo siêu dữ liệu áp dụng cho mọi quy tắc trong toàn bộ
kho lưu trữ, hãy sử dụng hàm repo() trong
tệp REPO.bazel ở thư mục gốc của kho lưu trữ.
Hàm repo() nhận các đối số giống hệt như package().
Hàm package() phải được gọi ngay sau tất cả các câu lệnh load() ở đầu tệp, trước mọi quy tắc.
Đối số
| Thuộc tính | Mô tả |
|---|---|
default_applicable_licenses |
Bí danh cho |
default_visibility |
Danh sách nhãn; mặc định là Chế độ hiển thị mặc định của các mục tiêu quy tắc cấp cao nhất và macro tượng trưng trong gói này — tức là các mục tiêu và macro tượng trưng không được khai báo bên trong một macro tượng trưng. Thuộc tính này sẽ bị bỏ qua nếu mục tiêu hoặc macro chỉ định giá trị Để biết thông tin chi tiết về cú pháp của thuộc tính này, hãy xem tài liệu về visibility. Chế độ hiển thị mặc định của gói không áp dụng cho exports_files, chế độ này ở chế độ công khai theo mặc định. |
default_deprecation |
Chuỗi; mặc định là Đặt thông báo |
default_package_metadata |
Danh sách nhãn; mặc định là Đặt danh sách mục tiêu siêu dữ liệu mặc định áp dụng cho tất cả các mục tiêu khác trong gói. Đây thường là các mục tiêu liên quan đến nội dung khai báo giấy phép và gói OSS. Xem rules_license để biết ví dụ. |
default_testonly |
Boolean; mặc định là Đặt thuộc tính Trong các gói thuộc |
features |
Danh sách chuỗi; mặc định là Đặt nhiều cờ ảnh hưởng đến ngữ nghĩa của tệp BUILD này. Tính năng này chủ yếu được những người làm việc trên hệ thống xây dựng sử dụng để gắn thẻ các gói cần xử lý đặc biệt. Đừng sử dụng thuộc tính này trừ phi có yêu cầu rõ ràng của người làm việc trên hệ thống xây dựng. |
Ví dụ
Nội dung khai báo bên dưới cho biết các quy tắc trong gói này chỉ hiển thị với các thành viên của nhóm gói//foo:target. Nội dung khai báo chế độ hiển thị riêng lẻ trên một quy tắc (nếu có) sẽ ghi đè thông số kỹ thuật này.
package(default_visibility = ["//foo:target"])
package_group
package_group(name, packages, includes)
Hàm này xác định một tập hợp gói và liên kết một nhãn với tập hợp đó. Bạn có thể tham chiếu nhãn trong các thuộc tính visibility.
Nhóm gói chủ yếu được dùng để kiểm soát chế độ hiển thị. Mọi gói trong cây nguồn đều có thể tham chiếu đến một mục tiêu hiển thị công khai. Bạn chỉ có thể tham chiếu một mục tiêu hiển thị riêng tư trong gói của chính mục tiêu đó (không phải gói con). Giữa hai trường hợp cực đoan này, một mục tiêu có thể cho phép truy cập vào gói của chính nó cộng với bất kỳ gói nào được mô tả bởi một hoặc nhiều nhóm gói. Để biết nội dung giải thích chi tiết hơn về hệ thống chế độ hiển thị, hãy xem thuộc tính visibility.
Một gói nhất định được coi là thuộc nhóm nếu gói đó khớp với thuộc tính packages hoặc đã có trong một trong các nhóm gói khác được đề cập trong thuộc tính includes.
Về mặt kỹ thuật, nhóm gói là mục tiêu nhưng không được tạo theo quy tắc và không có bất kỳ biện pháp bảo vệ chế độ hiển thị nào.
Đối số
| Thuộc tính | Mô tả |
|---|---|
name |
Tên; bắt buộc Tên riêng cho mục tiêu này. |
packages |
Danh sách chuỗi; mặc định là Danh sách không có hoặc có nhiều thông số kỹ thuật của gói. Mỗi chuỗi thông số kỹ thuật của gói có thể có một trong các dạng sau:
Ngoài ra, hai loại thông số gói đầu tiên cũng có thể có tiền tố Nhóm gói chứa mọi gói khớp với ít nhất một trong
các quy cách khẳng định và không có quy cách phủ định nào.
Ví dụ: giá trị Ngoài chế độ hiển thị công khai, không có cách nào để chỉ định trực tiếp các gói bên ngoài kho lưu trữ hiện tại. Nếu thiếu thuộc tính này, thì thuộc tính này sẽ giống như khi được đặt thành một danh sách trống, cũng giống như khi được đặt thành một danh sách chỉ chứa Lưu ý: Trước Bazel 6.0, thông số kỹ thuật Lưu ý: Trước Bazel 6.0, khi thuộc tính này được chuyển đổi tuần tự dưới dạng một phần của |
includes |
Danh sách nhãn; mặc định là Các nhóm gói khác có trong nhóm này. Các nhãn trong thuộc tính này phải tham chiếu đến các nhóm gói khác.
Các gói trong nhóm gói được tham chiếu được coi là một phần của nhóm gói này. Đây là thuộc tính bắc cầu — nếu nhóm gói
Khi dùng cùng với thông số kỹ thuật của gói phủ định, xin lưu ý rằng tập hợp các gói cho mỗi nhóm trước tiên được tính toán độc lập, sau đó các kết quả được hợp nhất với nhau. Điều này có nghĩa là các thông số kỹ thuật bị phủ định trong một nhóm không ảnh hưởng đến các thông số kỹ thuật trong một nhóm khác. |
Ví dụ
Nội dung khai báo package_group sau đây chỉ định một nhóm gói có tên là "tropical" (nhiệt đới) chứa các loại trái cây nhiệt đới.
package_group(
name = "tropical",
packages = [
"//fruits/mango",
"//fruits/orange",
"//fruits/papaya/...",
],
)
Các nội dung khai báo sau đây chỉ định các nhóm gói của một ứng dụng giả định:
package_group(
name = "fooapp",
includes = [
":controller",
":model",
":view",
],
)
package_group(
name = "model",
packages = ["//fooapp/database"],
)
package_group(
name = "view",
packages = [
"//fooapp/swingui",
"//fooapp/webui",
],
)
package_group(
name = "controller",
packages = ["//fooapp/algorithm"],
)
exports_files
exports_files([label, ...], visibility, licenses)
exports_files() chỉ định danh sách các tệp thuộc gói này được xuất sang các gói khác.
Tệp BUILD cho một gói chỉ có thể tham chiếu trực tiếp đến các tệp nguồn thuộc về một gói khác nếu các tệp đó được xuất rõ ràng bằng câu lệnh exports_files(). Đọc thêm về chế độ hiển thị của tệp.
Theo hành vi cũ, các tệp được đề cập làm dữ liệu đầu vào cho một quy tắc cũng được xuất với chế độ hiển thị mặc định cho đến khi cờ --incompatible_no_implicit_file_export được lật. Tuy nhiên, bạn không nên dựa vào hành vi này và nên chủ động di chuyển khỏi hành vi này.
Đối số
Đối số là danh sách tên của các tệp trong gói hiện tại. Bạn cũng có thể chỉ định một khai báo về chế độ hiển thị; trong trường hợp này, các tệp sẽ hiển thị cho những mục tiêu được chỉ định. Nếu bạn không chỉ định chế độ hiển thị, thì mọi gói đều có thể nhìn thấy các tệp, ngay cả khi chế độ hiển thị mặc định của gói được chỉ định trong hàm package. Bạn cũng có thể chỉ định giấy phép.
Ví dụ
Ví dụ sau đây xuất golden.txt, một tệp văn bản từ gói test_data, để các gói khác có thể sử dụng, chẳng hạn như trong thuộc tính data của kiểm thử.
# from //test_data/BUILD exports_files(["golden.txt"])
glob
glob(include, exclude=[], exclude_directories=1, allow_empty=True)
Glob là một hàm trợ giúp tìm tất cả tệp khớp với một số mẫu đường dẫn nhất định, đồng thời trả về một danh sách mới, có thể thay đổi và được sắp xếp, của các đường dẫn đó. Glob chỉ tìm kiếm các tệp trong gói của riêng nó và chỉ tìm các tệp nguồn (không phải tệp được tạo cũng như các mục tiêu khác).
Nhãn của tệp nguồn được đưa vào kết quả nếu đường dẫn tương đối của gói tệp khớp với bất kỳ mẫu include nào và không khớp với mẫu exclude nào.
Danh sách include và exclude chứa các mẫu đường dẫn tương ứng với gói hiện tại. Mỗi mẫu có thể bao gồm một hoặc nhiều phân đoạn đường dẫn. Như thường lệ với đường dẫn Unix, các phân đoạn này được phân tách bằng /. Các phân đoạn trong mẫu được so khớp với các phân đoạn của đường dẫn. Các phân đoạn có thể chứa ký tự đại diện *: ký tự này khớp với bất kỳ chuỗi con nào trong phân đoạn đường dẫn (ngay cả chuỗi con trống), ngoại trừ dấu phân tách thư mục /. Bạn có thể sử dụng ký tự đại diện này nhiều lần trong một phân đoạn đường dẫn. Ngoài ra, ký tự đại diện ** có thể khớp với
không hoặc nhiều phân đoạn đường dẫn hoàn chỉnh, nhưng phải được khai báo dưới dạng một phân đoạn đường dẫn
độc lập.
foo/bar.txtkhớp chính xác với tệpfoo/bar.txttrong gói này (trừ phifoo/là một gói con)foo/*.txtkhớp với mọi tệp trong thư mụcfoo/nếu tệp kết thúc bằng.txt(trừ phifoo/là một gói con)foo/a*.htm*khớp với mọi tệp trong thư mụcfoo/bắt đầu bằnga, sau đó có một chuỗi tuỳ ý (có thể trống), sau đó có.htmvà kết thúc bằng một chuỗi tuỳ ý khác (trừ phifoo/là một gói con); chẳng hạn nhưfoo/axx.htmvàfoo/a.htmlhoặcfoo/axxx.htmlfoo/*khớp với mọi tệp trong thư mụcfoo/, (trừ phifoo/là một gói con); nó không khớp với chính thư mụcfoongay cả khiexclude_directoriesđược đặt thành 0foo/**khớp với mọi tệp trong mọi thư mục con không phải là gói con trong thư mục con cấp đầu tiên của góifoo/; nếuexclude_directoriesđược đặt thành 0, thì thư mụcfoocũng khớp với mẫu; trong trường hợp này,**được coi là khớp với không phân đoạn đường dẫn**/a.txtkhớp với các tệpa.txttrong thư mục của gói này cộng với các thư mục con không phải là gói con.**/bar/**/*.txtkhớp với mọi tệp.txttrong mọi thư mục con không phải là gói con của gói này, nếu ít nhất một thư mục trên đường dẫn kết quả được gọi làbar, chẳng hạn nhưxxx/bar/yyy/zzz/a.txthoặcbar/a.txt(hãy nhớ rằng**cũng khớp với không phân đoạn) hoặcbar/zzz/a.txt**khớp với mọi tệp trong mọi thư mục con không phải là gói con của gói nàyfoo**/a.txtlà một mẫu không hợp lệ vì**phải đứng riêng lẻ như một phân đoạnfoo/là một mẫu không hợp lệ vì phân đoạn thứ hai được xác định sau/là một chuỗi trống
Nếu đối số exclude_directories được bật (đặt thành 1), thì các tệp thuộc loại thư mục sẽ bị bỏ qua khỏi kết quả (mặc định là 1).
Nếu đối số allow_empty được đặt thành False, thì hàm glob sẽ báo lỗi nếu kết quả là danh sách trống.
Có một số hạn chế và cảnh báo quan trọng:
-
Vì
glob()chạy trong quá trình đánh giá tệp BUILD, nênglob()chỉ khớp với các tệp trong cây nguồn, chứ không bao giờ khớp với các tệp được tạo. Nếu đang tạo một mục tiêu yêu cầu cả tệp nguồn và tệp được tạo, bạn phải thêm danh sách rõ ràng các tệp được tạo vào glob. Hãy xem ví dụ bên dưới với:mylibvà:gen_java_srcs. -
Nếu một quy tắc có cùng tên với tệp nguồn trùng khớp, thì quy tắc đó sẽ "che khuất" tệp.
Để hiểu rõ điều này, hãy nhớ rằng
glob()trả về danh sách đường dẫn, vì vậy, việc sử dụngglob()trong thuộc tính của các quy tắc khác (ví dụ:srcs = glob(["*.cc"])) có tác dụng tương tự như việc liệt kê rõ ràng các đường dẫn phù hợp. Ví dụ: nếuglob()tạo ra["Foo.java", "bar/Baz.java"]nhưng cũng có một quy tắc trong gói có tên là "Foo.java" (được cho phép, mặc dù Bazel cảnh báo về quy tắc này), thì trình sử dụngglob()sẽ sử dụng quy tắc "Foo.java" (đầu ra của quy tắc này) thay vì tệp "Foo.java". Hãy xem vấn đề #10395 trên GitHub để biết thêm thông tin chi tiết. - Glob có thể khớp với các tệp trong thư mục con. Và tên thư mục con có thể chứa ký tự đại diện. Tuy nhiên...
-
Nhãn không được phép vượt qua ranh giới gói và glob không khớp với các tệp trong gói con.
Ví dụ: biểu thức glob
**/*.cctrong góixkhông bao gồmx/y/z.ccnếux/ytồn tại dưới dạng một gói (dưới dạngx/y/BUILDhoặc ở một nơi khác trên đường dẫn gói). Điều này có nghĩa là kết quả của biểu thức glob thực sự phụ thuộc vào sự tồn tại của tệp BUILD — tức là cùng một biểu thức glob sẽ bao gồmx/y/z.ccnếu không có gói nào tên làx/yhoặc gói đó được đánh dấu là đã xoá bằng cờ --deleted_packages. - Quy định hạn chế nêu trên áp dụng cho tất cả biểu thức glob, bất kể biểu thức đó sử dụng ký tự đại diện nào.
-
Một tệp ẩn có tên tệp bắt đầu bằng
.hoàn toàn khớp với cả ký tự đại diện**và*. Nếu bạn muốn so khớp một tệp ẩn với một mẫu phức hợp, thì mẫu của bạn cần bắt đầu bằng.. Ví dụ:*và.*.txtsẽ khớp với.foo.txt, nhưng*.txtthì không. Các thư mục ẩn cũng được so khớp theo cách tương tự. Thư mục ẩn có thể bao gồm các tệp không bắt buộc phải có dưới dạng dữ liệu đầu vào và có thể làm tăng số lượng tệp được glob không cần thiết và mức tiêu thụ bộ nhớ. Để loại trừ các thư mục ẩn, hãy thêm các thư mục đó vào đối số danh sách "exclude" (loại trừ). -
Ký tự đại diện "**" có một trường hợp đặc biệt: mẫu
"**"không khớp với đường dẫn thư mục của gói. Tức làglob(["**"], exclude_directories = False)khớp với tất cả tệp và thư mục chuyển tiếp nghiêm ngặt trong thư mục của gói hiện tại (nhưng tất nhiên là không đi vào thư mục của các gói con – hãy xem ghi chú trước đó về vấn đề này).
Nói chung, bạn nên cố gắng cung cấp một đuôi tệp thích hợp (ví dụ: *.html) thay vì sử dụng dấu "*" đơn thuần cho mẫu glob. Tên rõ ràng hơn vừa tự ghi lại vừa đảm bảo rằng bạn không vô tình khớp với các tệp sao lưu hoặc tệp tự động lưu emacs/vi/....
Khi viết quy tắc bản dựng, bạn có thể liệt kê các phần tử của glob. Ví dụ: điều này cho phép tạo các quy tắc riêng lẻ cho mọi dữ liệu đầu vào. Hãy xem phần ví dụ về glob mở rộng bên dưới.
Ví dụ về Glob
Tạo một thư viện Java được xây dựng từ tất cả tệp java trong thư mục này và tất cả tệp do quy tắc :gen_java_srcs tạo.
java_library(
name = "mylib",
srcs = glob(["*.java"]) + [":gen_java_srcs"],
deps = "...",
)
genrule(
name = "gen_java_srcs",
outs = [
"Foo.java",
"Bar.java",
],
...
)
Bao gồm tất cả tệp txt trong thư mục testdata, ngoại trừ tệp experimental.txt. Xin lưu ý rằng các tệp trong thư mục con của testdata sẽ không được đưa vào. Nếu bạn muốn đưa các tệp đó vào, hãy sử dụng glob đệ quy (**).
sh_test(
name = "mytest",
srcs = ["mytest.sh"],
data = glob(
["testdata/*.txt"],
exclude = ["testdata/experimental.txt"],
),
)
Ví dụ về Glob đệ quy
Đặt chương trình kiểm thử phụ thuộc vào tất cả tệp txt trong thư mục testdata và bất kỳ thư mục con nào của thư mục đó (và thư mục con của thư mục con, v.v.). Các thư mục con chứa tệp BUILD sẽ bị bỏ qua. (Xem các giới hạn và cảnh báo ở trên.)
sh_test(
name = "mytest",
srcs = ["mytest.sh"],
data = glob(["testdata/**/*.txt"]),
)
Tạo một thư viện được xây dựng từ tất cả các tệp java trong thư mục này và tất cả thư mục con, ngoại trừ những thư mục có đường dẫn chứa thư mục có tên là testing. Bạn nên tránh mẫu này nếu có thể, vì mẫu này có thể làm giảm tính gia tăng của bản dựng, từ đó làm tăng thời gian xây dựng.
java_library(
name = "mylib",
srcs = glob(
["**/*.java"],
exclude = ["**/testing/**"],
),
)
Ví dụ về Glob mở rộng
Tạo một genrule riêng lẻ cho *_test.cc trong thư mục hiện tại để đếm số dòng trong tệp.
# Conveniently, the build language supports list comprehensions.
[genrule(
name = "count_lines_" + f[:-3], # strip ".cc"
srcs = [f],
outs = ["%s-linecount.txt" % f[:-3]],
cmd = "wc -l $< >$@",
) for f in glob(["*_test.cc"])]
Nếu tệp BUILD ở trên nằm trong gói //foo và gói này chứa 3 tệp khớp, a_test.cc, b_test.cc và c_test.cc, thì việc chạy bazel query '//foo:all' sẽ liệt kê tất cả quy tắc đã được tạo:
$ bazel query '//foo:all' | sort //foo:count_lines_a_test //foo:count_lines_b_test //foo:count_lines_c_test
chọn
select(
{conditionA: valuesA, conditionB: valuesB, ...},
no_match_error = "custom message"
)
select() là hàm trợ giúp giúp thuộc tính quy tắc có thể định cấu hình.
Hàm này có thể thay thế phía bên phải của
gần như
mọi phép gán thuộc tính để giá trị của thuộc tính đó phụ thuộc vào cờ Bazel dòng lệnh.
Ví dụ: bạn có thể sử dụng thuộc tính này để xác định các phần phụ thuộc dành riêng cho nền tảng hoặc để nhúng các tài nguyên khác nhau tuỳ thuộc vào việc một quy tắc được xây dựng ở chế độ "nhà phát triển" hay "bản phát hành".
Cách sử dụng cơ bản như sau:
sh_binary(
name = "mytarget",
srcs = select({
":conditionA": ["mytarget_a.sh"],
":conditionB": ["mytarget_b.sh"],
"//conditions:default": ["mytarget_default.sh"]
})
)
Thao tác này giúp thuộc tính srcs của sh_binary có thể định cấu hình bằng cách thay thế việc gán danh sách nhãn thông thường bằng lệnh gọi select liên kết các điều kiện cấu hình với giá trị phù hợp. Mỗi điều kiện là một nhãn tham chiếu đến config_setting hoặc constraint_value, "khớp" nếu cấu hình của mục tiêu khớp với một tập hợp giá trị dự kiến. Sau đó, giá trị của mytarget#srcs sẽ trở thành bất kỳ danh sách nhãn nào khớp với lệnh gọi hiện tại.
Lưu ý:
- Chính xác một điều kiện được chọn trong bất kỳ lệnh gọi nào.
- Nếu có nhiều điều kiện khớp và một điều kiện là chuyên môn hoá của các điều kiện khác, thì điều kiện chuyên môn hoá sẽ được ưu tiên. Điều kiện B được coi là một phiên bản chuyên biệt của điều kiện A nếu B có tất cả các cờ và giá trị ràng buộc giống như A, cộng thêm một số cờ hoặc giá trị ràng buộc khác. Điều này cũng có nghĩa là việc phân giải chuyên môn không được thiết kế để tạo thứ tự như minh hoạ trong Ví dụ 2 bên dưới.
- Nếu nhiều điều kiện khớp và một điều kiện không phải là chuyên môn của tất cả các điều kiện khác, thì Bazel sẽ không thành công và báo lỗi, trừ phi tất cả điều kiện đều phân giải thành cùng một giá trị.
- Nhãn giả đặc biệt
//conditions:defaultđược coi là khớp nếu không có điều kiện nào khác khớp. Nếu bỏ qua điều kiện này, thì bạn phải so khớp một số quy tắc khác để tránh lỗi. selectcó thể được nhúng bên trong một phép gán thuộc tính lớn hơn. Vì vậy,srcs = ["common.sh"] + select({ ":conditionA": ["myrule_a.sh"], ...})vàsrcs = select({ ":conditionA": ["a.sh"]}) + select({ ":conditionB": ["b.sh"]})là các biểu thức hợp lệ.selecthoạt động với hầu hết các thuộc tính, nhưng không phải tất cả. Các thuộc tính không tương thích được đánh dấu bằng biểu tượngnonconfigurabletrong tài liệu.gói con
subpackages(include, exclude=[], allow_empty=True)
subpackages()là một hàm trợ giúp, tương tự nhưglob(), liệt kê các gói con thay vì tệp và thư mục. Hàm này sử dụng cùng một mẫu đường dẫn nhưglob()và có thể khớp với mọi gói con là phần tử con trực tiếp của tệp BUILD đang tải. Hãy xem glob để biết nội dung giải thích chi tiết và ví dụ về các mẫu bao gồm và loại trừ.Danh sách các gói con được trả về theo thứ tự sắp xếp và chứa các đường dẫn liên quan đến gói tải hiện tại khớp với các mẫu đã cho trong
includechứ không phải các mẫu trongexclude.Ví dụ
Ví dụ sau đây liệt kê tất cả các gói con trực tiếp cho gói
foo/BUILD# The following BUILD files exist: # foo/BUILD # foo/bar/baz/BUILD # foo/bar/but/bad/BUILD # foo/sub/BUILD # foo/sub/deeper/BUILD # # In foo/BUILD a call to subs1 = subpackages(include = ["**"]) # results in subs1 == ["sub", "bar/baz", "bar/but/bad"] # # 'sub/deeper' is not included because it is a subpackage of 'foo/sub' not of # 'foo' subs2 = subpackages(include = ["bar/*"]) # results in subs2 = ["bar/baz"] # # Since 'bar' is not a subpackage itself, this looks for any subpackages under # all first level subdirectories of 'bar'. subs3 = subpackages(include = ["bar/**"]) # results in subs3 = ["bar/baz", "bar/but/bad"] # # Since bar is not a subpackage itself, this looks for any subpackages which are # (1) under all subdirectories of 'bar' which can be at any level, (2) not a # subpackage of another subpackages. subs4 = subpackages(include = ["sub"]) subs5 = subpackages(include = ["sub/*"]) subs6 = subpackages(include = ["sub/**"]) # results in subs4 and subs6 being ["sub"] # results in subs5 = []. # # In subs4, expression "sub" checks whether 'foo/sub' is a package (i.e. is a # subpackage of 'foo'). # In subs5, "sub/*" looks for subpackages under directory 'foo/sub'. Since # 'foo/sub' is already a subpackage itself, the subdirectories will not be # traversed anymore. # In subs6, 'foo/sub' is a subpackage itself and matches pattern "sub/**", so it # is returned. But the subdirectories of 'foo/sub' will not be traversed # anymore.
Nhìn chung, thay vì gọi trực tiếp hàm này, người dùng nên sử dụng mô-đun "subpackages" của skylib.