Các phương thức có trong tệp BUILD. Hãy xem thêm Bách khoa toàn thư về bản dựng để biết thêm hàm và quy tắc bản dựng. Bạn cũng có thể sử dụng các hàm và quy tắc này trong tệp BUILD.
Hội viên
- phần phụ thuộc
- existing_rule
- existing_rules
- exports_files
- glob
- module_name
- module_version
- package_group
- package_name
- package_relative_label
- repo_name
- repository_name
- chọn
- gói con
phần tách rời
depset depset(direct=None, order="default", *, transitive=None)Tạo depset. Tham số
direct là một danh sách các phần tử trực tiếp của tập hợp lại và tham số transitive là một danh sách các phần tử phụ thuộc mà các phần tử của nó trở thành phần tử gián tiếp của tập hợp đã tạo. Thứ tự các phần tử được trả về khi phần tách được chuyển đổi thành danh sách được chỉ định bằng tham số order. Hãy xem Tổng quan về phần phụ thuộc để biết thêm thông tin.
Tất cả các phần tử (trực tiếp và gián tiếp) của một tập hợp phải thuộc cùng một kiểu, như thu được trong biểu thức type(x).
Vì tập hợp dựa trên hàm băm được dùng để loại bỏ các phần tử trùng lặp trong quá trình lặp lại, nên tất cả các phần tử của một tập hợp phần phụ thuộc phải có thể băm. Tuy nhiên, bất biến này hiện không được kiểm tra một cách nhất quán trong tất cả các hàm khởi tạo. Sử dụng cờ --incompatible_always_check_depset_View để bật quy trình kiểm tra nhất quán; đây sẽ là hành vi mặc định trong các bản phát hành sau này; hãy xem Vấn đề 10313.
Ngoài ra, các phần tử hiện phải không thể thay đổi, mặc dù quy định hạn chế này sẽ được nới lỏng trong tương lai.
Thứ tự của phần phụ thuộc được tạo phải tương thích với thứ tự của các phần phụ thuộc transitive. Thứ tự "default" tương thích với mọi thứ tự khác, tất cả các thứ tự khác chỉ tương thích với chính chúng.
Thông số
| Thông số | Mô tả |
|---|---|
direct
|
sequence; hoặc None;
giá trị mặc định là NoneDanh sách các phần tử trực tiếp của một tập hợp. |
order
|
string;
mặc định là "default"Chiến lược duyệt qua cho depset mới. Hãy xem tại đây để biết các giá trị có thể có. |
transitive
|
trình tự của phần phụ; hoặc None;
mặc định là NoneDanh sách các phần tử phụ thuộc mà các phần tử của nó sẽ trở thành phần tử gián tiếp của tập hợp. |
existing_rule
unknown existing_rule(name)Trả về một đối tượng giống lệnh chính tả không thể thay đổi mô tả các thuộc tính của một quy tắc được tạo thực thể trong gói của luồng này hoặc
None nếu không có thực thể quy tắc nào có tên đó.Ở đây, một đối tượng dạng ký tự không thể thay đổi có nghĩa là một đối tượng không thể thay đổi sâu rộng x hỗ trợ lặp lại theo dạng nhập chính tả, len(x), name in x, x[name], x.get(name), x.items(), x.keys() và x.values().
Kết quả chứa một mục cho mỗi thuộc tính, ngoại trừ các thuộc tính riêng tư (tên không bắt đầu bằng một chữ cái) và một số loại thuộc tính cũ không thể hiển thị. Ngoài ra, dict chứa các mục nhập cho name và kind của thực thể quy tắc (ví dụ: 'cc_binary').
Các giá trị của kết quả đại diện cho các giá trị thuộc tính như sau:
- Các thuộc tính thuộc loại str, int và bool được biểu thị như hiện có.
- Nhãn được chuyển đổi thành chuỗi có dạng
':foo'cho các mục tiêu trong cùng một gói hoặc'//pkg:name'cho các mục tiêu trong một gói khác. - Các danh sách được biểu thị dưới dạng bộ dữ liệu (tuple) và các lệnh chính tả (dicts) được chuyển đổi thành các lệnh chính tả mới, có thể thay đổi. Các phần tử của chúng được chuyển đổi đệ quy theo cùng một kiểu.
- Giá trị
selectđược trả về cùng với nội dung của các giá trị đó đã biến đổi như mô tả ở trên. - Các thuộc tính không có giá trị được chỉ định trong quá trình tạo bản sao quy tắc và có giá trị mặc định được tính toán sẽ bị loại trừ khỏi kết quả. (Không thể tính toán các giá trị mặc định đã tính cho đến giai đoạn phân tích.).
Nếu có thể, chỉ sử dụng hàm này trong hàm triển khai của macro biểu tượng của trình kết thúc quy tắc. Bạn không nên sử dụng hàm này trong các ngữ cảnh khác và hàm này sẽ bị vô hiệu hoá trong bản phát hành Bazel trong tương lai; hàm này khiến tệp BUILD trở nên dễ hỏng và phụ thuộc vào thứ tự. Ngoài ra, hãy lưu ý rằng cách chuyển đổi này khác một chút so với hai cách chuyển đổi khác của giá trị thuộc tính quy tắc từ dạng nội bộ sang Starlark: một cách được sử dụng bởi giá trị mặc định được tính toán, cách còn lại được sử dụng bởi ctx.attr.foo.
Thông số
| Thông số | Mô tả |
|---|---|
name
|
string;
bắt buộc Tên của mục tiêu. |
existing_rules
unknown existing_rules()Trả về một đối tượng giống như tập hợp không thể thay đổi mô tả các quy tắc đã được tạo bản sao trong gói của luồng này. Mỗi mục nhập của đối tượng giống lệnh chính tả sẽ ánh xạ tên của thực thể quy tắc với kết quả mà
existing_rule(name) sẽ trả về.Ở đây, một đối tượng dạng ký tự không thể thay đổi có nghĩa là một đối tượng không thể thay đổi sâu rộng x hỗ trợ lặp lại theo dạng nhập chính tả, len(x), name in x, x[name], x.get(name), x.items(), x.keys() và x.values().
Nếu có thể, chỉ sử dụng hàm này trong hàm triển khai của macro biểu tượng của trình kết thúc quy tắc. Bạn không nên sử dụng hàm này trong các ngữ cảnh khác và hàm này sẽ bị vô hiệu hoá trong bản phát hành Bazel trong tương lai; hàm này khiến tệp BUILD trở nên dễ hỏng và phụ thuộc vào thứ tự.
exports_files
None exports_files(srcs, visibility=None, licenses=None)Thông số
| Thông số | Mô tả |
|---|---|
srcs
|
trình tự của chuỗi;
bắt buộc Danh sách các tệp cần xuất. |
visibility
|
sequence; hoặc None;
giá trị mặc định là NoneBạn có thể chỉ định nội dung khai báo về chế độ hiển thị. Tệp sẽ hiển thị cho các 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ể thấy các tệp đó. |
licenses
|
trình tự của chuỗi; hoặc None; giá trị mặc định là NoneGiấy phép cần chỉ định. |
glob
sequence glob(include=[], exclude=[], exclude_directories=1, allow_empty=unbound)Glob trả về một danh sách mới, có thể thay đổi, được sắp xếp cho mọi tệp trong gói hiện tại:
- Khớp với ít nhất một mẫu trong
include. - Không khớp với mẫu nào trong
exclude(mặc định là[]).
exclude_directories được bật (được đặt thành 1), các tệp thuộc thư mục loại sẽ bị loại khỏi kết quả (1 mặc định).
Thông số
| Thông số | Mô tả |
|---|---|
include
|
trình tự của chuỗi;
mặc định là []Danh sách các mẫu cụm cầu cần đưa vào. |
exclude
|
trình tự của chuỗi;
mặc định là []Danh sách các mẫu cụm cầu cần loại trừ. |
exclude_directories
|
int;
giá trị mặc định là 1Cờ cho biết có loại trừ thư mục hay không. |
allow_empty
|
giá trị mặc định là unboundLiệu chúng ta có cho phép các mẫu toàn cầu để không khớp không có giá trị nào. Nếu "allow_empty" là False, thì mỗi mẫu bao gồm riêng lẻ phải khớp với một nội dung nào đó và kết quả cuối cùng cũng phải không rỗng (sau khi loại trừ các kết quả khớp với mẫu "exclude"). |
module_name
string module_name()Tên của mô-đun Bazel liên kết với kho lưu trữ chứa gói này. Nếu gói này là từ một kho lưu trữ được xác định trong WORKSPACE thay vì MODULE.bazel, thì bạn sẽ trống. Đối với repos được tạo bởi tiện ích mô-đun, đây là tên của mô-đun lưu trữ tiện ích. Trường này giống với trường
module.name trong module_ctx.modules.
Có thể trả về None.
module_version
string module_version()Phiên bản của mô-đun Bazel liên kết với kho lưu trữ chứa gói này. Nếu gói này là từ một kho lưu trữ được xác định trong WORKSPACE thay vì MODULE.bazel, thì gói này sẽ trống. Đối với các kho lưu trữ do tiện ích mô-đun tạo, đây là phiên bản của mô-đun lưu trữ tiện ích. Trường này giống với trường
module.version trong module_ctx.modules.
Có thể trả về None.
package_group
None package_group(name, packages=[], includes=[])visibility.
Thông số
| Thông số | Mô tả |
|---|---|
name
|
string;
bắt buộc Tên duy nhất cho quy tắc này. |
packages
|
trình tự của chuỗi;
mặc định là []Liệt kê đầy đủ các gói trong nhóm này. |
includes
|
trình tự của chuỗi;
mặc định là []Các nhóm gói khác được bao gồm trong mục này. |
package_name
string package_name()Tên của gói đang được đánh giá, không có tên kho lưu trữ. Ví dụ: trong tệp BUILD
some/package/BUILD, giá trị của tệp này sẽ là some/package. Nếu tệp BUILD gọi một hàm được xác định trong tệp .bzl, thì package_name() sẽ khớp với gói tệp BUILD của phương thức gọi.
package_relative_label
Label package_relative_label(input)Chuyển đổi chuỗi đầu vào thành đối tượng Label (Nhãn), trong ngữ cảnh gói hiện đang được khởi tạo (nghĩa là tệp
BUILD mà macro hiện tại đang thực thi). Nếu giá trị đầu vào đã là Label, thì giá trị này sẽ được trả về mà không thay đổi.Hàm này chỉ có thể được gọi trong khi đánh giá tệp BUILD và các macro mà hàm này gọi trực tiếp hoặc gián tiếp; nó có thể không được gọi trong (ví dụ) trong hàm triển khai quy tắc.
Kết quả của hàm này giống với giá trị Label như được tạo bằng cách truyền chuỗi đã cho vào thuộc tính nhãn có giá trị của mục tiêu được khai báo trong tệp BUILD.
Lưu ý sử dụng: Sự khác biệt giữa hàm này và Label() là Label() sử dụng ngữ cảnh của gói của tệp .bzl được gọi, chứ không phải gói của tệp BUILD. Sử dụng Label() khi bạn cần tham chiếu đến một mục tiêu cố định được mã hoá cứng vào macro, chẳng hạn như trình biên dịch. Sử dụng package_relative_label() khi bạn cần chuẩn hoá chuỗi nhãn do tệp BUILD cung cấp cho đối tượng Label. (Không có cách nào để chuyển đổi chuỗi thành Label trong ngữ cảnh gói khác ngoài tệp BUILD hoặc tệp .bzl đang gọi. Vì lý do đó, macro bên ngoài phải luôn ưu tiên truyền đối tượng Nhãn vào macro bên trong thay vì chuỗi nhãn.)
Thông số
| Thông số | Mô tả |
|---|---|
input
|
string; hoặc Label;
bắt buộc Chuỗi nhãn đầu vào hoặc đối tượng Nhãn. Nếu đối tượng Nhãn được truyền, đối tượng đó sẽ được trả về nguyên trạng. |
repo_name
string repo_name()Tên chuẩn hoá của kho lưu trữ chứa gói hiện đang được đánh giá, không có ký hiệu @ ở đầu.
repository_name
string repository_name()Thử nghiệm. API 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 đừ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
--+incompatible_enable_deprecated_label_apis Không dùng nữa. Thay vào đó, hãy sử dụng
repo_name. Kiểu này không chứa dấu @ dẫn đầu giả mạo nhưng hoạt động giống hệt như vậy.Tên chuẩn của kho lưu trữ chứa gói đang được đánh giá, có một dấu @ (@) ở đầu. Ví dụ: trong các gói được gọi là tồn tại theo khổ WORKSPACE local_repository(name='local', path=...), thì gói này sẽ được đặt thành @local. Trong các gói trong kho lưu trữ chính, giá trị này sẽ được đặt thành @.
chọn
unknown select(x, no_match_error='')
select() là hàm trợ giúp giúp thuộc tính quy tắc có thể định cấu hình. Hãy xem phần tạo bách khoa toàn thư để biết thông tin chi tiết.
Thông số
| Thông số | Mô tả |
|---|---|
x
|
dict;
bắt buộc Một dict ánh xạ các điều kiện cấu hình đến các giá trị. Mỗi khoá là một Nhãn hoặc một chuỗi nhãn xác định một bản sao config_setting hoặc limited_value. Hãy xem tài liệu về macro để biết thời điểm sử dụng Nhãn thay vì chuỗi. |
no_match_error
|
string;
giá trị mặc định là ''Lỗi tuỳ chỉnh (không bắt buộc) cần báo cáo nếu không có điều kiện nào khớp. |
gói con
sequence subpackages(include, exclude=[], allow_empty=False)Trả về một danh sách mới có thể thay đổi của mọi gói con trực tiếp của gói hiện tại, bất kể chiều sâu thư mục hệ thống tệp. Danh sách trả về được sắp xếp và chứa tên của các gói con tương ứng với gói hiện tại. Bạn nên sử dụng các phương thức trong mô-đun bazel_skylib.subpackages thay vì gọi trực tiếp hàm này.
Thông số
| Thông số | Mô tả |
|---|---|
include
|
trình tự của chuỗi;
bắt buộc Danh sách các mẫu glob để đưa vào quá trình quét gói con. |
exclude
|
trình tự của chuỗi;
mặc định là []Danh sách các mẫu cầu cầu cần loại trừ khỏi quá trình quét gói con. |
allow_empty
|
bool;
mặc định là FalseLiệu chúng ta có thất bại nếu lệnh gọi trả về danh sách trống hay không. Theo mặc định, danh sách trống cho biết lỗi tiềm ẩn trong tệp BUILD, trong đó lệnh gọi đến subpackages() là thừa. Việc đặt thành true cho phép hàm này thành công trong trường hợp đó. |