ไฟล์ BUILD

วันที่ รายงานปัญหา ตอนกลางคืน · 7.3 · 7.2 · 7.1 · 7.0 · 6.5

เมธอดที่ใช้ได้ในไฟล์ BUILD โปรดดูสารานุกรมของบิลด์สำหรับฟังก์ชันเพิ่มเติมและกฎในการสร้าง ซึ่งสามารถใช้ในไฟล์ BUILD ได้เช่นกัน

สมาชิก

Depset

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

สร้าง depset พารามิเตอร์ direct คือรายการองค์ประกอบโดยตรงของ Depset และพารามิเตอร์ transitive คือรายการของ Depset ที่มีองค์ประกอบที่กลายเป็นองค์ประกอบโดยอ้อมของ Depset ที่สร้างขึ้น พารามิเตอร์ order จะระบุลำดับการแสดงผลองค์ประกอบเมื่อแปลงค่า Depset เป็นรายการ ดูข้อมูลเพิ่มเติมในภาพรวมของ Depset

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

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

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

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

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
direct sequence; หรือ None; ค่าเริ่มต้นคือ None
รายการเอลิเมนต์ direct ของ Depset
order ค่าเริ่มต้นคือ "default"
กลยุทธ์การส่งผ่านสำหรับ Depset ใหม่ ดูค่าที่เป็นไปได้ที่นี่
transitive sequence ของ depset; หรือ None; ค่าเริ่มต้นคือ None
รายการ Depset ที่มีเอลิเมนต์ที่จะกลายเป็นองค์ประกอบโดยอ้อมของ Depset

existing_rule

unknown existing_rule(name)

แสดงผลออบเจ็กต์ที่เหมือน dict ที่เปลี่ยนแปลงไม่ได้ซึ่งอธิบายแอตทริบิวต์ของกฎที่สร้างขึ้นในแพ็กเกจของชุดข้อความนี้ หรือ None หากไม่มีอินสแตนซ์กฎของชื่อนั้นอยู่

ในที่นี้ วัตถุที่มีลักษณะเหมือนคำสั่งเผด็จการหมายถึงออบเจ็กต์ที่เปลี่ยนแปลงไม่ได้อย่างหนัก x ซึ่งรองรับการทำซ้ำที่คล้ายกับคำสั่ง เผด็จการ, len(x), name in x, x[name], x.get(name), x.items(), x.keys() และ x.values()

หากตั้งค่าแฟล็ก --noincompatible_existing_rules_immutable_view ไว้ ระบบจะส่งคำสั่งที่เปลี่ยนแปลงได้ใหม่ซึ่งมีเนื้อหาเดียวกันแทน

ผลลัพธ์จะมีรายการสําหรับแอตทริบิวต์แต่ละรายการ ยกเว้นแอตทริบิวต์ส่วนตัว (ที่ชื่อไม่ได้ขึ้นต้นด้วยตัวอักษร) และแอตทริบิวต์เดิมบางประเภทที่ใช้ไม่ได้ นอกจากนี้ คำสั่งยังมีรายการสำหรับ name และ kind ของอินสแตนซ์กฎ (เช่น 'cc_binary')

ค่าของผลลัพธ์จะแสดงค่าแอตทริบิวต์ดังนี้

  • แอตทริบิวต์ของประเภท str, int และ bool จะแสดงเป็นลักษณะ
  • ป้ายกำกับถูกแปลงเป็นสตริงในรูปแบบ ':foo' สำหรับเป้าหมายในแพ็กเกจเดียวกัน หรือ '//pkg:name' สำหรับเป้าหมายในแพ็กเกจอื่น
  • โดยลิสต์จะแสดงเป็นแบบ Tuple และคำสั่งจะแปลงเป็นคำสั่งใหม่ที่เปลี่ยนแปลงได้ องค์ประกอบต่างๆ ของทั้งคู่จะถูกแปลงซ้ำให้เหมือนกัน
  • ค่า select จะส่งกลับเมื่อมีการเปลี่ยนแปลงเนื้อหาตามที่อธิบายไว้ข้างต้น
  • แอตทริบิวต์ที่ไม่ได้ระบุค่าไว้ระหว่างการสร้างกฎและทำการคำนวณค่าเริ่มต้นจะไม่รวมอยู่ในผลลัพธ์ (ค่าเริ่มต้นที่คำนวณแล้วไม่สามารถคำนวณได้จนถึงระยะการวิเคราะห์)

หากเป็นไปได้ ให้หลีกเลี่ยงการใช้ฟังก์ชันนี้ ซึ่งทำให้ไฟล์ BUILD เปราะบางและขึ้นอยู่กับลำดับ นอกจากนี้ โปรดระวังว่า Conversion นี้แตกต่างจาก Conversion อีก 2 รายการของค่าแอตทริบิวต์กฎจากแบบฟอร์มภายในเป็น Starlark โดย Conversion แรกใช้โดยค่าเริ่มต้นที่คํานวณ ส่วนอีกรายการใช้โดย ctx.attr.foo

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
name ต้องระบุ
ชื่อของเป้าหมาย

existing_rules

unknown existing_rules()

แสดงผลออบเจ็กต์ที่คล้าย dict ที่เปลี่ยนแปลงไม่ได้ซึ่งอธิบายถึงกฎต่างๆ จนถึงตอนนี้ในแพ็กเกจของเทรดนี้ แต่ละรายการของออบเจ็กต์ที่คล้าย dict จะจับคู่ชื่อของอินสแตนซ์กฎกับผลลัพธ์ที่ existing_rule(name) จะแสดง

ในที่นี้ วัตถุที่มีลักษณะเหมือนคำสั่งเผด็จการหมายถึงออบเจ็กต์ที่เปลี่ยนแปลงไม่ได้อย่างหนัก x ซึ่งรองรับการทำซ้ำที่คล้ายกับคำสั่ง เผด็จการ, len(x), name in x, x[name], x.get(name), x.items(), x.keys() และ x.values()

หากตั้งค่าแฟล็ก --noincompatible_existing_rules_immutable_view ไว้ ระบบจะส่งคำสั่งที่เปลี่ยนแปลงได้ใหม่ซึ่งมีเนื้อหาเดียวกันแทน

หมายเหตุ: หากเป็นไปได้ ให้หลีกเลี่ยงการใช้ฟังก์ชันนี้ ซึ่งทำให้ไฟล์ BUILD เปราะบางและขึ้นอยู่กับลำดับ นอกจากนี้ หากตั้งค่า Flag --noincompatible_existing_rules_immutable_view ฟังก์ชันนี้อาจมีราคาแพงมาก โดยเฉพาะหากมีการเรียกใช้ภายในลูป

exports_files

None exports_files(srcs, visibility=None, licenses=None)

ระบุรายการไฟล์ที่อยู่ในแพ็กเกจนี้ซึ่งส่งออกไปยังแพ็กเกจอื่นๆ

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
srcs sequence ของ strings จำเป็น
รายการไฟล์ที่จะส่งออก
visibility sequence; หรือ None; ค่าเริ่มต้นคือ None
สามารถระบุการประกาศระดับการเข้าถึง ไฟล์จะปรากฏให้เป้าหมายที่ระบุ หากไม่ได้ระบุการเปิดเผย ไฟล์จะสามารถมองเห็นได้ในทุกแพ็กเกจ
licenses sequence ของ strings หรือ None; ค่าเริ่มต้นคือ None
ใบอนุญาตที่ต้องระบุ

โลก

sequence glob(include=[], exclude=[], exclude_directories=1, allow_empty=unbound)

Glob จะแสดงรายการใหม่แบบแก้ไขได้และจัดเรียงได้ของทุกไฟล์ในแพ็กเกจปัจจุบัน ซึ่ง:
  • จับคู่รูปแบบอย่างน้อย 1 รายการใน include
  • ไม่ตรงกับรูปแบบใดๆ ใน exclude (ค่าเริ่มต้น [])
หากเปิดใช้อาร์กิวเมนต์ exclude_directories (ตั้งค่าเป็น 1) ไฟล์ของไดเรกทอรีประเภทจะไม่ปรากฏในผลลัพธ์ (ค่าเริ่มต้น 1)

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
include sequence ของ strings ค่าเริ่มต้นคือ []
รายการรูปแบบ glob ที่จะรวม
exclude sequence ของ strings ค่าเริ่มต้นคือ []
รายการรูปแบบ glob ที่จะยกเว้น
exclude_directories ค่าเริ่มต้นคือ 1
แฟล็กว่าจะยกเว้นไดเรกทอรีหรือไม่
allow_empty ค่าเริ่มต้นคือ unbound
เราอนุญาตให้รูปแบบ glob ไม่จับคู่กับข้อมูลใดๆ เลยหรือไม่ หาก "allow_เว้นว่าง" เป็น "เท็จ" รูปแบบที่รวมแต่ละรายการจะต้องตรงกับบางอย่าง และผลลัพธ์สุดท้ายต้องไม่ว่างเปล่า (หลังจากการจับคู่ของรูปแบบ "ยกเว้น" จะถูกยกเว้น)

module_name

string module_name()

ชื่อของโมดูล Bazel ที่เชื่อมโยงกับที่เก็บแพ็กเกจนี้ หากแพ็กเกจนี้มาจากที่เก็บที่กำหนดไว้ใน WORKSPACE แทนที่จะเป็น MODULE.bazel ตัวเลือกนี้จะว่างเปล่า สำหรับที่เก็บที่สร้างโดยส่วนขยายโมดูล นี่จะเป็นชื่อของโมดูลที่โฮสต์ส่วนขยาย ซึ่งจะเหมือนกับช่อง module.name ที่เห็นใน module_ctx.modules อาจส่งคืน None

module_version

string module_version()

เวอร์ชันของโมดูล Bazel ที่เชื่อมโยงกับที่เก็บแพ็กเกจนี้ หากแพ็กเกจนี้มาจากที่เก็บที่กำหนดไว้ใน WORKSPACE แทนที่จะเป็น MODULE.bazel ตัวเลือกนี้จะว่างเปล่า สำหรับที่เก็บที่สร้างโดยส่วนขยายโมดูล นี่คือเวอร์ชันของโมดูลที่โฮสต์ส่วนขยาย ซึ่งจะเหมือนกับช่อง module.version ที่เห็นใน module_ctx.modules อาจส่งคืน None

package_group

None package_group(name, packages=[], includes=[])

ฟังก์ชันนี้จะกำหนดชุดแพ็กเกจและกำหนดป้ายกำกับให้กับกลุ่ม คุณอ้างอิงป้ายกำกับได้ในแอตทริบิวต์ visibility

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
name ต้องระบุ
ชื่อที่ไม่ซ้ำกันของกฎนี้
packages sequence ของ strings ค่าเริ่มต้นคือ []
การแจกแจงแพ็กเกจที่สมบูรณ์ในกลุ่มนี้
includes sequence ของ strings ค่าเริ่มต้นคือ []
กลุ่มแพ็กเกจอื่นๆ ที่รวมอยู่ในแพ็กเกจนี้

package_name

string package_name()

ชื่อของแพ็กเกจที่กำลังประเมิน โดยไม่มีชื่อที่เก็บ เช่น ในไฟล์ BUILD some/package/BUILD ค่าจะเป็น some/package หากไฟล์ BUILD เรียกฟังก์ชันที่กำหนดไว้ในไฟล์ .bzl package_name() จะตรงกับแพ็กเกจไฟล์ BUILD ของผู้โทร

package_relative_label

Label package_relative_label(input)

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

สามารถเรียกใช้ฟังก์ชันนี้ได้ในขณะที่ประเมินไฟล์ BUILD และมาโครที่เรียกใช้โดยตรงหรือโดยอ้อมเท่านั้น ซึ่งอาจไม่เรียกใช้ในฟังก์ชันการใช้งานกฎ (เป็นต้น)

ผลลัพธ์ของฟังก์ชันนี้คือค่า Label เดียวกับที่เกิดขึ้นโดยการส่งสตริงที่ระบุไปยังแอตทริบิวต์ที่มีค่าป้ายกำกับของเป้าหมายที่ประกาศในไฟล์ BUILD

หมายเหตุการใช้งาน: ความแตกต่างระหว่างฟังก์ชันนี้และ Label() คือ Label() จะใช้บริบทของแพ็กเกจของไฟล์ .bzl ที่เรียกใช้ฟังก์ชันนี้ ไม่ใช่แพ็กเกจของไฟล์ BUILD ใช้ Label() เมื่อต้องอ้างอิงเป้าหมายแบบคงที่ซึ่งมีการฮาร์ดโค้ดไว้ในมาโคร เช่น คอมไพเลอร์ ใช้ package_relative_label() เมื่อคุณต้องทำให้สตริงป้ายกำกับที่ระบุโดยไฟล์ BUILD เป็นออบเจ็กต์ Label ให้เป็นมาตรฐาน (ไม่มีวิธีแปลงสตริงเป็น Label ในบริบทของแพ็กเกจนอกเหนือจากไฟล์ BUILD หรือไฟล์ .bzl การเรียกใช้ ด้วยเหตุนี้ มาโครด้านนอกจึงควรส่งออบเจ็กต์ป้ายกำกับไปยังมาโครภายในมากกว่าสตริงป้ายกำกับ)

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
input string; หรือ ป้ายกำกับ จำเป็น
สตริงป้ายกำกับอินพุตหรือออบเจ็กต์ป้ายกำกับ หากมีการส่งผ่านออบเจ็กต์ป้ายกำกับ จะส่งกลับตามที่เป็น

repo_name

string repo_name()

ชื่อ Canonical ของที่เก็บซึ่งมีแพ็กเกจที่กำลังประเมินอยู่ในปัจจุบัน โดยไม่มีเครื่องหมาย @ นำหน้า

repository_name

string repository_name()

ทดลอง API นี้อยู่ในขั้นทดลองและอาจเปลี่ยนแปลงได้ตลอดเวลา โปรดอย่าพึ่งพา ซึ่งอาจเปิดใช้ในการทดสอบโดยการตั้งค่า --+incompatible_enable_deprecated_label_apis
เลิกใช้งาน เลือกใช้ repo_name แทน ซึ่งไม่มีเครื่องหมาย @ ที่ไม่ถูกต้อง แต่มีการทำงานเหมือนกันทุกประการ

ชื่อ Canonical ของที่เก็บซึ่งมีแพ็กเกจที่กำลังประเมินอยู่ โดยมีเครื่องหมาย @ เดียว (@) นำหน้า ตัวอย่างเช่น ในแพ็กเกจที่เรียกใช้โดยข้อความ WORKSPACE local_repository(name='local', path=...) จะตั้งค่าเป็น @local ในแพ็กเกจในที่เก็บหลัก ระบบจะตั้งค่าเป็น @

เลือก

unknown select(x, no_match_error='')

select() คือฟังก์ชันตัวช่วยที่ทำให้แอตทริบิวต์กฎ configurable ได้ ดูรายละเอียดได้ที่สารานุกรมสร้าง

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
x ต้องระบุ
คำสั่งที่แมปเงื่อนไขการกำหนดค่ากับค่า แต่ละคีย์คือ Label หรือสตริงป้ายกํากับที่ระบุอินสแตนซ์ config_setting หรือrestrict_value ดูเอกสารประกอบเกี่ยวกับมาโครเพื่อดูว่าเมื่อใดควรใช้ป้ายกำกับแทนสตริง
no_match_error ค่าเริ่มต้นคือ ''
ข้อผิดพลาดที่กำหนดเองที่ไม่บังคับที่จะรายงานหากไม่มีเงื่อนไขที่ตรงกัน

แพ็กเกจย่อย

sequence subpackages(include, exclude=[], allow_empty=False)

แสดงรายการที่เปลี่ยนแปลงได้ใหม่ของแพ็กเกจย่อยโดยตรงทุกรายการของแพ็กเกจปัจจุบัน โดยไม่คำนึงถึงความลึกไดเรกทอรีของระบบไฟล์ รายการที่ส่งกลับจะจัดเรียงและประกอบด้วยชื่อของแพ็กเกจย่อยที่เกี่ยวข้องกับแพ็กเกจปัจจุบัน เราขอแนะนำให้ใช้เมธอดในโมดูล bazel_skylib.subpackages แทนการเรียกใช้ฟังก์ชันนี้โดยตรง

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
include sequence ของ strings จำเป็น
รายการรูปแบบ glob ที่จะรวมไว้ในการสแกนแพ็กเกจย่อย
exclude sequence ของ strings ค่าเริ่มต้นคือ []
การสแกนรายการรูปแบบ glob ที่จะยกเว้นจากแพ็กเกจย่อย
allow_empty ค่าเริ่มต้นคือ False
ดูว่าเราจะล้มเหลวหรือไม่หากการโทรส่งคืนรายการที่ว่างเปล่า โดยค่าเริ่มต้น รายการที่ว่างเปล่าจะบ่งชี้ถึงข้อผิดพลาดที่อาจเกิดขึ้นในไฟล์ BUILD ซึ่งการเรียกไปยังแพ็กเกจย่อย() สูงมาก การตั้งค่าเป็น "จริง" จะช่วยให้ฟังก์ชันนี้ดำเนินการสำเร็จในกรณีนั้นได้