Toàn cầu

Hội viên

• tất cả
• analysis_test_transition
• bất kỳ
• archive_override
• khía cạnh
• bazel_dep
• bind
• bool
• configuration_field
• phần phụ thuộc
• dict
• dir
• liệt kê
• exec_group
• thất bại
• float
• getattr
• git_override
• hasattr
• băm
• int
• len
• list
• local_path_override
• tối đa
• phút
• mô-đun
• module_extension
• multiple_version_override
• print
• nhà cung cấp
• dải_ô
• register_execution_platforms()
• register_execution_platforms()
• register_toolchains()
• register_toolchains()
• repository_quy tắc(triển khai, attrs, cục bộ, môi trường, định cấu hình, có thể điều khiển từ xa, tài liệu)
• repository_quy tắc(triển khai, attrs, cục bộ, môi trường, định cấu hình, có thể điều khiển từ xa, tài liệu)
• phản hồi
• đảo ngược
• quy tắc
• chọn
• single_version_override
• được sắp xếp
• str
• tag_class
• tuple
• loại
• use_extension
• use_repo
• khả năng hiển thị
• không gian làm việc
• zip

all

bool all(elements)

all(["hello", 3, True]) == True
all([-1, 0, 1]) == False

Thông số

analysis_test_transition

transition analysis_test_transition(settings)

Tạo một lượt 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. Việc chuyển đổi này chỉ có thể áp dụng trên các thuộc tính của quy tắc có analysis_test = True. Những 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, quá trình 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 quá trình chuyển đổi được tạo bằng tính năng chuyển đổi.

Chức năng này chủ yếu được thiết kế để hỗ trợ thư viện cốt lõi Analyze Test Framework (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ố

Bất kỳ

bool any(elements)

any([-1, 0, 1]) == True
any([False, 0, ""]) == False

Thông số

archive_override

None archive_override(module_name, urls, integrity='', strip_prefix='', patches=[], patch_cmds=[], patch_strip=0)

Thông số

chương trình thành phần

Aspect aspect(implementation, attr_aspects=[], attrs=None, required_providers=[], required_aspect_providers=[], provides=[], requires=[], fragments=[], host_fragments=[], toolchains=[], incompatible_use_toolchain_transition=False, doc='', *, apply_to_generating_rules=False, exec_compatible_with=[], exec_groups=None)

Thông số

bazel_dep

None bazel_dep(name, version='', repo_name='', dev_dependency=False)

Thông số

bind

None bind(name, actual=None)

Cảnh báo: bạn không nên sử dụng bind(). Hãy xem bài viết Cân nhắc việc xoá đường liên kết để nắm được nội dung thảo luận chi tiết về các vấn đề và các phương án thay thế.

Cung cấp bí danh cho mục tiêu trong gói //external.

Thông số

bool

bool bool(x=False)

Thông số

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 khi triển khai quy tắc:

  def _rule_impl(ctx):
    foo_info = ctx.attr._foo
    ...

Thông số

phần phụ thuộc

depset depset(direct=None, order="default", *, transitive=None)

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ụ thuộc phải cùng loại, như có được qua 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ỏ trùng lặp trong quá trình lặp lại, nên tất cả các phần tử của tập hợp phụ thuộc đều phải có thể băm. Tuy nhiên, sự bất biến này hiện chưa được kiểm tra một cách nhất quán trong mọi hàm khởi tạo. Dùng cờ --incompatible_always_check_depset_element để 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; hãy xem Vấn đề 10313.

Ngoài ra, các phần tử hiện phải không thể thay đổi được, dù quy định hạn chế này sẽ được nới lỏng trong tương lai.

Thứ tự của các phần phụ thuộc đã tạo phải tương thích với thứ tự của các 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 chúng.

Lưu ý về khả năng tương thích tiến/lùi. Hàm này hiện chấp nhận tham số items vị trí. Hàm này không được dùng nữa và sẽ bị xoá trong tương lai. Sau khi hàm này bị xoá, direct sẽ trở thành tham số vị trí duy nhất của hàm depset. Do đó, cả hai lệnh gọi sau đây đều tương đương nhau và phù hợp với tương lai:

depset(['a', 'b'], transitive = [...])
depset(direct = ['a', 'b'], transitive = [...])

Thông số

dict

dict dict(pairs=[], **kwargs)

Thông số

thư mục

list dir(x)

Thông số

liệt kê

list enumerate(list, start=0)

enumerate([24, 21, 84]) == [(0, 24), (1, 21), (2, 84)]

Thông số

exec_group

exec_group exec_group(toolchains=[], exec_compatible_with=[], copy_from_rule=False)

Thông số

không thành công

None fail(msg=None, attr=None, *args)

Thông số

float

float float(x=unbound)

• Nếu x đã là một số thực, float sẽ trả về giá trị không thay đổi.
• Nếu x là giá trị bool, thì float sẽ trả về 1,0 cho giá trị True và 0,0 cho giá trị False.
• Nếu x là một số nguyên, float sẽ trả về giá trị dấu phẩy động hữu hạn gần nhất cho x hoặc lỗi nếu độ lớn quá lớn.
• Nếu x là một chuỗi, thì giá trị này phải là một giá trị cố định dấu phẩy động hợp lệ hoặc bằng (không phân biệt chữ hoa chữ thường) với NaN, Inf hoặc Infinity, đứng sau dấu + hoặc - (không bắt buộc).

Thông số

getattr

unknown getattr(x, name, default=unbound)

getattr(ctx.attr, "myattr")
getattr(ctx.attr, "myattr", "mydefault")

Thông số

git_override

None git_override(module_name, remote, commit='', patches=[], patch_cmds=[], patch_strip=0)

Thông số

hasattr

bool hasattr(x, name)

hasattr(ctx.attr, "myattr")

Thông số

hàm băm

int hash(value)

s[0] * (31^(n-1)) + s[1] * (31^(n-2)) + ... + s[n-1]

Thông số

int

int int(x, base=unbound)

• Nếu x đã là một số nguyên, int sẽ trả về giá trị này không thay đổi.
• Nếu x là giá trị bool, thì int sẽ trả về 1 cho giá trị True và 0 cho giá trị False.
• Nếu x là một chuỗi, thì chuỗi đó phải có định dạng <sign><prefix><digits>. <sign> có giá trị "+", "-" hoặc trống (được hiểu là dương). <digits> là một chuỗi các chữ số từ 0 đến base – 1, trong đó các chữ cái từ a đến z (hoặc tương đương là A-Z) được dùng làm chữ số từ 10 đến 35. Trong trường hợp base là 2/8/16, <prefix> là không bắt buộc và có thể là 0b/0o/0x (hoặc tương đương 0B/0O/0X); nếu base là bất kỳ giá trị nào khác ngoài các cơ số này hoặc giá trị đặc biệt 0, thì tiền tố phải để trống. Trong trường hợp base là 0, chuỗi được hiểu là một giá trị cố định số nguyên, theo nghĩa là một trong các cơ số 2/8/10/16 được chọn tùy thuộc vào tiền tố nào được sử dụng. Nếu base là 0, không có tiền tố nào được dùng và có nhiều hơn một chữ số, thì chữ số đứng đầu không được là 0; điều này nhằm tránh nhầm lẫn giữa bát phân và số thập phân. Độ lớn của số mà chuỗi biểu thị phải nằm trong phạm vi cho phép đối với kiểu số nguyên.
• Nếu x là số thực, int sẽ trả về giá trị số nguyên của số thực, làm tròn về 0. Đó là một lỗi nếu x là không hữu hạn (NaN hoặc vô hạn).

Ví dụ:

int("123") == 123
int("-123") == -123
int("+123") == 123
int("FF", 16) == 255
int("0xFF", 16) == 255
int("10", 0) == 10
int("-0x10", 0) == -16
int("-0x10", 0) == -16
int("123.456") == 123

Thông số

len

int len(x)

Thông số

danh sách

list list(x=[])

list([1, 2]) == [1, 2]
list((2, 3, 2)) == [2, 3, 2]
list({5: "a", 2: "b", 4: "c"}) == [5, 2, 4]

Thông số

local_path_override

None local_path_override(module_name, path)

Thông số

tối đa

unknown max(*args)

max(2, 5, 4) == 5
max([5, 6, 3]) == 6

Thông số

phút

unknown min(*args)

min(2, 5, 4) == 2
min([5, 6, 3]) == 3

Thông số

mô-đun

None module(name='', version='', compatibility_level=0, repo_name='', bazel_compatibility=[])

Mã này sẽ được gọi tối đa một lần. Bạn chỉ có thể bỏ qua mô-đun này nếu mô-đun này là mô-đun gốc (như trong trường hợp mô-đun này không phụ thuộc vào một mô-đun khác).

Thông số

module_extension

unknown module_extension(implementation, *, tag_classes={}, doc='')

Thông số

multiple_version_override

None multiple_version_override(module_name, versions, registry='')

Thông số

in

None print(sep=" ", *args)

Bạn không nên sử dụng print trong mã phát hành chính thức do mã này tạo ra nội dung rác cho người dùng. Đối với những trường hợp không dùng nữa, hãy ưu tiên lỗi cứng bằng cách sử dụng fail() bất cứ khi nào có thể.

Thông số

nhà cung cấp

unknown provider(doc='', *, 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 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ề giá trị có thể gọi Provider nếu bạn không chỉ định init.

Nếu bạn chỉ định init, hàm này sẽ trả về một bộ dữ liệu gồm 2 phần tử: giá trị có thể gọi Provider và giá trị có thể gọi hàm khởi tạo thô. Xem Quy tắc (Khởi chạy tuỳ chỉnh của nhà cung cấp tuỳ chỉnh) và thảo luận về tham số init bên dưới để biết thông tin chi tiết.

Thông số

MyInfo = provider()
m = MyInfo(foo = 1)

MyInfo, _new_myinfo = provider(init = ...)

phạm vi

sequence range(start_or_stop, stop_or_none=None, step=1)

range(4) == [0, 1, 2, 3]
range(3, 9, 2) == [3, 5, 7]
range(3, 0, -1) == [3, 2, 1]

Thông số

register_execution_platforms()

None register_execution_platforms(*platform_labels)

Thông số

register_execution_platforms()

None register_execution_platforms(*platform_labels)

Thông số

register_toolchains()

None register_toolchains(*toolchain_labels)

Thông số

register_toolchains()

None register_toolchains(*toolchain_labels)

Thông số

kho lưu trữ quy tắc(implementation, attrs, cục bộ, môi trường, định cấu hình, điều khiển từ xa, tài liệu)

callable repository_rule(implementation, *, attrs=None, local=False, environ=[], configure=False, remotable=False, doc='')

Thông số

kho lưu trữ quy tắc(implementation, attrs, cục bộ, môi trường, định cấu hình, điều khiển từ xa, tài liệu)

callable repository_rule(implementation, *, attrs=None, local=False, environ=[], configure=False, remotable=False, doc='')

Thông số

lặp lại

string repr(x)

repr("ab") == '"ab"'

Thông số

đã đảo ngược

list reversed(sequence)

reversed([3, 5, 4]) == [4, 5, 3]

Thông số

quy tắc

callable rule(implementation, test=False, attrs=None, outputs=None, executable=False, output_to_genfiles=False, fragments=[], host_fragments=[], _skylark_testable=False, toolchains=[], incompatible_use_toolchain_transition=False, doc='', *, provides=[], exec_compatible_with=[], analysis_test=False, build_setting=None, cfg=None, exec_groups=None, compile_one_filetype=None, name=None)

Bạn phải chỉ định 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.

Cá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 mục tiêu của các quy tắc đó).

Thông số

chọn

unknown select(x, no_match_error='')

Thông số

single_version_override

None single_version_override(module_name, version='', registry='', patches=[], patch_cmds=[], patch_strip=0)

Thông số

đã sắp xếp

list sorted(iterable, *, key=None, reverse=False)

sorted([3, 5, 4]) == [3, 4, 5]

Thông số

str

string str(x)

str("ab") == "ab"
str(8) == "8"

Thông số

tag_class

tag_class tag_class(attrs={}, *, doc='')

Thông số

tuple

tuple tuple(x=())

tuple([1, 2]) == (1, 2)
tuple((2, 3, 2)) == (2, 3, 2)
tuple({5: "a", 2: "b", 4: "c"}) == (5, 2, 4)

Thông số

loại

string type(x)

type(2) == "int"
type([1]) == "list"
type(struct(a = 2)) == "struct"

if type(x) == type([]):  # if x is a list

Thông số

use_extension

module_extension_proxy use_extension(extension_bzl_file, extension_name, *, dev_dependency=False)

Thông số

use_repo

None use_repo(extension_proxy, *args, **kwargs)

Thông số

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 kiểm soát liệu các tệp BUILD và .bzl khác có thể tải mô-đun đó hay không. (Chế độ hiển thị 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 chi phối 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 thực hiện tải phải nằm trong gói đã được cấp chế độ hiển thị cho mô-đun. Mô-đun luôn có thể được tải trong gói riêng, 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, không phải bên trong một hàm. Kiểu ưu tiên là đặt lệnh gọi này ngay bên dưới các 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, thì các lỗi vi phạm chế độ hiển thị tải sẽ phát ra cảnh báo nhưng không làm lỗi trong quá trình tạo.

Thông số

không gian làm việc

None workspace(name)

Hàm này chỉ dùng được trong tệp WORKSPACE và phải được khai báo trước tất cả hàm khác trong tệp WORKSPACE. Mỗi tệp WORKSPACE phải có một hàm workspace.

Đặt tên cho không gian làm việc này. Tên không gian làm việc phải là nội dung mô tả kiểu gói Java của dự án, sử dụng dấu gạch dưới làm dấu phân tách. Ví dụ: github.com/bazelbuild/bazel phải sử dụng com_github_bazelbuild_bazel.

Tên này được dùng cho thư mục lưu trữ các tệp runfile của kho lưu trữ. Ví dụ: nếu có một tệp runfile foo/bar trong kho lưu trữ cục bộ và tệp WORKSPACE chứa workspace(name = 'baz'), thì tệp runfile đó sẽ nằm trong mytarget.runfiles/baz/foo/bar. Nếu bạn không chỉ định tên không gian làm việc, thì tệp runfile sẽ được liên kết tượng trưng với bar.runfiles/foo/bar.

Tên quy tắc trong Kho lưu trữ từ xa phải là tên không gian làm việc hợp lệ. Ví dụ: bạn có thể có maven_jar(name = 'foo'), nhưng không phải maven_jar(name = 'foo%bar'), vì Bazel sẽ cố gắng viết một tệp WORKSPACE cho maven_jar chứa workspace(name = 'foo%bar').

Thông số

zip

list zip(*args)

zip()  # == []
zip([1, 2])  # == [(1,), (2,)]
zip([1, 2], [3, 4])  # == [(1, 3), (2, 4)]
zip([1, 2], [3, 4, 5])  # == [(1, 3), (2, 4)]

Thông số