ป้ายกำกับ

7.3 · 7.2 · 7.1 · 7.0 · 6.5

ตัวระบุเป้าหมายของบิลด์

สำหรับทุกๆ อินสแตนซ์ Label l ตัวแทนสตริง str(l) จะมีพร็อพเพอร์ตี้ที่ Label(str(l)) == l ไม่ว่าการเรียก Label() จะเกิดขึ้นที่ใด

เมื่อส่งเป็นอาร์กิวเมนต์ตำแหน่งไปยัง print() หรือ fail() แล้ว Label จะใช้การแสดงสตริงที่เพิ่มประสิทธิภาพเพื่อให้มนุษย์อ่านได้ง่ายแทน การนําเสนอนี้ใช้ชื่อที่เก็บที่ปรากฏจากมุมมองของที่เก็บหลัก หากเป็นไปได้

สมาชิก

ป้ายกำกับ

Label Label(input)

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

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

พารามิเตอร์

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

ชื่อ

string Label.name

ชื่อของเป้าหมายที่ป้ายกำกับนี้อ้างอิงถึง เช่น
Label("@@foo//pkg/foo:abc").name == "abc"

พัสดุ

string Label.package

ชื่อของแพ็กเกจที่มีเป้าหมายซึ่งป้ายกำกับนี้อ้างอิงถึง โดยไม่ระบุชื่อที่เก็บ เช่น
Label("@@repo//pkg/foo:abc").package == "pkg/foo"

ที่เกี่ยวข้อง

Label Label.relative(relName)

ทดลอง API นี้ยังอยู่ในขั้นทดลองและอาจมีการเปลี่ยนแปลงได้ทุกเมื่อ โปรดอย่าใช้ข้อมูลนี้ ซึ่งอาจเปิดใช้ในการทดสอบโดยการตั้งค่า --+incompatible_enable_deprecated_label_apis
เลิกใช้งาน เมธอดนี้จะทำงานอย่างน่าประหลาดใจเมื่อใช้กับอาร์กิวเมนต์ที่มีชื่อรีโปที่ชัดเจน โปรดใช้ Label.same_package_label(), native.package_relative_label() หรือ Label() แทน

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

Label("//foo/bar:baz").relative(":quux") == Label("//foo/bar:quux")
Label("//foo/bar:baz").relative("//wiz:quux") == Label("//wiz:quux")
Label("@repo//foo/bar:baz").relative("//wiz:quux") == Label("@repo//wiz:quux")
Label("@repo//foo/bar:baz").relative("//visibility:public") == Label("//visibility:public")
Label("@repo//foo/bar:baz").relative("@other//wiz:quux") == Label("@other//wiz:quux")

หากการแมปที่เก็บที่ส่งผ่านคือ {'@other' : '@remapped'} ระบบจะทำการแมปใหม่ดังต่อไปนี้

Label("@repo//foo/bar:baz").relative("@other//wiz:quux") == Label("@remapped//wiz:quux")

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
relName required
ป้ายกำกับที่จะได้รับการแก้ไขโดยสัมพันธ์กับป้ายกำกับนี้

repo_name

string Label.repo_name

ชื่อตามแบบฉบับของที่เก็บซึ่งมีเป้าหมายที่อ้างอิงโดยป้ายกำกับนี้ โดยไม่มีเครื่องหมาย @ (@) นำหน้า เช่น
Label("@@foo//bar:baz").repo_name == "foo"

same_package_label

Label Label.same_package_label(target_name)

สร้างป้ายกำกับในแพ็กเกจเดียวกับป้ายกำกับนี้โดยใช้ชื่อเป้าหมายที่ระบุ

พารามิเตอร์

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

workspace_name

string Label.workspace_name

ทดลอง API นี้ยังอยู่ในขั้นทดลองและอาจมีการเปลี่ยนแปลงได้ทุกเมื่อ โปรดอย่าพึ่งพา คุณอาจเปิดใช้เป็นการทดลองได้โดยการตั้งค่า --+incompatible_enable_deprecated_label_apis
เลิกใช้งานแล้ว ชื่อช่อง "ชื่อพื้นที่ทํางาน" นั้นไม่ถูกต้อง ให้ใช้ Label.repo_name แทน

ชื่อตามแบบฉบับของที่เก็บซึ่งมีเป้าหมายที่อ้างอิงโดยป้ายกำกับนี้ โดยไม่มีเครื่องหมาย @ (@) นำหน้า เช่น

Label("@@foo//bar:baz").workspace_name == "foo"

workspace_root

string Label.workspace_root

แสดงผลรูทการดําเนินการสําหรับที่เก็บซึ่งมีเป้าหมายที่อ้างอิงโดยป้ายกำกับนี้ โดยสัมพันธ์กับ execroot เช่น
Label("@repo//pkg/foo:abc").workspace_root == "external/repo"