Các phương thức chung có trong mọi tệp .bzl.
Hội viên
- analysis_test_transition
- góc nhìn
- configuration_field
- depset
- exec_group
- module_extension
- provider
- repository_rule
- quy tắc
- chọn
- quy tắc phụ
- tag_class
- khả năng hiển thị
analysis_test_transition
transition analysis_test_transition(settings)
Tạo một quá trình chuyển đổi cấu hình để áp dụng trên các phần phụ thuộc của quy tắc phân tích-kiểm thử. Bạn chỉ có thể áp dụng quá trình chuyển đổi này trên các thuộc tính của quy tắc có analysis_test = True
. Các quy tắc như vậy bị hạn chế về chức năng (ví dụ: kích thước của cây phần phụ thuộc bị giới hạn), vì vậy, các hiệu ứng chuyển đổi được tạo bằng hàm này bị giới hạn về phạm vi tiềm năng so với các hiệu ứng chuyển đổi được tạo bằng transition()
.
Hàm này chủ yếu được thiết kế để hỗ trợ thư viện cốt lõi Khung kiểm thử phân tích. Hãy xem tài liệu (hoặc cách triển khai) để biết các phương pháp hay nhất.
Thông số
Thông số | Mô tả |
---|---|
settings
|
bắt buộc Một từ điển chứa thông tin về các chế độ cài đặt cấu hình sẽ được đặt bằng quá trình chuyển đổi cấu hình này. Khoá là các nhãn cài đặt bản dựng và giá trị là giá trị mới sau khi chuyển đổi. Tất cả các chế độ cài đặt khác đều không thay đổi. Sử dụng lệnh này để khai báo các chế độ cài đặt cấu hình cụ thể mà kiểm thử phân tích yêu cầu phải được thiết lập để có thể vượt qua. |
chương trình thành phần
Aspect aspect(implementation, attr_aspects=[], attrs={}, required_providers=[], required_aspect_providers=[], provides=[], requires=[], fragments=[], host_fragments=[], toolchains=[], incompatible_use_toolchain_transition=False, doc=None, *, apply_to_generating_rules=False, exec_compatible_with=[], exec_groups=None, subrules=[])Tạo một khía cạnh mới. Kết quả của hàm này phải được lưu trữ trong một giá trị toàn cục. Vui lòng xem phần giới thiệu về Aspects để biết thêm thông tin chi tiết.
Thông số
Thông số | Mô tả |
---|---|
implementation
|
bắt buộc Hàm Starlark triển khai khía cạnh này, với đúng hai tham số: Target (mục tiêu áp dụng khía cạnh) và ctx (ngữ cảnh quy tắc tạo mục tiêu). Bạn có thể xem các thuộc tính của mục tiêu thông qua trường ctx.rule . Hàm này được đánh giá trong giai đoạn phân tích cho mỗi ứng dụng của một khía cạnh cho một mục tiêu.
|
attr_aspects
|
trình tự của chuỗi; mặc định là [] Danh sách tên thuộc tính. Đối tượng này sẽ truyền theo các phần phụ thuộc được chỉ định trong thuộc tính của mục tiêu bằng những tên này. Các giá trị phổ biến ở đây bao gồm deps và exports . Danh sách này cũng có thể chứa một chuỗi "*" duy nhất để truyền cùng tất cả các phần phụ thuộc của một mục tiêu.
|
attrs
|
dict;
mặc định là {} Một từ điển khai báo tất cả các thuộc tính của một khía cạnh. Thuộc tính này liên kết từ tên thuộc tính đến đối tượng thuộc tính, chẳng hạn như "attr.label" hoặc "attr.string" (xem mô-đun attr). Các thuộc tính khung hình có sẵn cho hàm triển khai dưới dạng các trường của tham số ctx . Các thuộc tính ngầm ẩn bắt đầu bằng Thuộc tính rõ ràng phải có loại |
required_providers
|
mặc định là [] Thuộc tính này cho phép khung hình giới hạn việc truyền nội dung ở những mục tiêu có quy tắc quảng cáo trình cung cấp bắt buộc. Giá trị phải là một danh sách chứa từng nhà cung cấp hoặc danh sách nhà cung cấp, nhưng không được chứa cả hai. Ví dụ: [[FooInfo], [BarInfo], [BazInfo, QuxInfo]] là giá trị hợp lệ trong khi [FooInfo, BarInfo, [BazInfo, QuxInfo]] không hợp lệ.Danh sách các nhà cung cấp chưa lồng sẽ tự động được chuyển thành danh sách chứa một danh sách các nhà cung cấp. Tức là Để hiển thị một số mục tiêu theo quy tắc (ví dụ: |
required_aspect_providers
|
mặc định là [] Thuộc tính này cho phép khía cạnh này kiểm tra các khía cạnh khác. Giá trị phải là một danh sách chứa từng nhà cung cấp hoặc danh sách nhà cung cấp, nhưng không được chứa cả hai. Ví dụ: [[FooInfo], [BarInfo], [BazInfo, QuxInfo]] là giá trị hợp lệ trong khi [FooInfo, BarInfo, [BazInfo, QuxInfo]] không hợp lệ.Danh sách nhà cung cấp không lồng nhau sẽ tự động được chuyển đổi thành danh sách chứa một danh sách nhà cung cấp. Tức là Để hiển thị một phương diện khác (ví dụ: |
provides
|
mặc định là [] Danh sách các nhà cung cấp mà hàm triển khai phải trả về. Sẽ không có lỗi nếu hàm triển khai bỏ qua bất kỳ loại trình cung cấp nào được liệt kê ở đây trong giá trị trả về. Tuy nhiên, hàm triển khai có thể trả về các nhà cung cấp khác không được liệt kê ở đây. Mỗi phần tử của danh sách là một đối tượng |
requires
|
trình tự của Khung hình;
mặc định là [] Danh sách các khía cạnh cần phải được truyền trước khía cạnh này. |
fragments
|
trình tự của chuỗi; mặc định là [] Danh sách tên của các mảnh cấu hình mà khía cạnh yêu cầu trong cấu hình mục tiêu. |
host_fragments
|
trình tự của chuỗi; mặc định là [] Danh sách tên của các mảnh cấu hình mà khía cạnh đó yêu cầu trong cấu hình máy chủ. |
toolchains
|
trình tự; giá trị mặc định là [] Nếu được đặt, tập hợp các chuỗi công cụ mà quy tắc này yêu cầu. Danh sách này có thể chứa các đối tượng String, Label hoặc StarlarkToolchainTypeApi, theo bất kỳ cách kết hợp nào. Bạn sẽ tìm thấy chuỗi công cụ bằng cách kiểm tra nền tảng hiện tại và được cung cấp cho việc triển khai quy tắc thông qua ctx.toolchain .
|
incompatible_use_toolchain_transition
|
mặc định là False Không dùng nữa, thuộc tính này không còn được sử dụng và nên được xoá. |
doc
|
chuỗi; hoặc None ; giá trị mặc định là None Nội dung mô tả về khía cạnh có thể được trích xuất bằng các công cụ tạo tài liệu. |
apply_to_generating_rules
|
mặc định là False Nếu đúng, khi áp dụng cho tệp đầu ra, tỷ lệ khung hình sẽ áp dụng cho quy tắc tạo của tệp đầu ra. Ví dụ: giả sử một khía cạnh truyền tải gián tiếp thông qua thuộc tính "deps" và được áp dụng cho mục tiêu "alpha". Giả sử "alpha" có "deps = [':beta_output']`, trong đó "beta_output" là đầu ra đã khai báo của mục tiêu "beta". Giả sử "beta" có mục tiêu "charlie" là một trong các "deps" của nó. Nếu "apply_to_generating_rules=True" cho khía cạnh, thì khía cạnh sẽ truyền tải thông qua "alpha", "beta" và "charlie". Nếu là False, thì khía cạnh sẽ chỉ truyền tải đến "alpha". False theo mặc định. |
exec_compatible_with
|
trình tự của chuỗi;
mặc định là [] Danh sách các quy tắc ràng buộc trên nền tảng thực thi áp dụng cho tất cả các thực thể của khía cạnh này. |
exec_groups
|
dict; hoặc None ; mặc định là None Nhập tên nhóm thực thi (chuỗi) vào exec_group s. Nếu được đặt, hãy cho phép các khía cạnh chạy hành động trên nhiều nền tảng thực thi trong một thực thể duy nhất. Hãy xem tài liệu về nhóm thực thi để biết thêm thông tin.
|
subrules
|
trình tự của Quy tắc phụ;
mặc định là [] Thử nghiệm: danh sách quy tắc phụ mà khía cạnh này sử dụng. |
configuration_field
LateBoundDefault configuration_field(fragment, name)Tham chiếu đến giá trị mặc định liên kết muộn cho một thuộc tính thuộc loại label (nhãn). Một giá trị được gọi là "giới hạn trễ" nếu giá trị đó yêu cầu cấu hình được tạo trước khi xác định giá trị. Mọi thuộc tính sử dụng giá trị này phải riêng tư.
Ví dụ về cách sử dụng:
Xác định thuộc tính quy tắc:
'_foo': attr.label(default=configuration_field(fragment='java', name='toolchain'))
Truy cập trong quá trình triển khai quy tắc:
def _rule_impl(ctx): foo_info = ctx.attr._foo ...
Thông số
Thông số | Mô tả |
---|---|
fragment
|
bắt buộc Tên của một mảnh cấu hình chứa giá trị giới hạn trễ. |
name
|
bắt buộc Tên của giá trị cần lấy từ mảnh cấu hình. |
depset
depset depset(direct=None, order="default", *, transitive=None)Tạo một tập hợp. 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ử đó trở thành phần tử gián tiếp của tập hợp đã tạo. Thứ tự trả về các phần tử khi depset được chuyển đổi thành danh sách được chỉ định bằng tham số order
. 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 bản sao trong quá trình lặp lại, nên tất cả phần tử của một tập hợp đều có thể băm được. Tuy nhiên, hằng số này hiện không được kiểm tra nhất quán trong tất cả các hàm khởi tạo. Sử dụng cờ --incompatible_always_check_depset_elements để bật tính năng 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; xem Vấn đề 10313.
Ngoài ra, các thành phần hiện phải ở dạng 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 nhóm phần phụ thuộc được tạo phải tương thích với thứ tự của các nhóm phần phụ thuộc transitive
. Đơn đặt hàng "default"
tương thích với mọi đơn đặt hàng khác, tất cả các đơn đặt hàng khác chỉ tương thích với chính đơn đặt hàng đó.
Thông số
Thông số | Mô tả |
---|---|
direct
|
trình tự; hoặc None ;
mặc định là None Danh sách các phần tử trực tiếp của một depset. |
order
|
mặc định là "default" Chiến lược truyền tải cho tập hợp mới. Hãy xem tại đây để biết các giá trị có thể có. |
transitive
|
trình tự của nhóm phần phụ thuộc; hoặc None ;
mặc định là None Danh sách các nhóm phần phụ thuộc có phần tử sẽ trở thành phần tử gián tiếp của nhóm phần phụ thuộc. |
exec_group
exec_group exec_group(toolchains=[], exec_compatible_with=[])Tạo một nhóm thực thi có thể dùng để tạo hành động cho một nền tảng thực thi cụ thể trong quá trình triển khai quy tắc.
Thông số
Thông số | Mô tả |
---|---|
toolchains
|
sequence;
mặc định là [] Tập hợp chuỗi công cụ mà nhóm thực thi này yêu cầu. Danh sách này có thể chứa các đối tượng Chuỗi, Nhãn hoặc StarlarkToolchainTypeApi theo bất kỳ cách kết hợp nào. |
exec_compatible_with
|
trình tự của chuỗi; mặc định là [] Danh sách các quy tắc ràng buộc trên nền tảng thực thi. |
module_extension
unknown module_extension(implementation, *, tag_classes={}, doc=None, environ=[], os_dependent=False, arch_dependent=False)Tạo một phần mở rộng mô-đun mới. Lưu trữ giá trị này trong một giá trị toàn cục để có thể xuất và sử dụng trong tệp MODULE.bazel bằng
use_extension
.
Thông số
Thông số | Mô tả |
---|---|
implementation
|
bắt buộc Hàm triển khai tiện ích mô-đun này. Phải có một tham số duy nhất là module_ctx . Hàm này được gọi một lần ở đầu bản dựng để xác định tập hợp các kho lưu trữ hiện có.
|
tag_classes
|
mặc định là {} Một từ điển để khai báo tất cả các lớp thẻ mà tiện ích sử dụng. Lớp này liên kết từ tên của lớp thẻ đến đối tượng tag_class .
|
doc
|
chuỗi; hoặc None ;
mặc định là None Nội dung mô tả về tiện ích mô-đun có thể được trích xuất bằng các công cụ tạo tài liệu. |
environ
|
Trình tự của chuỗi; mặc định là [] Cung cấp danh sách biến môi trường mà tiện ích mô-đun này phụ thuộc vào. Nếu một biến môi trường trong danh sách đó thay đổi, tiện ích sẽ được đánh giá lại. |
os_dependent
|
giá trị mặc định là False Cho biết tiện ích này có phụ thuộc vào hệ điều hành hay không |
arch_dependent
|
giá trị mặc định là False Cho biết tiện ích này có phụ thuộc vào cấu trúc hay không |
provider
unknown provider(doc=None, *, fields=None, init=None)Xác định biểu tượng nhà cung cấp. Bạn có thể tạo thực thể của trình cung cấp bằng cách gọi hoặc sử dụng trực tiếp làm khoá để truy xuất thực thể của trình cung cấp đó từ một mục tiêu. Ví dụ:
MyInfo = provider() ... def _my_library_impl(ctx): ... my_info = MyInfo(x = 2, y = 3) # my_info.x == 2 # my_info.y == 3 ...
Hãy xem phần Quy tắc (Nhà cung cấp) để biết hướng dẫn toàn diện về cách sử dụng nhà cung cấp.
Trả về giá trị có thể gọi Provider
nếu init
không được chỉ định.
Nếu chỉ định init
, sẽ trả về một bộ dữ liệu gồm 2 phần tử: một giá trị có thể gọi Provider
và một giá trị có thể gọi hàm khởi tạo thô. Hãy xem bài viết Quy tắc (Khởi chạy tuỳ chỉnh nhà cung cấp dịch vụ tuỳ chỉnh) và nội dung thảo luận về thông số init
bên dưới để biết thông tin chi tiết.
Thông số
Thông số | Mô tả |
---|---|
doc
|
string; hoặc None ; mặc định là None Nội dung mô tả về trình cung cấp có thể được trích xuất bằng các công cụ tạo tài liệu. |
fields
|
trình tự của chuỗi; hoặc từ điển; hoặc None ;
mặc định là None Nếu được chỉ định, hãy hạn chế tập hợp các trường được phép. Các giá trị có thể sử dụng là:
|
init
|
có thể gọi; hoặc None ; mặc định là None Lệnh gọi lại không bắt buộc để xử lý trước và xác thực các giá trị trường của trình cung cấp trong quá trình tạo thực thể. Nếu bạn chỉ định init , provider() sẽ trả về một bộ dữ liệu gồm 2 phần tử: biểu tượng trình cung cấp thông thường và hàm khởi tạo thô.Sau đây là nội dung mô tả chính xác; hãy xem phần Quy tắc (Khởi chạy tuỳ chỉnh của trình cung cấp) để thảo luận và tìm hiểu các trường hợp sử dụng trực quan. Hãy đặt
init không được cung cấp, lệnh gọi đến biểu tượng P sẽ đóng vai trò là lệnh gọi đến hàm hàm khởi tạo mặc định c ; nói cách khác, P(*args, **kwargs) sẽ trả về c(*args, **kwargs) . Ví dụ:MyInfo = provider() m = MyInfo(foo = 1)sẽ tạo một cách đơn giản để m là một thực thể MyInfo với m.foo == 1 .Tuy nhiên, trong trường hợp
Lưu ý: các bước trên ngụ ý rằng lỗi sẽ xảy ra nếu Bằng cách này, lệnh gọi lại Khi chỉ định MyInfo, _new_myinfo = provider(init = ...) |
repository_rule
callable repository_rule(implementation, *, attrs=None, local=False, environ=[], configure=False, remotable=False, doc=None)Tạo quy tắc mới cho kho lưu trữ. Lưu trữ giá trị này trong một giá trị toàn cục để có thể tải và gọi qua hàm triển khai
module extension
hoặc được use_repo_rule
sử dụng.
Thông số
Thông số | Mô tả |
---|---|
implementation
|
bắt buộc hàm triển khai quy tắc này. Phải có một tham số duy nhất, repository_ctx . Hàm này được gọi trong giai đoạn tải cho mỗi thực thể của quy tắc.
|
attrs
|
dict; hoặc None ; mặc định là từ điển None để khai báo tất cả các thuộc tính của quy tắc. Phương thức này liên kết từ tên thuộc tính đến đối tượng thuộc tính (xem mô-đun attr). Các thuộc tính bắt đầu bằng _ là thuộc tính riêng tư và có thể được dùng để thêm một phần phụ thuộc ngầm ẩn trên một nhãn vào một tệp (quy tắc kho lưu trữ không thể phụ thuộc vào một cấu phần phần mềm được tạo). Thuộc tính name được thêm ngầm ẩn và không được chỉ định.
|
local
|
mặc định là False Cho biết rằng quy tắc này tìm nạp mọi thứ từ hệ thống cục bộ và cần được đánh giá lại ở mỗi lần tìm nạp. |
environ
|
Trình tự của chuỗi;
mặc định là [] Không dùng nữa. Thông số này không còn được dùng nữa. Hãy di chuyển sang repository_ctx.getenv .Cung cấp danh sách biến môi trường mà quy tắc kho lưu trữ này phụ thuộc vào. Nếu một biến môi trường trong danh sách đó thay đổi, thì kho lưu trữ sẽ được tìm nạp lại. |
configure
|
mặc định là False Cho biết kho lưu trữ kiểm tra hệ thống cho mục đích cấu hình |
remotable
|
mặc định là False Thử nghiệm. Tham số 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 không phụ thuộc vào tính năng này. Tính năng này có thể được bật trên cơ sở thử nghiệm bằng cách thiết lập ---experimental_repo_remote_exec Tương thích với thực thi từ xa |
doc
|
string; hoặc None ;
mặc định là None Nội dung mô tả quy tắc kho lưu trữ có thể được trích xuất bằng các công cụ tạo tài liệu. |
quy tắc
callable rule(implementation, *, test=unbound, attrs={}, outputs=None, executable=unbound, output_to_genfiles=False, fragments=[], host_fragments=[], _skylark_testable=False, toolchains=[], incompatible_use_toolchain_transition=False, doc=None, provides=[], exec_compatible_with=[], analysis_test=False, build_setting=None, cfg=None, exec_groups=None, initializer=None, parent=None, extendable=None, subrules=[])Tạo quy tắc mới, có thể được gọi từ tệp BUILD hoặc macro để tạo mục tiêu.
Bạn phải gán quy tắc cho các biến toàn cục trong tệp .bzl; tên của biến toàn cục là tên của quy tắc.
Quy tắc kiểm thử bắt buộc phải có tên kết thúc bằng _test
, trong khi tất cả các quy tắc khác không được có hậu tố này. (Hạn chế này chỉ áp dụng cho các quy tắc, không áp dụng cho các mục tiêu của chúng.)
Thông số
Thông số | Mô tả |
---|---|
implementation
|
required hàm Starlark triển khai quy tắc này, phải có đúng một tham số: ctx. Hàm này được gọi trong giai đoạn phân tích cho mỗi thực thể của quy tắc. Phương thức này có thể truy cập vào các thuộc tính do người dùng cung cấp. Lớp này phải tạo các thao tác để tạo tất cả dữ liệu đầu ra đã khai báo. |
test
|
bool;
mặc định là unbound Cho biết quy tắc này có phải là quy tắc kiểm thử hay không, tức là quy tắc có thể là chủ thể của lệnh blaze test hay không. Tất cả quy tắc kiểm thử đều tự động được xem là có thể thực thi; không cần thiết (và không khuyến khích) đặt executable = True một cách rõ ràng cho quy tắc kiểm thử. Giá trị mặc định là False . Xem trang Quy tắc để biết thêm thông tin.
|
attrs
|
dict; mặc định là từ điển {} để khai báo tất cả các thuộc tính của quy tắc. Thuộc tính này ánh xạ từ tên thuộc tính đến một đối tượng thuộc tính (xem mô-đun attr). Các thuộc tính bắt đầu bằng _ là riêng tư và có thể dùng để thêm phần phụ thuộc ngầm ẩn vào một nhãn. Thuộc tính name được ngầm thêm vào và không được chỉ định. Các thuộc tính visibility , deprecation , tags , testonly và features được thêm ngầm và không thể ghi đè. Hầu hết các quy tắc chỉ cần một số thuộc tính. Để giới hạn mức sử dụng bộ nhớ, hàm quy tắc sẽ áp đặt giới hạn về kích thước của các thuộc tính.
|
outputs
|
dict; hoặc None ; hoặc function;
mặc định là None Không dùng nữa. Thông số này không còn được dùng nữa và sẽ sớm bị loại bỏ. Vui lòng đừng phụ thuộc vào tính năng này. Tính năng này bị tắt bằng ---incompatible_no_rule_outputs_param . Sử dụng cờ này để xác minh rằng mã của bạn tương thích với việc sắp bị xoá. Tham số này không được dùng nữa. Di chuyển các quy tắc để sử dụng OutputGroupInfo hoặc attr.output . Giản đồ để xác định đầu ra được khai báo trước. Không giống như các thuộc tính Giá trị của đối số này là một từ điển hoặc một hàm gọi lại tạo ra một từ điển. Lệnh gọi lại hoạt động tương tự như các thuộc tính phần phụ thuộc đã tính toán: Tên tham số của hàm được so khớp với các thuộc tính của quy tắc. Chẳng hạn, nếu bạn truyền Mỗi mục nhập trong từ điển sẽ tạo một đầu ra được khai báo trước, trong đó khoá là một giá trị nhận dạng và giá trị là một mẫu chuỗi xác định nhãn của đầu ra. Trong hàm triển khai của quy tắc, giá trị nhận dạng sẽ trở thành tên trường dùng để truy cập vào
Trong thực tế, phần giữ chỗ thay thế phổ biến nhất là |
executable
|
bool; mặc định là unbound Liệu quy tắc này có được xem là có thể thực thi hay không, tức là quy tắc đó có thể là chủ thể của lệnh blaze run hay không. Thuộc tính này mặc định là False . Xem trang Quy tắc để biết thêm thông tin.
|
output_to_genfiles
|
giá trị mặc định là False Nếu giá trị là true, thì các tệp sẽ được tạo trong thư mục genfiles thay vì thư mục bin. Trừ khi bạn cần nó để tương thích với các quy tắc hiện có (ví dụ: khi tạo tệp tiêu đề cho C++), không đặt cờ này. |
fragments
|
trình tự của chuỗi; mặc định là [] Danh sách tên của các mảnh cấu hình mà quy tắc yêu cầu trong cấu hình mục tiêu. |
host_fragments
|
trình tự của chuỗi; giá trị mặc định là [] Danh sách tên của các mảnh cấu hình mà quy tắc yêu cầu trong cấu hình máy chủ lưu trữ. |
_skylark_testable
|
mặc định là False (Thử nghiệm) Nếu đúng, quy tắc này sẽ hiển thị các thao tác để kiểm tra theo các quy tắc phụ thuộc vào quy tắc đó thông qua trình cung cấp Actions . Trình cung cấp cũng có sẵn cho chính quy tắc bằng cách gọi ctx.created_actions().Bạn chỉ nên sử dụng phương thức này để kiểm thử hành vi tại thời điểm phân tích của các quy tắc Starlark. Cờ này có thể bị xoá trong tương lai. |
toolchains
|
trình tự; mặc định là [] Nếu được đặt, tập hợp các chuỗi công cụ mà quy tắc này yêu cầu. Danh sách này có thể chứa các đối tượng String, Label hoặc StarlarkToolchainTypeApi, theo bất kỳ cách kết hợp nào. Bạn sẽ tìm thấy chuỗi công cụ bằng cách kiểm tra nền tảng hiện tại và được cung cấp cho việc triển khai quy tắc thông qua ctx.toolchain .
|
incompatible_use_toolchain_transition
|
mặc định là False Không dùng nữa, thuộc tính này không còn được sử dụng và nên được xoá. |
doc
|
chuỗi; hoặc None ;
mặc định là None Nội dung mô tả quy tắc có thể được trích xuất bằng các công cụ tạo tài liệu. |
provides
|
mặc định là [] Danh sách các nhà cung cấp mà hàm triển khai phải trả về. Sẽ không có lỗi nếu hàm triển khai bỏ qua bất kỳ loại trình cung cấp nào được liệt kê ở đây trong giá trị trả về. Tuy nhiên, hàm triển khai có thể trả về các nhà cung cấp khác không được liệt kê ở đây. Mỗi phần tử của danh sách là một đối tượng |
exec_compatible_with
|
trình tự của chuỗi; mặc định là [] Danh sách các điều kiện ràng buộc trên nền tảng thực thi áp dụng cho tất cả mục tiêu của loại quy tắc này. |
analysis_test
|
mặc định là False Nếu đúng, thì quy tắc này được coi là một thử nghiệm phân tích. Lưu ý: Các quy tắc kiểm thử phân tích chủ yếu được xác định bằng cách sử dụng cơ sở hạ tầng được cung cấp trong các thư viện Starlark cốt lõi. Hãy xem phần Kiểm thử để biết hướng dẫn. Nếu một quy tắc được xác định là quy tắc kiểm thử phân tích, thì quy tắc đó sẽ được phép sử dụng các chuyển đổi cấu hình được xác định bằng analysis_test_transition trên các thuộc tính, nhưng được phép sử dụng một số hạn chế:
|
build_setting
|
BuildSetting; hoặc None ; mặc định là None Nếu được đặt, hãy mô tả loại build setting của quy tắc này. Xem mô-đun config . Nếu bạn đặt thuộc tính này, thì thuộc tính bắt buộc có tên là "build_setting_default" sẽ tự động được thêm vào quy tắc này, kèm theo loại tương ứng với giá trị được chuyển vào đây.
|
cfg
|
mặc định là None Nếu được đặt, hãy trỏ đến quá trình chuyển đổi cấu hình mà quy tắc sẽ áp dụng cho cấu hình của chính nó trước khi phân tích. |
exec_groups
|
dict; hoặc None ; mặc định là None Nhập tên nhóm thực thi (chuỗi) vào exec_group s. Nếu được đặt, cho phép các quy tắc chạy hành động trên nhiều nền tảng thực thi trong một mục tiêu. Hãy xem tài liệu về nhóm thực thi để biết thêm thông tin.
|
initializer
|
mặc định là None Thử nghiệm: hàm Stalark khởi tạo các thuộc tính của quy tắc. Hàm này được gọi tại thời điểm tải cho mỗi thực thể của quy tắc. Phương thức này được gọi bằng Phương thức này phải trả về một từ điển từ tên thuộc tính đến các giá trị mong muốn. Các thuộc tính không được trả về sẽ không bị ảnh hưởng. Việc trả về Trình khởi tạo được đánh giá trước giá trị mặc định được chỉ định trong một định nghĩa thuộc tính. Do đó, nếu một tham số trong chữ ký của trình khởi tạo chứa các giá trị mặc định, thì tham số đó sẽ ghi đè giá trị mặc định trong định nghĩa thuộc tính (trừ trường hợp trả về Tương tự, nếu một tham số trong chữ ký của trình khởi tạo không có giá trị mặc định, thì tham số đó sẽ trở thành bắt buộc. Bạn nên bỏ qua các chế độ cài đặt mặc định/bắt buộc trên định nghĩa thuộc tính trong những trường hợp như vậy. Bạn nên sử dụng Trong trường hợp quy tắc mở rộng, tất cả trình khởi chạy đều được gọi từ phần tử con đến phần tử cấp trên. Mỗi trình khởi chạy chỉ được truyền các thuộc tính công khai mà trình khởi chạy đó biết. |
parent
|
mặc định là None Thử nghiệm: quy tắc Stalark được mở rộng. Khi đặt, các thuộc tính công khai sẽ được hợp nhất cũng như các nhà cung cấp được quảng cáo. Quy tắc này khớp với executable và test từ phần tử mẹ. Các giá trị của fragments , toolchains , exec_compatible_with và exec_groups được hợp nhất. Không thể đặt các tham số cũ hoặc không được dùng nữa. Quá trình chuyển đổi cấu hình đến cfg của nhà xuất bản mẹ sẽ được áp dụng sau khi có cấu hình sắp tới của quy tắc này.
|
extendable
|
bool; hoặc Nhãn; hoặc chuỗi; hoặc None ;
mặc định là None Thử nghiệm: Nhãn của danh sách cho phép xác định những quy tắc có thể mở rộng quy tắc này. Bạn cũng có thể đặt giá trị này thành True/False để luôn cho phép/không cho phép gia hạn. Theo mặc định, Bazel luôn cho phép các tiện ích. |
subrules
|
trình tự của Quy tắc phụ;
mặc định là [] Thử nghiệm: Danh sách quy tắc phụ mà quy tắc này sử dụng. |
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
|
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. 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
|
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. |
quy tắc phụ
Subrule subrule(implementation, attrs={}, toolchains=[], fragments=[], subrules=[])Tạo một thực thể mới của quy tắc phụ. Bạn phải lưu trữ kết quả của hàm này trong một biến toàn cục thì mới có thể sử dụng.
Thông số
Thông số | Mô tả |
---|---|
implementation
|
hàm;
bắt buộc Hàm Starlark triển khai quy tắc phụ này |
attrs
|
dict; giá trị mặc định là {} Một từ điển để khai báo tất cả thuộc tính (riêng tư) của quy tắc phụ. Quy tắc phụ chỉ có thể có các thuộc tính riêng tư có nhãn (ví dụ: nhãn hoặc danh sách nhãn). Các giá trị đã được phân giải tương ứng với các nhãn này được Bazel tự động chuyển đến hàm triển khai của quy tắc phụ dưới dạng đối số đã đặt tên (do đó, hàm triển khai phải chấp nhận các tham số đã đặt tên khớp với tên thuộc tính). Các loại giá trị này sẽ là:
|
toolchains
|
trình tự;
mặc định là [] Nếu được đặt, thì tập hợp các chuỗi công cụ mà quy tắc phụ này yêu cầu. Danh sách này có thể chứa các đối tượng Chuỗi, Nhãn hoặc StarlarkToolchainTypeApi, theo bất kỳ cách kết hợp nào. Bạn có thể tìm thấy chuỗi công cụ bằng cách kiểm tra nền tảng hiện tại và cung cấp cho quá trình triển khai quy tắc phụ thông qua ctx.toolchains .
|
fragments
|
trình tự của chuỗi;
mặc định là [] Danh sách tên của các mảnh cấu hình mà quy tắc phụ yêu cầu trong cấu hình mục tiêu. |
subrules
|
trình tự của Quy tắc phụ;
mặc định là [] Danh sách các quy tắc phụ khác mà quy tắc phụ này cần. |
tag_class
tag_class tag_class(attrs={}, *, doc=None)Tạo một đối tượng tag_class mới, đối tượng này xác định giản đồ thuộc tính cho một lớp thẻ. Đây là các đối tượng dữ liệu có thể sử dụng được bằng tiện ích mô-đun.
Thông số
Thông số | Mô tả |
---|---|
attrs
|
mặc định là {} Một từ điển để khai báo tất cả các thuộc tính của lớp thẻ này. Phương thức này liên kết từ tên thuộc tính đến đối tượng thuộc tính (xem mô-đun attr). |
doc
|
chuỗi; hoặc None ; giá trị mặc định là None Nội dung mô tả về lớp thẻ có thể được trích xuất bằng các công cụ tạo tài liệu. |
mức hiển thị
None
visibility(value)
Đặt chế độ hiển thị tải của mô-đun .bzl hiện đang được khởi chạy.
Chế độ hiển thị tải của một mô-đun chi phối việc các tệp BUILD và .bzl khác có thể tải mô-đun đó hay không. (Điều này khác với chế độ hiển thị mục tiêu của tệp nguồn .bzl cơ bản, chế độ này quản lý việc tệp có thể xuất hiện dưới dạng phần phụ thuộc của các mục tiêu khác hay không.) Chế độ hiển thị tải hoạt động ở cấp gói: Để tải một mô-đun, tệp đang tải phải nằm trong một gói đã được cấp quyền hiển thị cho mô-đun đó. Bạn luôn có thể tải một mô-đun trong gói của chính mô-đun đó, bất kể chế độ hiển thị của mô-đun.
visibility()
chỉ có thể được gọi một lần cho mỗi tệp .bzl và chỉ ở cấp cao nhất, chứ không phải bên trong hàm. Kiểu được ưu tiên là đặt lệnh gọi này ngay bên dưới câu lệnh load()
và mọi logic ngắn gọn cần thiết để xác định đối số.
Nếu bạn đặt cờ --check_bzl_visibility
thành false, các lỗi vi phạm về chế độ hiển thị khi tải sẽ đưa ra cảnh báo nhưng không khiến bản dựng gặp lỗi.
Thông số
Thông số | Mô tả |
---|---|
value
|
bắt buộc Danh sách các chuỗi thông số kỹ thuật của gói, hoặc một chuỗi thông số kỹ thuật của gói. Thông số kỹ thuật của gói sẽ tuân theo định dạng giống như thông số kỹ thuật của
Không được sử dụng cú pháp "@"; tất cả thông số kỹ thuật đều được diễn giải tương ứng với kho lưu trữ của mô-đun hiện tại. Nếu Lưu ý cờ |