Các phương thức toàn cục có trong tất cả tệp .bzl.
Hội viên
- analysis_test_transition
- góc nhìn
- configuration_field
- depset
- exec_group
- exec_transition
- 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 cho các phần phụ thuộc của quy tắc kiểm thử phân tích. Hiệu ứng chuyển đổi này chỉ có thể áp dụng cho 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ề khả 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 trong 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
|
dict;
bắt buộc Từ điển chứa thông tin về các chế độ cài đặt cấu hình cần được đặt trong quá trình chuyển đổi cấu hình này. Khoá là nhãn chế độ 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 thuộc tí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 để vượt qua. |
chương trình thành phần
Aspect aspect(implementation, attr_aspects=[], toolchains_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=[])
Thông số
Thông số | Mô tả |
---|---|
implementation
|
function;
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 mà mục tiêu được tạo từ đó). Các thuộc tính của mục tiêu có sẵn 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 lần áp dụng 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 "*" để truyền tải cùng với tất cả các phần phụ thuộc của một mục tiêu.
|
toolchains_aspects
|
trình tự; giá trị mặc định là [] Danh sách các loại chuỗi công cụ. Phương diện này sẽ truyền đến các chuỗi công cụ mục tiêu khớp với các loại chuỗi công cụ này. |
attrs
|
dict;
giá trị 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 phương diện. Thuộc tính này liên kết từ tên thuộc tính đến một đố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 Các thuộc tính đã khai báo sẽ chuyển đổi |
required_providers
|
sequence;
giá trị mặc định là [] Thuộc tính này cho phép khía cạ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 nhà cung cấp cần thiết. Giá trị này phải là một danh sách chứa các nhà cung cấp riêng lẻ hoặc danh sách các 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ệ còn [FooInfo, BarInfo, [BazInfo, QuxInfo]] thì không.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à Để một số quy tắc (ví dụ: |
required_aspect_providers
|
trình tự; giá trị 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ệ còn [FooInfo, BarInfo, [BazInfo, QuxInfo]] thì không.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 khía cạnh khác (ví dụ: |
provides
|
trình tự; giá trị 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 bổ sung không có trong danh sách tại đây. Mỗi phần tử của danh sách là một đối tượng |
requires
|
trình tự của Phương diện; giá trị mặc định là [] Danh sách các phương diện cần được truyền trước phương diện 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à thành phần này cần có 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 này 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à khía cạnh 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 sẽ tìm thấy các chuỗi công cụ bằng cách kiểm tra nền tảng hiện tại, đồng thời được cung cấp cho hoạt động triển khai khung hình thông qua ctx.toolchain .
|
incompatible_use_toolchain_transition
|
bool;
giá trị mặc định là False Không dùng nữa, chính sách này không còn được sử dụng nữa và phải được xoá. |
doc
|
string; hoặc None ;
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
|
bool;
giá trị mặc định là False Nếu giá trị là true, khung hình sẽ áp dụng cho quy tắc tạo của tệp đầu ra khi được áp dụng cho tệp đầu ra. Ví dụ: giả sử một khung hình truyền tải bắc cầu qua thuộc tính "deps" và khung hình đó được áp dụng cho mục tiêu "alpha". Giả sử `alpha` có `deps = [':beta_output']`, trong đó `beta_output` là kết quả đầu ra được khai báo của `beta` mục tiêu. Giả sử "beta" có một "charlie" mục tiêu là một trong các "dep" của nó. Nếu "apply_to_generative_rules=True" cho một khung hình, thì khung hình đó sẽ truyền qua "alpha", "beta" và "charlie". Nếu là False, thì khung hình sẽ chỉ truyền sang "alpha". Giá trị mặc định là false. |
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 Dict của tên nhóm thực thi (chuỗi) thành exec_group s. Nếu được đặt, cho phép các khía cạnh chạy các hành động trên nhiều nền tảng thực thi trong một thực thể. 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 các quy tắc phụ mà khía cạnh này sử dụng. |
configuration_field
LateBoundDefault configuration_field(fragment, name)
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
|
string;
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
|
string;
bắt buộc Tên của giá trị cần lấy từ mảnh cấu hình. |
phần tách rời
depset depset(direct=None, order="default", *, transitive=None)
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 phần Tổng quan về bộ phần phụ thuộc để biết thêm thông tin.
Tất cả phần tử (trực tiếp và gián tiếp) của một depset phải thuộc cùng một loại, như được biểu thức type(x)
trả về.
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, nên tất cả phần tử của một tập hợp đều 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_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 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 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
|
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 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=[])
Thông số
Thông số | Mô tả |
---|---|
toolchains
|
sequence; giá trị mặc định là [] Tập hợp các 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. |
exec_transition
transition exec_transition(implementation, inputs, outputs)
transition()
dùng để xác định quá trình chuyển đổi thực thi. 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. Chỉ có thể sử dụng từ các thành phần tích hợp sẵn của Bazel.
Thông số
Thông số | Mô tả |
---|---|
implementation
|
callable;
bắt buộc |
inputs
|
trình tự của chuỗi;
bắt buộc |
outputs
|
trình tự của chuỗi;
bắt buộc |
module_extension
unknown module_extension(implementation, *, tag_classes={}, doc=None, environ=[], os_dependent=False, arch_dependent=False)
use_extension
.
Thông số
Thông số | Mô tả |
---|---|
implementation
|
callable;
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ữ có sẵn.
|
tag_classes
|
dict;
giá trị 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
|
string; 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. Nếu một biến môi trường trong danh sách đó thay đổi, thì tiện ích sẽ được đánh giá lại. |
os_dependent
|
bool;
mặc định là False Cho biết liệu tiện ích này có phụ thuộc vào hệ điều hành hay không |
arch_dependent
|
bool;
mặc định là False Cho biết liệu 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)
MyInfo = provider() ... def _my_library_impl(ctx): ... my_info = MyInfo(x = 2, y = 3) # my_info.x == 2 # my_info.y == 3 ...
Xem phần Quy tắc (Nhà cung cấp) để biết hướng dẫn đầy đủ về cách sử dụng nhà cung cấp.
Trả về một giá trị có thể gọi Provider
nếu không chỉ định init
.
Nếu init
được chỉ định, hãy 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 ;
giá trị mặc định là None Nội dung mô tả về 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 dict; hoặc None ;
giá trị mặc định là None Nếu được chỉ định, hãy giới hạn nhóm 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 nhà cung cấp trong quá trình tạo bản sao. Nếu chỉ định init , provider() sẽ trả về một bộ dữ liệu gồm 2 phần tử: biểu tượng 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; xem Quy tắc (Khởi tạo nhà cung cấp tuỳ chỉnh) để biết các trường hợp sử dụng và thảo luận 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 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) m trở thành một thực thể MyInfo với m.foo == 1 .Tuy nhiên, trong trường hợp
NB: các bước ở trên ngụ ý rằng sẽ xảy ra lỗi nếu Bằng cách này, lệnh gọi lại Khi MyInfo, _new_myinfo = provider(init = ...) |
repository_rule
callable repository_rule(implementation, *, attrs=None, local=False, environ=[], configure=False, remotable=False, doc=None)
module_extension()
hoặc được use_repo_rule()
sử dụng.
Thông số
Thông số | Mô tả |
---|---|
implementation
|
có thể gọi;
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 ; giá trị mặc định là None Một từ điển để khai báo tất cả các thuộc tính của quy tắc kho lưu trữ. 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 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 trên một nhãn vào tệp (quy tắc kho lưu trữ không được phụ thuộc vào cấu phần phần mềm được tạo). Thuộc tính name được ngầm thêm vào và không được chỉ định.
Các thuộc tính đã khai báo sẽ chuyển đổi |
local
|
bool;
giá trị 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à sẽ được đánh giá lại vào 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. Thay vào đó, hãy chuyển sang repository_ctx.getenv .Cung cấp một 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
|
bool;
giá trị mặc định là False Cho biết rằng kho lưu trữ kiểm tra hệ thống cho mục đích định cấu hình |
remotable
|
bool;
giá trị mặc định là False Thử nghiệm. Thông 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=[], dependency_resolution_rule=False, exec_compatible_with=[], analysis_test=False, build_setting=None, cfg=None, exec_groups=None, initializer=None, parent=None, extendable=None, subrules=[])
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 thử nghiệm 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, chứ không áp dụng cho mục tiêu của các quy tắc đó.)
Thông số
Thông số | Mô tả |
---|---|
implementation
|
function;
bắt buộc 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. Hàm này phải tạo các hành động để tạo tất cả các đầu ra đã khai báo. |
test
|
bool;
giá trị mặc định là unbound Cho dù 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ử sẽ tự động được coi là executable; bạn 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 . Hãy xem trang Quy tắc để biết thêm thông tin.
|
attrs
|
dict;
giá trị mặc định là {} Từ điển để khai báo tất 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 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 ngầm thêm vào và không ghi đè được. 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ớ, có giới hạn về số lượng thuộc tính có thể khai báo.
Các thuộc tính đã khai báo sẽ chuyển đổi |
outputs
|
dict; hoặc None ; hoặc hàm;
mặc định là None Không dùng nữa. Tham số này không được dùng nữa và sẽ sớm bị xoá. Vui lòng đừng phụ thuộc vào tính năng này. Tính năng này đã bị tắt với --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 yêu cầu sắp xoá. Thông số này không còn được dùng nữa. Hãy 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ư thuộc tính Giá trị của đối số này là một từ điển hoặc một hàm callback tạo ra 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 coi là có thể thực thi hay không, tức là liệu quy tắc này có thể là đối tượng của lệnh blaze run hay không. Giá trị mặc định là False . Xem trang Quy tắc để biết thêm thông tin.
|
output_to_genfiles
|
bool;
giá trị mặc định là False Nếu giá trị là true, các tệp sẽ được tạo trong thư mục genfiles thay vì thư mục bin. Trừ phi bạn cần cờ này để 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++), đừng đặt cờ này. |
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ụ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à quy tắc yêu cầu trong cấu hình máy chủ. |
_skylark_testable
|
bool;
giá trị mặc định là False (Thử nghiệm) Nếu đúng, quy tắc này sẽ hiển thị các hành động để kiểm tra theo các quy tắc phụ thuộc vào quy tắc đó thông qua 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().Chỉ nên sử dụng trình cung cấp để 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
|
sequence;
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 Chuỗi, Nhãn hoặc StarlarkToolchainTypeApi theo bất kỳ cách kết hợp nào. Bạn sẽ tìm thấy các 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
|
bool;
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 bị 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
|
trình tự; giá trị 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 bổ sung không có trong danh sách tại đây. Mỗi phần tử của danh sách là một đối tượng |
dependency_resolution_rule
|
bool; giá trị mặc định là False Nếu được đặt, quy tắc có thể là một phần phụ thuộc thông qua các thuộc tính cũng được đánh dấu là có trong trình tạo nội dung. Mọi thuộc tính của quy tắc có cờ này được đặt phải được đánh dấu là có trong trình tạo nội dung. Việc này là để các quy tắc được đánh dấu không thể phụ thuộc vào các quy tắc không được đánh dấu. |
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 mục tiêu của loại quy tắc này. |
analysis_test
|
bool;
giá trị 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ử việc 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 đó đượ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 của quy tắc đó, nhưng phải chọn một số quy định hạn chế:
|
build_setting
|
BuildSetting; hoặc None ; giá trị 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 giá trị này, 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
|
giá trị mặc định là None Nếu được đặt, các điểm đến chuyển đổi cấu hình mà quy tắc sẽ áp dụng cho cấu hình riêng trước khi phân tích. |
exec_groups
|
dict; hoặc None ;
giá trị mặc định là None Nhập tên nhóm thực thi (chuỗi) vào exec_group . 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
|
giá trị 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. Thuộc tính 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ề Phương thức khởi tạo được đánh giá trước các giá trị mặc định được chỉ định trong định nghĩa thuộc tính. Do đó, nếu một tham số trong chữ ký của trình khởi chạy chứa giá trị mặc định, thì tham số đó sẽ ghi đè giá trị mặc định từ định nghĩa thuộc tính (ngoại 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 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 được đặ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 sắp tới cfg của phần tử mẹ được áp dụng sau cấu hình sắp tới của thisrule.
|
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 mở rộng. Theo mặc định, Bazel luôn cho phép tiện ích. |
subrules
|
Trình tự của Quy tắc phụ;
mặc định là [] Thử nghiệm: Danh sách các 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. Xem bách khoa toàn thư về bản dựng để 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 thực thể config_setting hoặc constraint_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
|
string; giá trị mặc định là '' Lỗi tuỳ chỉnh không bắt buộc để 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=[])
Thông số
Thông số | Mô tả |
---|---|
implementation
|
function;
bắt buộc Hàm Starlark triển khai quy tắc phụ này |
attrs
|
dict;
giá trị mặc định là {} Từ điển để khai báo tất cả cá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ư thuộc loại nhãn (tức là 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). Loại của các giá trị này sẽ là:
|
toolchains
|
sequence;
giá trị 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 String, Label 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 sử dụng. |
tag_class
tag_class tag_class(attrs={}, *, doc=None)
Thông số
Thông số | Mô tả |
---|---|
attrs
|
dict;
giá trị 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. 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 attr). Xin lưu ý rằng không giống như |
doc
|
string; 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 đang được khởi chạy.
Mức độ hiển thị tải của một mô-đun sẽ quyết định liệu 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. Tệp này quy định liệu tệp có 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ô-đun, tệp thực hiện tải phải nằm trong gói đã được cấp chế độ 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. Quy cách gói tuân theo định dạng tương tự như
"@" không cho phép 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 Xin lưu ý rằng cờ |