Hàm

Báo cáo sự cố Xem nguồn Hằng đêm · 7,4 của Google. 7.3 · 7.2 · 7.1 · 7 · 6,5

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. Mã này được sử dụng tối đa một lần trong gói (tệp BUILD).

Đối với phần đối ứng 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 chính xác các đối số giống như package().

Bạn nên gọi hàm package() 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 của default_package_metadata.

default_visibility

Danh sách nhãn; mặc định là []

Chế độ hiển thị mặc định của các quy tắc trong gói này.

Mọi quy tắc trong gói này có chế độ hiển thị được chỉ định trong trừ phi có quy định khác trong visibility của quy tắc. Để biết thông tin chi tiết về cú pháp của tính năng này hãy xem tài liệu về chế độ hiển thị. Chế độ hiển thị mặc định của gói không áp dụng cho exports_files, tức là công khai theo mặc định.

default_deprecation

String; giá trị mặc định là ""

Đặt thông báo deprecation mặc định cho tất cả các quy tắc trong gói này.

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 việc khai báo giấy phép và gói OSS. Hãy xem rules_license để biết ví dụ.

default_testonly

Boolean; mặc định là False trừ phi có ghi chú

Đặt mặc định Thuộc tính testonly cho tất cả quy tắc trong gói này.

Trong các gói thuộc javatests, giá trị mặc định là True.

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ý theo cách đặc biệt. Đừng sử dụng tính năng này trừ phi có người làm việc trên hệ thống xây dựng yêu cầu rõ ràng.

Ví dụ

Nội dung khai báo bên dưới khai báo rằng 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. Các 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 các 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 Thuộc tính visibility.

Các nhóm gói chủ yếu được dùng để kiểm soát chế độ hiển thị. Bạn có thể tham chiếu mục tiêu hiển thị công khai từ mọi gói trong cây nguồn. Bạn chỉ có thể tham chiếu đến mục tiêu hiển thị riêng tư trong gói của mục tiêu đó (không phải gói con). Giữa các trường hợp này, 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 được mô tả bởi một hoặc nhiều nhóm gói. Để biết thêm chi tiết về hệ thống hiển thị, hãy xem khả năng hiển thị .

Một gói hàng nhất định được coi là nằm trong nhóm nếu gói đó khớp với Thuộc tính packages hoặc đã có trong một thuộc tính khác các nhóm gói được đề cập trong thuộc tính includes.

Nhóm gói về mặt kỹ thuật là các mục tiêu, nhưng không được tạo bằng quy tắc và bản thân các nhóm gói không có 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 duy nhất 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 thông số sau biểu mẫu:

  1. Tên đầy đủ của một gói, không có kho lưu trữ, bắt đầu bằng dấu gạch chéo đôi. Ví dụ: //foo/bar chỉ định gói có tên đó và nằm trong cùng một kho lưu trữ với gói nhóm.
  2. Như trên, nhưng có /... theo sau. Ví dụ: //foo/... chỉ định tập hợp //foo và tất cả các gói con của tập hợp đó. //... chỉ định tất cả các gói trong kho lưu trữ hiện tại.
  3. Chuỗi public hoặc private mà chỉ định từng gói hoặc không gói nào. (Biểu mẫu này yêu cầu bạn phải đặt cờ --incompatible_package_group_has_public_syntax.)

Ngoài ra, hai kiểu thông số kỹ thuật đầu tiên của gói cũng có thể có tiền tố - để cho biết chúng bị phủ định.

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 dương và không có quy cách âm nào. Ví dụ: giá trị [//foo/..., -//foo/tests/...] bao gồm tất cả các gói con của //foo mà không phải là gói con của //foo/tests. (Bản thân //foo là được bao gồm trong khi //foo/tests thì không.)

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ì việc này cũng giống như việc đặt thuộc tính này thành danh sách trống, cũng giống như việc đặt thuộc tính này thành danh sách chỉ chứa private.

Lưu ý: Trước Bazel 6.0, thông số kỹ thuật //... có hành vi cũ giống với public. Hành vi này được khắc phục khi bạn bật --incompatible_fix_package_group_reporoot_syntax. Đây là chế độ mặc định sau Bazel 6.0.

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 bazel query --output=proto (hoặc --output=xml), các dấu gạch chéo ở đầu sẽ bị bỏ qua. Cho nên //pkg/foo/... sẽ cho ra kết quả dưới dạng \"pkg/foo/...\". Hành vi này được khắc phục khi --incompatible_package_group_includes_double_slash là là bật mặc định sau Bazel 6.0.

includes

Danh sách nhãn; giá trị mặc định là []

Các nhóm gói khác được bao gồm trong mục này.

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à bắc cầu – nếu nhóm gói a bao gồm nhóm gói bb bao gồm nhóm gói c, sau đó mọi gói trong c cũng sẽ là thành viên của a.

Khi sử dụng cùng với thông số kỹ thuật của gói bị bỏ qua, xin lưu ý rằng cho mỗi nhóm được tính toán độc lập và các kết quả sau đó được tập hợp với nhau. Điều này có nghĩa là các thông số kỹ thuật 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à "nhiệt đới" có chứa trái cây nhiệt đới.

package_group(
    name = "tropical",
    packages = [
        "//fruits/mango",
        "//fruits/orange",
        "//fruits/papaya/...",
    ],
)

Các khai báo sau chỉ định nhóm gói của một hư cấu ứng dụng:

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 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 dưới dạng dữ liệu đầu vào cho 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 bị lật. Tuy nhiên, bạn không nên dựa vào và chủ động làm theo hành vi này đã di chuyển.

Đố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 nội dung khai báo chế độ hiển thị; trong trường hợp này, các tệp sẽ hiển thị với các mục tiêu được chỉ định. Nếu không chỉ định chế độ hiển thị, tệp sẽ sẽ hiển thị với mọi gói, ngay cả khi chế độ hiển thị mặc định của gói là được chỉ định trong package . Giấy phép cũng có thể được chỉ định.

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 dịch vụ các gói có thể sử dụng thuộc tính này, ví dụ như trong thuộc tính data kiểm thử.

# from //test_data/BUILD

exports_files(["golden.txt"])

hình cầu

glob(include, exclude=[], exclude_directories=1, allow_empty=True)

Glob là một hàm trợ giúp giúp tìm tất cả các tệp khớp với một số mẫu đường dẫn nhất định, và trả về một danh sách mới, có thể thay đổi và được sắp xếp theo thứ tự các đường dẫn của chúng. 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 hay các mục tiêu khác).

Nhãn của tệp nguồn sẽ được đưa vào kết quả nếu đường dẫn tương đối của gói trong 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 includeexclude 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 các phân đoạn đường dẫn khác. Như thường lệ với các đườ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 có thể chứa ký tự đại diện *: đoạn 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òng phân cách thư mục /. Ký tự đại diện này có thể dùng 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 không có hoặc có nhiều phân đoạn đường dẫn hoàn chỉnh, nhưng bạn phải khai báo chúng dưới dạng một phân đoạn độc lập đường dẫn.

Ví dụ:
  • foo/bar.txt khớp chính xác với tệp foo/bar.txt trong gói hàng này
  • foo/*.txt khớp với mọi tệp trong thư mục foo/ nếu tệp kết thúc bằng .txt (trừ phi foo/ là một gói con)
  • foo/a*.htm* khớp với mọi tệp trong foo/ thư mục bắt đầu bằng a, sau đó có một chuỗi tuỳ ý (có thể để trống), sau đó có .htm và kết thúc bằng một chuỗi tuỳ ý khác; chẳng hạn như foo/axx.htmfoo/a.html hoặc foo/axxx.html
  • **/a.txt khớp với mọi tệp a.txt trong mọi thư mục con của gói này
  • **/bar/**/*.txt khớp với mọi .txt tệp trong mỗi thư mục con của gói này, nếu có ít nhất một thư mục trên đường dẫn kết quả là có tên là bar, chẳng hạn như xxx/bar/yyy/zzz/a.txt hoặc bar/a.txt (xin lưu ý rằng ** cũng khớp với 0 phân khúc) hoặc bar/zzz/a.txt
  • ** khớp với mọi tệp trong mọi thư mục con của tệp này gói hàng
  • foo**/a.txt là mẫu không hợp lệ vì ** phải đứng riêng lẻ như một phân đoạn

Nếu bạn bật đối số exclude_directories (đặt thành 1), 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, Hàm glob sẽ gặp lỗi nếu kết quả là danh sách trống.

Có một số giới hạn và cảnh báo quan trọng:

  1. glob() chạy trong quá trình đánh giá tệp BUILD, glob() chỉ khớp với các tệp trong cây nguồn, không bao giờ 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 đã tạo, bạn phải thêm một danh sách rõ ràng gồm các tệp đã tạo vào glob. Xem ví dụ bên dưới với :mylib:gen_java_srcs.

  2. Nếu quy tắc có cùng tên với tệp nguồn phù hợp, thì quy tắc đó sẽ "bóng" tệp.

    Để hiểu điều này, hãy nhớ rằng glob() trả về một danh sách đường dẫn, vì vậy, việc sử dụng glob() trong thuộc tính của các quy tắc khác (ví dụ: srcs = glob(["*.cc"])) cũng có tác dụng tương tự như việc liệt kê rõ ràng các đường dẫn đã so khớp. Ví dụ: nếu glob() trả về ["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 phép, mặc dù Bazel cảnh báo về quy tắc này), thì người dùng của glob() sẽ sử dụng quy tắc "Foo.java" (đầu ra của quy tắc này) thay vì tệp "Foo.java". Xem GitHub vấn đề #10395 để biết thêm chi tiết.

  3. Tệp hình ảnh có thể khớp với các tệp trong thư mục con. Và tên thư mục con có thể là ký tự đại diện. Tuy nhiên...
  4. 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 **/*.cc trong gói x không bao gồm x/y/z.cc nếu x/y tồn tại dưới dạng một gói (dưới dạng x/y/BUILD hoặc ở nơi khác trên đường dẫn gói). Chiến dịch này có nghĩa là kết quả của biểu thức cầu vồng 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 cầu nối sẽ bao gồm x/y/z.cc nếu không có gói nào được gọi x/y hoặc mục đã được đánh dấu là đã xóa bằng cách sử dụng --deleted_packages cờ.

  5. Quy định hạn chế ở trên áp dụng cho tất cả biểu thức glob, bất kể chúng sử dụng ký tự đại diện nào.
  6. Một tệp ẩn có tên tệp bắt đầu bằng . được khớp hoàn toàn bằng cả ký tự đại diện ***. 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ụ: *.*.txt sẽ khớp với .foo.txt, nhưng *.txt sẽ không khớp. 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 những tệp không được yêu cầu làm dữ liệu đầu vào và có thể tăng số lượng tệp được sao lưu không cần thiết và mức sử dụng bộ nhớ. Để loại trừ thư mục ẩn, hãy thêm chúng vào trường "loại trừ" đối số cho danh sách.
  7. 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. Điều đó có nghĩa là glob(["**"], exclude_directories = 0) khớp với tất cả các tệp và thư mục một cách nghiêm ngặt trong thư mục của gói hiện tại (nhưng tất nhiên không đi vào thư mục của các gói con – hãy xem ghi chú trước đó về điều đó).

Nhìn chung, bạn nên thử cung cấp một đuôi tệp thích hợp (ví dụ: *.html) thay vì sử dụng dấu "*" trầ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 so khớp bản sao lưu tệp, hoặc emacs/vi/... tệp tự động lưu.

Khi viết các quy tắc bản dựng, bạn có thể liệt kê các phần tử của khối cầu. Chiến dịch này cho phép tạo quy tắc riêng 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ề ánh sáng loá

Tạo một thư viện Java được xây dựng từ tất cả cá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ả các tệp txt trong dữ liệu kiểm thử thư mục, ngoại trừ webExperimental.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 mà bạn muốn đưa những tệp đó vào, hãy sử dụng khối cầu hồi quy (**).

sh_test(
    name = "mytest",
    srcs = ["mytest.sh"],
    data = glob(
        ["testdata/*.txt"],
        exclude = ["testdata/experimental.txt"],
    ),
)

Ví dụ về vòng tròn đệ quy

Đảm bảo chương trình kiểm thử phụ thuộc vào tất cả các tệp txt trong thư mục dữ liệu kiểm thử và bất kỳ tệp nào của các thư mục con (và thư mục con của chúng, 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à lưu ý ở 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 bao gồm một thư mục có tên là kiểm thử. Bạn nên tránh dùng mẫu này nếu có thể vì mẫu này có thể làm giảm bản dựng và do đó 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 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 chứa ba tệp phù hợp, a_test.cc, b_test.cc và c_test.cc rồi chạy bazel query '//foo:all' sẽ liệt kê tất cả những 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 tạo thuộc tính quy tắc có thể định cấu hình. Tham số này có thể thay thế phía bên phải của gần như mọi thao tác gán thuộc tính vì vậy 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 tính năng 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 nhiều tài nguyên tuỳ thuộc vào việc một quy tắc được tạo ở 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"]
    })
)

Điều 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 chỉ định 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 các 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. Điều kiện này sẽ "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 giá trị bất kỳ danh sách nhãn khớp với lệnh gọi hiện tại.

Lưu ý:

  • Chỉ chọn một điều kiện trên bất kỳ lệnh gọi nào.
  • Nếu nhiều điều kiện khớp và một điều kiện là chuyên môn của các điều kiện khác, thì điều kiện chuyên môn sẽ được ưu tiên. Điều kiện B được coi là chuyên môn hoá điều kiện A nếu B có tất cả cờ và quy tắc ràng buộc giống nhau dưới dạng A cộng với một số cờ hoặc giá trị ràng buộc bổ sung. Việc này cũng có nghĩa là quá trình phân giải chuyên môn không được thiết kế để tạo thứ tự như được 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 biệt 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ừ khi tất cả cá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 điều kiện này bị bỏ qua, một số quy tắc khác phải phù hợp để tránh lỗi.
  • select có thể được nhúng bên trong gán thuộc tính. Vì vậy, srcs = ["common.sh"] + select({ ":conditionA": ["myrule_a.sh"], ...}) srcs = select({ ":conditionA": ["a.sh"]}) + select({ ":conditionB": ["b.sh"]}) là biểu thức hợp lệ.
  • select hoạt động với hầu hết (nhưng không phải tất cả) thuộc tính. Các thuộc tính không tương thích được đánh dấu là nonconfigurable trong 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. Chiến dịch này sử dụng cùng một đường dẫn dưới dạng glob() và có thể khớp với bất kỳ gói con nào là thành phần 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 kết quả của các gói con được trả về theo thứ tự được sắp xếp và chứa đường dẫn tương ứng với gói tải hiện tại khớp với các mẫu đã cho trong include chứ không phải những miền trong exclude.

    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/sub/BUILD
    # foo/sub/deeper/BUILD
    #
    # In foo/BUILD a call to
    subs = subpackages(include = ["**"])
    
    # results in subs == ["sub", "bar/baz"]
    #
    # 'sub/deeper' is not included because it is a subpackage of 'foo/sub' not of
    # 'foo'
    

    Nhìn chung, bạn nên ưu tiên gọi hàm này thay vì trực tiếp gọi hàm này mà người dùng sử dụng mô-đun của skylib.