gốc

Báo cáo sự cố Xem nguồn Hằng đêm · 7,3 · 7.2 · 7.1 · 7,0 · 6,5

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

unknown native.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 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()

Trả về một đối tượng giống lệnh chính tả không thể thay đổi mô tả các quy tắc cho đến nay vẫn được tạo thực thể 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 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)

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.

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à None
Bạ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à None
Giấy phép sẽ được chỉ định.

hình cầu

sequence native.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 bất kỳ mẫu nào trong exclude (mặc định là []).
Nếu đối số 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à 1
Cờ cho biết có loại trừ thư mục hay không.
allow_empty giá trị mặc định là unbound
Liệ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()

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 mà bạn thấy trong module_ctx.modules. Có thể trả về None.

module_version

string native.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ì bạn sẽ trống. Đối với repos do tiện ích mô-đun tạo ra, đây là phiên bản mô-đun lưu trữ tiện ích. Trường này giống với trường 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=[])

Hàm này xác định một tập hợp các gói và chỉ định nhãn cho nhóm. Bạn có thể tham chiếu nhãn trong các thuộc tính 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()

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 native.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ì 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.

repo_name

string native.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 native.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 ưu tiên sử dụng repo_name. Ký tự này không chứa ký hiệu hàng đầu giả, nhưng hoạt động giống hệt nhau.

Tên chuẩn hoá của kho lưu trữ chứa gói hiện đang được đánh giá, với một ký hiệu @ (@) được đặt ở đầ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 thuộc kho lưu trữ chính, thuộc tính này sẽ được thiết lập thành @.

gói con

sequence native.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ể độ 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.

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à False
Liệ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 đó.