Một mô-đun tích hợp sẵn để hỗ trợ các quy tắc gốc và các chức năng trợ giúp gói khác. Tất cả quy tắc gốc đều xuất hiện dưới dạng hàm trong mô-đun này, ví dụ: native.cc_library. Lưu ý rằng mô-đun gốc chỉ có sẵn trong giai đoạn tải (tức là cho macro, không khả dụng cho triển khai quy tắc). Các thuộc tính sẽ bỏ qua các giá trị None và coi như các thuộc tính đó chưa được đặt.
Các hàm sau đây cũng có sẵn:
Hội viên
- existing_rule
- existing_rules
- exports_files
- glob
- module_name
- module_version
- package_group
- package_name
- package_relative_label
- repository_name
- gói con
existing_rule
unknown native.existing_rule(name)
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().
Nếu bạn đặt cờ --noincompatible_existing_rules_immutable_view, thì hệ thống sẽ trả về một lệnh chính tả mới có thể thay đổi với cùng nội dung.
Kết quả chứa một mục nhập 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 chữ cái) và một số loại thuộc tính cũ không thể biểu thị. Ngoài ra, tập hợp này 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 kiểu str, int và bool được biểu thị nguyên trạng.
- 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. - Danh sách được biểu thị dưới dạng các bộ dữ liệu và các từ điển được chuyển đổi thành các từ điển 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 cách.
- Các giá trị
selectđược trả về với nội dung được chuyển đổi như mô tả ở trên. - Những 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 giá trị mặc định được tính toán cho đến giai đoạn phân tích).
Nếu có thể, hãy tránh sử dụng hàm này. Điều này khiến các 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 biến này khác với hai lượt chuyển đổi khác của các giá trị thuộc tính quy tắc từ dạng nội bộ đến Starlark: một lượt chuyển đổi được sử dụng theo giá trị mặc định đã tính toán và lượt chuyển đổi còn lại được ctx.attr.foo sử dụng.
Thông số
| Thông số | Mô tả |
|---|---|
name
|
bắt buộc Tên của mục tiêu. |
existing_rules
unknown native.existing_rules()
existing_rule(name) trả về.Ở đây, đối tượng giống như tập hợp không thể thay đổi có nghĩa là một đối tượng x không thể thay đổi sâu sắc hỗ trợ hoạt động lặp lại giống như tập hợp, len(x), name in x, x[name], x.get(name), x.items(), x.keys() và x.values().
Nếu bạn đặt cờ --noincompatible_existing_rules_immutable_view, thì hàm này sẽ trả về một tập hợp con mới có thể thay đổi với cùng nội dung.
Lưu ý: Nếu có thể, hãy tránh sử dụng hàm này. Điều này khiến các tệp BUILD trở nên dễ hỏng và phụ thuộc vào thứ tự. Hơn nữa, nếu bạn đặt cờ --noincompatible_existing_rules_immutable_view , thì hàm này có thể sẽ rất tốn kém, đặc biệt là khi được gọi trong vòng lặp.
exports_files
None native.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; mặc định là NoneBạn có thể chỉ định nội dung khai báo chế độ hiển thị. Các tệp sẽ hiển thị cho các mục tiêu đã chỉ định. Nếu bạn không chỉ định chế độ hiển thị, thì mọi gói sẽ xem được các tệp này. |
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 native.glob(include=[], exclude=[], exclude_directories=1, allow_empty=unbound)
- 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 (đặt thành 1), thì 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ầ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ầu nối cần loại trừ. |
exclude_directories
|
mặc định là 1Cờ cho biết có loại trừ thư mục hay không. |
allow_empty
|
mặc định là unboundLiệu chúng ta có cho phép các mẫu cầu nối để 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 native.module_name()
module.name mà bạn thấy trong module_ctx.modules.
Có thể trả về None.
module_version
string native.module_version()
module.version mà bạn thấy trong module_ctx.modules.
Có thể trả về None.
package_group
None native.package_group(name, packages=[], includes=[])visibility.
Thông số
| Thông số | Mô tả |
|---|---|
name
|
bắt buộc Tên riêng biệ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ó trong nhóm này. |
package_name
string native.package_name()
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. Hàm này tương đương với biến PACKAGE_NAME không còn được dùng nữa.
package_relative_label
Label native.package_relative_label(input)
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à tệp này gọi trực tiếp hoặc gián tiếp; không được gọi trong hàm triển khai quy tắc (ví dụ:).
Kết quả của hàm này là giá trị Label giống như giá trị được tạo bằng cách truyền chuỗi đã cho đến thuộc tính có giá trị nhãn của một 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ư một trình biên dịch. Sử dụng package_relative_label() khi bạn cần chuẩn hoá chuỗi nhãn mà 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 một đối tượng Nhãn được truyền, đối tượng đó sẽ được trả về nguyên trạng. |
repository_name
string native.repository_name()
local_repository(name='local', path=...), thì gói này sẽ được đặt thành @local. Trong các gói thuộc kho lưu trữ chính, thuộc tính này sẽ được thiết lập thành @. Hàm này tương đương với biến REPOSITORY_NAME không còn được dùng nữa.
gói con
sequence native.subpackages(include, exclude=[], allow_empty=False)
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 nối cần loại trừ khỏi quá trình quét gói con. |
allow_empty
|
giá trị 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 thấy lỗi tiềm ẩn trong tệp BUILD, trong đó lệnh gọi đến gói con() là quá mức. Nếu bạn đặt thành true, thì hàm này có thể thành công trong trường hợp đó. |