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ả các quy tắc gốc sẽ 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à xử lý các giá trị đó như thể thuộc tính chưa được đặt.
Bạn cũng có thể dùng các hàm sau:
Hội viên
- existing_rule
- existing_rules
- exports_files
- toàn cầu
- 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 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 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, lệnh chính tả còn 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ả biểu thị 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 các 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ị nào được chỉ định trong quá trình tạo quy tắc và có giá trị mặc định được tính 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ể, hãy tránh sử dụng hàm này. Điều này làm cho tệp BUILD trở nên dễ vỡ 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ừ biểu mẫu 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.
Tham 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) 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 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.
Lưu ý: Nếu có thể, hãy tránh sử dụng hàm này. Điều này làm cho tệp BUILD trở nên dễ vỡ 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)Tham 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
|
trình tự; hoặc None;
giá trị mặc định là NoneBạn có thể chỉ định 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 sẽ xem được các tệp này. |
licenses
|
trình tự của chuỗi; hoặc None;
mặc định là NoneGiấy phép sẽ được chỉ định. |
hình cầu
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 bất kỳ 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).
Tham 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
|
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" có giá trị là False, thì mỗi mẫu bao gồm riêng lẻ phải khớp với nội dung nào đó và kết quả cuối cùng không được để trống (sau khi các kết quả trùng khớp của mẫu "loại trừ" bị loại trừ). |
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.
Tham số
| Thông số | Mô tả |
|---|---|
name
|
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 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 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ì kết quả trả về sẽ 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ư 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.)
Tham 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 dùng nữa.
gói con
sequence native.subpackages(include, exclude=[], allow_empty=False)
Tham 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 cầu cầu cần đưa vào khi 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
|
giá trị mặc định là FalseLiệu chúng ta có gặp lỗi hay không nếu lệnh gọi trả về danh sách trố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 đó. |