ทั่วโลก

สำหรับสมาชิก

• ทั้งหมด
• analysis_test_transition
• ทั้งหมด
• archive_override
• ภาพรวม
• bazel_dep
• bind
• bool
• configuration_field
• depset
• dict
• ไดเรกทอรี
• แจกแจง
• exec_group
• ล้มเหลว
• float
• getattr
• git_override
• hasattr
• แฮช
• int
• len
• list
• local_path_override
• สูงสุด
• นาที
• โมดูล
• module_extension
• multiple_version_override
• พิมพ์
• ผู้ให้บริการ
• ช่วง
• register_execution_platforms()
• register_execution_platforms(dev_dependency)
• register_toolchains()
• register_toolchains(dev_dependency)
• repository_rule
• แก้ไข
• กลับด้าน
• กฎ
• เลือก
• single_version_override
• จัดเรียง
• str
• tag_class
• tuple
• ประเภท
• use_extension
• use_repo
• ระดับการเข้าถึง
• พื้นที่ทำงาน
• zip

ทั้งหมด

bool all(elements)

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

พารามิเตอร์

analysis_test_transition

transition analysis_test_transition(settings)

สร้างการเปลี่ยนการกำหนดค่าเพื่อนำไปใช้ในทรัพยากร Dependency ของกฎการทดสอบการวิเคราะห์ การเปลี่ยนนี้ใช้ได้กับแอตทริบิวต์ของกฎที่มี analysis_test = True เท่านั้น กฎดังกล่าวมีข้อจำกัดในความสามารถ (เช่น ขนาดแผนผังทรัพยากร Dependency มีจำกัด) ดังนั้นการเปลี่ยนที่สร้างขึ้นโดยใช้ฟังก์ชันนี้จึงมีข้อจำกัดในขอบเขตที่เป็นไปได้เมื่อเทียบกับการเปลี่ยนที่สร้างขึ้นโดยใช้การเปลี่ยน

ฟังก์ชันนี้ออกแบบมาเพื่อช่วยอำนวยความสะดวกให้กับไลบรารีหลักของกรอบการทดสอบการวิเคราะห์เป็นหลัก ดูแนวทางปฏิบัติแนะนำในเอกสาร (หรือการใช้งาน)

พารามิเตอร์

อะไรก็ได้

bool any(elements)

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

พารามิเตอร์

archive_override

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

พารามิเตอร์

เฉพาะด้าน

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)

พารามิเตอร์

bazel_dep

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

พารามิเตอร์

bind

None bind(name, actual=None)

คำเตือน: ไม่แนะนำให้ใช้ bind() โปรดดูพิจารณานำการเชื่อมโยงออกสำหรับการอภิปรายประเด็นยาวเกี่ยวกับปัญหาและทางเลือกต่างๆ

กำหนดชื่อแทนให้กับเป้าหมายในแพ็กเกจ //external

พารามิเตอร์

bool

bool bool(x=False)

พารามิเตอร์

configuration_field

LateBoundDefault configuration_field(fragment, name)

ตัวอย่างการใช้:

การกำหนดแอตทริบิวต์ของกฎ:

'_foo': attr.label(default=configuration_field(fragment='java', name='toolchain'))

การเข้าถึงในการใช้งานกฎ:

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

พารามิเตอร์

Depset

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

องค์ประกอบทั้งหมด (โดยตรงและโดยอ้อม) ของ Depset ต้องเป็นประเภทเดียวกันที่ได้มาจากนิพจน์ type(x)

เนื่องจากชุดแบบอิงตามแฮชใช้เพื่อกำจัดข้อมูลที่ซ้ำกันระหว่างการทำซ้ำ องค์ประกอบทั้งหมดของ Depset จึงควรแฮชได้ อย่างไรก็ตาม ในปัจจุบันค่าตัวแปรนี้ยังยังไม่ได้รับการตรวจสอบอย่างสม่ำเสมอในเครื่องมือสร้างทั้งหมด ใช้แฟล็ก --incompatible_always_check_depset_elements เพื่อเปิดใช้การตรวจสอบที่สอดคล้องกัน การตั้งค่านี้จะเป็นลักษณะการทำงานเริ่มต้นในรุ่นต่อๆ ไป ดูปัญหา 10313

นอกจากนี้ องค์ประกอบต่างๆ จะต้องเปลี่ยนแปลงไม่ได้ในปัจจุบัน แม้ว่าข้อจำกัดนี้จะผ่อนปรนขึ้นในอนาคต

ลำดับของ Depset ที่สร้างควรใช้ร่วมกันได้กับลำดับของ Depset ที่ transitive คําสั่งซื้อ "default" ใช้ได้กับคําสั่งซื้ออื่นๆ ส่วนคําสั่งซื้ออื่นๆ ทั้งหมดจะใช้งานร่วมกันได้กับตัวเองเท่านั้น

หมายเหตุเกี่ยวกับความเข้ากันได้แบบย้อนหลัง/ไปข้างหน้า ขณะนี้ฟังก์ชันนี้ยอมรับพารามิเตอร์ items ตามตำแหน่ง พารามิเตอร์นี้เลิกใช้งานแล้วและจะถูกนำออกในอนาคต และหลังจากที่นําออก direct แล้วจะกลายเป็นพารามิเตอร์ตําแหน่งเดียวของฟังก์ชัน depset ดังนั้น การโทรทั้ง 2 แบบต่อไปนี้จึงมีความสำคัญและรองรับการใช้งานในอนาคต

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

พารามิเตอร์

dict

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

พารามิเตอร์

ไดเรกทอรี

list dir(x)

พารามิเตอร์

แจกแจง

list enumerate(list, start=0)

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

พารามิเตอร์

exec_group

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

พารามิเตอร์

ล้มเหลว

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

พารามิเตอร์

float

float float(x=unbound)

• หาก x เป็นแบบลอยอยู่แล้ว float จะแสดงผลค่าดังกล่าวไม่เปลี่ยนแปลง
• หาก x เป็นบูลีน float จะแสดงผล 1.0 สำหรับ True และ 0.0 สำหรับ False
• ถ้า x เป็น int float จะแสดงผลค่าจุดลอยตัวจำกัดที่ใกล้ที่สุดเป็น x หรือแสดงผลข้อผิดพลาดถ้าขนาดมีขนาดใหญ่เกินไป
• หาก x เป็นสตริง ต้องเป็นค่าลิเทอรัลจุดลอยตัวที่ถูกต้อง หรือเท่ากับ (ไม่คำนึงถึงตัวพิมพ์ใหญ่/เล็ก) สำหรับ NaN, Inf หรือ Infinity โดยจะนำหน้าด้วยเครื่องหมาย + หรือ - ก็ได้

พารามิเตอร์

Getattr

unknown getattr(x, name, default=unbound)

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

พารามิเตอร์

git_override

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

พารามิเตอร์

Hasattr

bool hasattr(x, name)

hasattr(ctx.attr, "myattr")

พารามิเตอร์

แฮช

int hash(value)

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

พารามิเตอร์

int

int int(x, base=unbound)

• หาก x เป็น int อยู่แล้ว int จะแสดงผลค่าที่ไม่เปลี่ยนแปลง
• หาก x เป็นบูลีน int จะแสดงผล 1 สำหรับ "จริง" และ 0 สำหรับ "เท็จ"
• หาก x เป็นสตริง ต้องอยู่ในรูปแบบ <sign><prefix><digits> <sign> เป็น "+", "-" หรือว่างเปล่า (ตีความเป็นบวก) <digits> คือตัวเลขที่เรียงตามลำดับตั้งแต่ 0 ถึง base - 1 โดยตัวอักษร a-z (หรือเทียบเท่า A-Z) ใช้เป็นตัวเลขตั้งแต่ 10-35 ในกรณีที่ base คือ 2/8/16 <prefix> เป็นตัวเลือกที่ไม่บังคับและอาจจะเป็น 0b/0o/0x (หรือเทียบเท่า 0B/0O/0X) ตามลำดับ หาก base เป็นค่าอื่นๆ นอกเหนือจากฐานเหล่านี้หรือค่าพิเศษ 0 คำนำหน้าจะต้องว่างเปล่า ในกรณีที่ base เป็น 0 ระบบจะตีความสตริงว่าเป็นลิเทอรัลที่เป็นจำนวนเต็ม ตามที่เลือกค่าฐาน 2/8/10/16 อย่างใดอย่างหนึ่งโดยขึ้นอยู่กับคำนำหน้าว่ามีการใช้ค่าใด หาก base เป็น 0 จะไม่มีการใช้คำนำหน้าและมีมากกว่า 1 หลัก ตัวเลขนำหน้าจะเป็น 0 ไม่ได้ เพื่อหลีกเลี่ยงความสับสนระหว่างเลขฐานแปดและทศนิยม ขนาดของจำนวนที่แสดงโดยสตริงต้องอยู่ภายในช่วงที่อนุญาตสำหรับชนิด int
• หาก x เป็นแบบลอย int จะแสดงผลค่าจำนวนเต็มของแบบลอยโดยปัดเศษไปที่ 0 หาก x เป็นค่าจำกัด (NaN หรือค่าอนันต์) ระบบจะแสดงข้อผิดพลาด

ตัวอย่าง:

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

พารามิเตอร์

len

int len(x)

พารามิเตอร์

ลิสต์

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]

พารามิเตอร์

local_path_override

None local_path_override(module_name, path)

พารามิเตอร์

สูงสุด

unknown max(*args)

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

พารามิเตอร์

นาที

unknown min(*args)

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

พารามิเตอร์

โมดูล

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

ควรเรียกใช้มากที่สุด 1 ครั้ง โดยละเว้นได้ต่อเมื่อโมดูลนี้เป็นโมดูลรูทเท่านั้น (เช่น ในกรณีที่โมดูลอื่นไม่ได้อ้างอิงกับโมดูลอื่น)

พารามิเตอร์

module_extension

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

พารามิเตอร์

multiple_version_override

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

พารามิเตอร์

พิมพ์

None print(sep=" ", *args)

ไม่แนะนำให้ใช้ print ในโค้ดเวอร์ชันที่ใช้งานจริงเนื่องจากสร้างสแปมสำหรับผู้ใช้ สำหรับการเลิกใช้งาน โปรดระบุข้อผิดพลาดถาวรโดยใช้ fail() เมื่อเป็นไปได้

พารามิเตอร์

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

ดูกฎ (ผู้ให้บริการ) เพื่อดูคำแนะนำที่ครอบคลุมเกี่ยวกับวิธีใช้ผู้ให้บริการ

แสดงผลค่าที่เรียกใช้ได้ของ Provider หากไม่ได้ระบุ init

หากระบุ init จะแสดงผล Tuple ขององค์ประกอบ 2 รายการคือ ค่าที่สามารถเรียกได้ของ Provider และค่าที่เรียกใช้ได้ของเครื่องมือสร้าง ดูรายละเอียดได้ที่กฎ (การเริ่มต้นที่กำหนดเองของผู้ให้บริการที่กำหนดเอง) และการสนทนาเกี่ยวกับพารามิเตอร์ init ด้านล่าง

พารามิเตอร์

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

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

ช่วง

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]

พารามิเตอร์

register_execution_platforms()

None register_execution_platforms(*platform_labels)

พารามิเตอร์

register_execution_platforms(dev_dependency)

None register_execution_platforms(dev_dependency=False, *platform_labels)

พารามิเตอร์

register_toolchains()

None register_toolchains(*toolchain_labels)

พารามิเตอร์

register_toolchains(dev_dependency)

None register_toolchains(dev_dependency=False, *toolchain_labels)

พารามิเตอร์

repository_rule

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

พารามิเตอร์

แก้ไข

string repr(x)

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

พารามิเตอร์

กลับด้าน

list reversed(sequence)

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

พารามิเตอร์

กฎ

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)

ต้องกำหนดกฎให้กับตัวแปรร่วมในไฟล์ .bzl โดยชื่อของตัวแปรร่วมจะเป็นชื่อของกฎ

กฎการทดสอบต้องมีชื่อที่ลงท้ายด้วย _test ส่วนกฎอื่นๆ ทั้งหมดต้องไม่มีคำต่อท้ายนี้ (ข้อจำกัดนี้มีผลกับกฎเท่านั้น ไม่ใช้กับเป้าหมาย)

พารามิเตอร์

เลือก

unknown select(x, no_match_error='')

พารามิเตอร์

single_version_override

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

พารามิเตอร์

เรียงลำดับแล้ว

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

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

พารามิเตอร์

str

string str(x)

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

พารามิเตอร์

tag_class

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

พารามิเตอร์

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)

พารามิเตอร์

ประเภท

string type(x)

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

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

พารามิเตอร์

use_extension

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

พารามิเตอร์

use_repo

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

พารามิเตอร์

การเปิดเผย

None visibility(value)

ตั้งค่าการเปิดเผยการโหลดของโมดูล .bzl ที่กำลังเริ่มต้นอยู่ในขณะนี้

การเปิดเผยการโหลดของโมดูลจะควบคุมว่าไฟล์ BUILD และ .bzl อื่นๆ จะโหลดหรือไม่ (ซึ่งจะแตกต่างจากระดับการเข้าถึงเป้าหมายของไฟล์ต้นฉบับ .bzl ซึ่งกำหนดว่าไฟล์อาจปรากฏเป็นทรัพยากร Dependency ของเป้าหมายอื่นๆ หรือไม่) การเปิดเผยการโหลดทำงานที่ระดับแพ็กเกจ: หากต้องการโหลดโมดูล ไฟล์ที่โหลดต้องอยู่ในแพ็กเกจที่ให้สิทธิ์การเปิดเผยโมดูลแล้ว โมดูลจะโหลดภายในแพ็กเกจของตนเองได้เสมอ โดยไม่คำนึงถึงระดับการเข้าถึง

เรียก visibility() ได้เพียงครั้งเดียวต่อไฟล์ .bzl และเรียกที่ระดับบนสุดเท่านั้น ไม่ใช่ภายในฟังก์ชัน รูปแบบที่แนะนำคือใส่การเรียกใช้นี้ใต้คำสั่ง load() และตรรกะสั้นๆ ที่จำเป็นในการระบุอาร์กิวเมนต์

หากตั้งค่า Flag --check_bzl_visibility เป็น "เท็จ" การละเมิดการเปิดเผยการโหลดจะส่งคำเตือน แต่การสร้างก็จะไม่ล้มเหลว

พารามิเตอร์

พื้นที่ทำงาน

None workspace(name)

ฟังก์ชันนี้ใช้ได้ในไฟล์ WORKSPACE เท่านั้น และต้องประกาศก่อนฟังก์ชันอื่นๆ ทั้งหมดในไฟล์ WORKSPACE ไฟล์ WORKSPACE แต่ละไฟล์ควรมีฟังก์ชัน workspace

ตั้งชื่อพื้นที่ทำงานนี้ ชื่อพื้นที่ทำงานควรเป็นคำอธิบายโปรเจ็กต์ในสไตล์ Java โดยใช้ขีดล่างเป็นตัวคั่น เช่น github.com/bazelbuild/bazel ควรใช้ com_github_bazelbuild_bazel

ชื่อนี้จะใช้สำหรับไดเรกทอรีที่จัดเก็บ Runfile ของที่เก็บ ตัวอย่างเช่น หากมี Runfile foo/bar ในที่เก็บภายใน และไฟล์ WORKSPACE มี workspace(name = 'baz') ไฟล์ Runfile จะอยู่ในส่วน mytarget.runfiles/baz/foo/bar หากไม่ได้ระบุชื่อพื้นที่ทำงานไว้ ไฟล์ Runfile จะลิงก์กับ bar.runfiles/foo/bar

ชื่อกฎของที่เก็บระยะไกลต้องเป็นชื่อพื้นที่ทำงานที่ถูกต้อง เช่น คุณอาจมี maven_jar(name = 'foo') แต่ไม่ใช่ maven_jar(name = 'foo%bar') เนื่องจาก Bazel จะพยายามเขียนไฟล์ WORKSPACE สำหรับ maven_jar ที่มี workspace(name = 'foo%bar')

พารามิเตอร์

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

พารามิเตอร์