Toàn cầu

Hội viên

• tất cả
• analysis_test_transition
• bất kỳ
• archive_override
• tỷ lệ
• bazel_dep
• liên kết
• bool
• configuration_field
• depset
• dict
• dir
• enumerate
• exec_group
• không đạt
• float
• getattr
• git_override
• hasattr
• hàm băm
• int
• len
• list
• local_path_override
• max
• phút
• mô-đun
• module_extension
• multiple_version_override
• print
• provider
• dải ô
• register_execution_platforms()
• register_execution_platforms(dev_dependency)
• register_toolchains()
• register_toolchains(dev_dependency)
• repository_rule
• repr
• đã huỷ
• quy tắc
• chọn
• single_version_override
• đã sắp xếp
• str
• tag_class
• tuple
• type
• use_extension
• use_repo
• visibility
• workspace
• zip

tất cả

bool all(elements)

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

Tham số

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. 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) của lớp này để biết các phương pháp hay nhất.

Tham số

bất kỳ

bool any(elements)

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

Tham số

archive_override

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

Tham 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)

Tham số

bazel_dep

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

Tham số

liên kết

None bind(name, actual=None)

Cảnh báo: Bạn không nên sử dụng bind(). Hãy xem phần Cân nhắc xoá liên kết để thảo luận về các vấn đề và giải pháp thay thế.

Gán bí danh cho một mục tiêu trong gói //external.

Tham số

bool

bool bool(x=False)

Tham 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 trong quá trình triển khai quy tắc:

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

Tham số

depset

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

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 phần tử trùng lặp trong quá trình lặp lại, nên tất cả các phần tử của một tập hợp phần phụ thuộc phải có thể băm. 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 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. Thứ tự "default" tương thích với mọi thứ tự khác, tất cả các thứ tự khác chỉ tương thích với chính chúng.

Lưu ý về khả năng tương thích ngược/tương thích. Hàm này hiện chấp nhận tham số items theo vị trí. Phương thức này không còn được dùng nữa và sẽ bị xoá trong tương lai. Sau khi 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 đều tương đương và phù hợp với tương lai:

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

Tham số

dict

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

Tham số

dir

list dir(x)

Tham số

liệt kê

list enumerate(list, start=0)

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

Tham số

exec_group

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

Tham số

không thành công

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

Tham số

số thực dấu phẩy động

float float(x=unbound)

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

Tham số

getattr

unknown getattr(x, name, default=unbound)

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

Tham số

git_override

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

Tham số

hasattr

bool hasattr(x, name)

hasattr(ctx.attr, "myattr")

Tham số

hàm băm

int hash(value)

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

Tham số

int

int int(x, base=unbound)

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

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

Tham số

len

int len(x)

Tham 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]

Tham số

local_path_override

None local_path_override(module_name, path)

Tham số

tối đa

unknown max(*args)

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

Tham số

phút

unknown min(*args)

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

Tham số

mô-đun

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

Bạn chỉ nên gọi phương thức này một lần. Bạn chỉ có thể bỏ qua phần này nếu mô-đun này là mô-đun gốc (tức là nếu mô-đun này không phụ thuộc vào mô-đun khác).

Tham số

module_extension

unknown module_extension(implementation, *, tag_classes={}, doc='', environ=[], os_dependent=False, arch_dependent=False)

Tham số

multiple_version_override

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

Tham số

in

None print(sep=" ", *args)

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

Tham số

provider

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

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ề 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 phần Quy tắc (Khởi chạy tuỳ chỉnh của nhà cung cấp tuỳ chỉnh) và nội dung thảo luận về tham số init ở bên dưới để biết thông tin chi tiết.

Tham 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]

Tham số

register_execution_platforms()

None register_execution_platforms(*platform_labels)

Tham số

register_execution_platforms(dev_dependency)

None register_execution_platforms(dev_dependency=False, *platform_labels)

Tham số

register_toolchains()

None register_toolchains(*toolchain_labels)

Tham số

register_toolchains(dev_dependency)

None register_toolchains(dev_dependency=False, *toolchain_labels)

Tham số

repository_rule

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

Tham số

repr

string repr(x)

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

Tham số

đã đảo ngược

list reversed(sequence)

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

Tham 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 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, chứ không áp dụng cho mục tiêu của các quy tắc đó.)

Tham số

chọn

unknown select(x, no_match_error='')

Tham số

single_version_override

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

Tham số

đã sắp xếp

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

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

Tham số

str

string str(x)

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

Tham số

tag_class

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

Tham số

bộ dữ liệu

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)

Tham 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

Tham số

use_extension

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

Tham số

use_repo

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

Tham số

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

Bạn chỉ có thể gọi visibility() 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 một hàm. Bạn nên đặ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 hỏng bản dựng.

Tham số

không gian làm việc

None workspace(name)

Bạn chỉ có thể sử dụng hàm này trong tệp WORKSPACE và phải khai báo hàm này trước tất cả cá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ả dự án theo kiểu gói Java, sử dụng dấu gạch dưới làm dấu phân cá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 chạy của kho lưu trữ. Ví dụ: nếu có một tệp chạy foo/bar trong kho lưu trữ cục bộ và tệp WORKSPACE chứa workspace(name = 'baz'), thì tệp chạy sẽ có 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 chạy sẽ được liên kết tượng trưng đến bar.runfiles/foo/bar.

Tên quy tắc 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 có maven_jar(name = 'foo%bar'), vì Bazel sẽ cố gắng ghi tệp WORKSPACE cho maven_jar chứa workspace(name = 'foo%bar').

Tham 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)]

Tham số