attrs
ของ rule()
และ aspect()
โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับการกำหนดและการใช้แอตทริบิวต์ในหน้ากฎ
สมาชิก
- bool
- int
- int_list
- ป้ายกำกับ
- label_keyed_string_dict
- label_list
- output
- output_list
- สตริง
- string_dict
- string_list
- string_list_dict
บูลีน
Attribute attr.bool(default=False, doc='', mandatory=False)สร้างสคีมาสําหรับแอตทริบิวต์บูลีน
พารามิเตอร์
พารามิเตอร์ | คำอธิบาย |
---|---|
default
|
default = False ค่าเริ่มต้นที่จะใช้หากไม่ได้ระบุค่าสำหรับแอตทริบิวต์นี้เมื่อสร้างอินสแตนซ์ของกฎ |
doc
|
default = '' คำอธิบายแอตทริบิวต์ที่เครื่องมือสร้างเอกสารประกอบสามารถดึงข้อมูลได้ |
mandatory
|
ค่าเริ่มต้น = เท็จ หากเป็น "จริง" ต้องระบุค่าอย่างชัดแจ้ง (แม้ว่าจะมี default ก็ตาม)
|
int
Attribute attr.int(default=0, doc='', mandatory=False, values=[])สร้างสคีมาสําหรับแอตทริบิวต์จำนวนเต็ม ค่าต้องอยู่ในช่วง 32 บิตแบบมีเครื่องหมาย
พารามิเตอร์
พารามิเตอร์ | คำอธิบาย |
---|---|
default
|
default = 0 ค่าเริ่มต้นที่จะใช้หากไม่ได้ระบุค่าสำหรับแอตทริบิวต์นี้เมื่อสร้างอินสแตนซ์ของกฎ |
doc
|
default = '' คำอธิบายแอตทริบิวต์ที่เครื่องมือสร้างเอกสารประกอบสามารถดึงข้อมูลได้ |
mandatory
|
default = False หากเป็น True จะต้องระบุค่าอย่างชัดเจน (แม้ว่าจะมี default ก็ตาม)
|
values
|
sequence of ints ;
default = []รายการค่าที่อนุญาตสำหรับแอตทริบิวต์ ระบบจะแสดงข้อผิดพลาดหากระบุค่าอื่น |
int_list
Attribute attr.int_list(mandatory=False, allow_empty=True, *, default=[], doc='')สร้างสคีมาสําหรับแอตทริบิวต์รายการจำนวนเต็ม องค์ประกอบแต่ละรายการต้องอยู่ในช่วง 32 บิตที่มีค่าบวก
พารามิเตอร์
พารามิเตอร์ | คำอธิบาย |
---|---|
mandatory
|
default = False หากเป็น True จะต้องระบุค่าอย่างชัดเจน (แม้ว่าจะมี default ก็ตาม)
|
allow_empty
|
default = True True หากแอตทริบิวต์นั้นว่างเปล่าได้ |
default
|
sequence of ints ;
default = []ค่าเริ่มต้นที่จะใช้หากไม่ได้ระบุค่าสำหรับแอตทริบิวต์นี้เมื่อสร้างอินสแตนซ์ของกฎ |
doc
|
default = '' คำอธิบายแอตทริบิวต์ที่เครื่องมือสร้างเอกสารประกอบสามารถดึงข้อมูลได้ |
ป้ายกำกับ
Attribute attr.label(default=None, doc='', executable=False, allow_files=None, allow_single_file=None, mandatory=False, providers=[], allow_rules=None, cfg=None, aspects=[])
สร้างสคีมาสําหรับแอตทริบิวต์ป้ายกํากับ นี่เป็นแอตทริบิวต์ของทรัพยากร Dependency
แอตทริบิวต์นี้มีค่า Label
ที่ไม่ซ้ำกัน หากระบุสตริงแทน Label
ระบบจะแปลงสตริงโดยใช้เครื่องมือสร้างป้ายกำกับ ส่วนที่เกี่ยวข้องของเส้นทางป้ายกำกับ รวมถึงที่เก็บ (อาจเปลี่ยนชื่อ) ได้รับการแก้ไขตามแพ็กเกจของเป้าหมายที่สร้างอินสแตนซ์
ขณะวิเคราะห์ (ภายในฟังก์ชันการใช้งานของกฎ) เมื่อดึงค่าแอตทริบิวต์จาก ctx.attr
ป้ายกำกับจะถูกแทนที่ด้วย Target
ที่เกี่ยวข้อง ซึ่งจะช่วยให้คุณเข้าถึงผู้ให้บริการของข้อกําหนดของเป้าหมายปัจจุบันได้
นอกจากไฟล์ซอร์สธรรมดาแล้ว แอตทริบิวต์ประเภทนี้มักใช้เพื่ออ้างถึงเครื่องมือ เช่น คอมไพเลอร์ เครื่องมือดังกล่าวถือว่าเป็นทรัพยากร Dependency เช่นเดียวกับไฟล์ต้นฉบับ หากไม่ต้องการให้ผู้ใช้ระบุป้ายกำกับของเครื่องมือทุกครั้งที่ใช้กฎในไฟล์ BUILD คุณสามารถกำหนดป้ายกำกับของเครื่องมือตามแบบฉบับเป็นค่า default
ของแอตทริบิวต์นี้ได้ หากต้องการป้องกันไม่ให้ผู้ใช้ลบล้างค่าเริ่มต้นนี้ด้วย ให้ทําแอตทริบิวต์เป็นแบบส่วนตัวโดยตั้งชื่อแอตทริบิวต์นั้นขึ้นต้นด้วยเครื่องหมายขีดล่าง โปรดดูข้อมูลเพิ่มเติมในหน้ากฎ
พารามิเตอร์
พารามิเตอร์ | คำอธิบาย |
---|---|
default
|
Label; or string; or LateBoundDefault; or NativeComputedDefault; or function; or None ;
default = Noneค่าเริ่มต้นที่จะใช้หากไม่ได้ระบุค่าสำหรับแอตทริบิวต์นี้เมื่อสร้างอินสแตนซ์ของกฎ ใช้สตริงหรือฟังก์ชัน Label เพื่อระบุค่าเริ่มต้น เช่น attr.label(default = "//a:b")
|
doc
|
default = '' คำอธิบายแอตทริบิวต์ที่เครื่องมือสร้างเอกสารประกอบสามารถดึงข้อมูลได้ |
executable
|
default = เท็จ หากทรัพยากร Dependency ต้องเรียกใช้ได้ ซึ่งหมายความว่าป้ายกำกับต้องอ้างอิงถึงไฟล์ที่ปฏิบัติการได้ หรือกฎที่แสดงผลไฟล์ที่ปฏิบัติการได้ เข้าถึงป้ายกำกับด้วย ctx.executable.<attribute_name>
|
allow_files
|
bool; or sequence of strings; or None ;
default = NoneWhether File targets are allowed. อาจเป็น True , False (ค่าเริ่มต้น) หรือรายการนามสกุลไฟล์ที่อนุญาต (เช่น [".cc", ".cpp"] )
|
allow_single_file
|
ค่าเริ่มต้น = ไม่มี ตัวเลือกนี้คล้ายกับ allow_files แต่มีข้อจำกัดว่าป้ายกำกับต้องสอดคล้องกับไฟล์เดียว เข้าถึงได้ผ่าน ctx.file.<attribute_name>
|
mandatory
|
default = False หากเป็น True จะต้องระบุค่าอย่างชัดเจน (แม้ว่าจะมี default ก็ตาม)
|
providers
|
default = [] ผู้ให้บริการที่ต้องระบุโดยข้อกําหนดใดๆ ที่ปรากฏในแอตทริบิวต์นี้ รูปแบบของอาร์กิวเมนต์นี้คือลิสต์ของลิสต์ผู้ให้บริการ ซึ่งเป็นออบเจ็กต์ |
allow_rules
|
sequence of strings; or None ;
default = NoneWhich rule targets (name of the classes) are allowed. เลิกใช้งานแล้ว (เก็บไว้เพื่อความเข้ากันได้เท่านั้น) โปรดใช้ผู้ให้บริการแทน |
cfg
|
default = None การกําหนดค่าของแอตทริบิวต์ ซึ่งอาจเป็น "exec" ซึ่งระบุว่ามีการบิลด์ข้อกำหนดสำหรับ execution platform หรือ "target" ซึ่งระบุว่ามีการบิลด์ข้อกำหนดสำหรับ target platform ตัวอย่างทั่วไปของความแตกต่างคือการสร้างแอปบนอุปกรณ์เคลื่อนที่ โดยที่ target platform คือ Android หรือ iOS ส่วน execution platform คือ Linux , macOS หรือ Windows พารามิเตอร์นี้จําเป็นหาก executable เป็น True เพื่อป้องกันการสร้างเครื่องมือโฮสต์ในการกําหนดค่าเป้าหมายโดยไม่ตั้งใจ "target" ไม่มีผลเชิงความหมาย ดังนั้นอย่าตั้งค่าเมื่อ executable เป็น False เว้นแต่จะทําให้เจตนาของคุณชัดเจนขึ้นจริงๆ
|
aspects
|
sequence of Aspects ;
default = []แง่มุมที่ควรใช้กับทรัพยากร Dependency ที่ระบุโดยแอตทริบิวต์นี้ |
label_keyed_string_dict
Attribute attr.label_keyed_string_dict(allow_empty=True, *, default={}, doc='', allow_files=None, allow_rules=None, providers=[], flags=[], mandatory=False, cfg=None, aspects=[])
สร้างสคีมาสําหรับแอตทริบิวต์ที่มีพจนานุกรม โดยที่คีย์คือป้ายกํากับและค่าคือสตริง นี่เป็นแอตทริบิวต์ของทรัพยากร Dependency
แอตทริบิวต์นี้มีค่า Label
ที่ไม่ซ้ำกัน หากระบุสตริงแทน Label
ระบบจะแปลงสตริงโดยใช้เครื่องมือสร้างป้ายกำกับ ส่วนที่เกี่ยวข้องของเส้นทางป้ายกำกับ รวมถึงที่เก็บ (อาจเปลี่ยนชื่อ) ได้รับการแก้ไขตามแพ็กเกจของเป้าหมายที่สร้างอินสแตนซ์
ขณะวิเคราะห์ (ภายในฟังก์ชันการใช้งานของกฎ) เมื่อดึงค่าแอตทริบิวต์จาก ctx.attr
ป้ายกำกับจะถูกแทนที่ด้วย Target
ที่เกี่ยวข้อง ซึ่งจะช่วยให้คุณเข้าถึงผู้ให้บริการทรัพยากร Dependency ของเป้าหมายปัจจุบันได้
พารามิเตอร์
พารามิเตอร์ | คำอธิบาย |
---|---|
allow_empty
|
default = True True หากแอตทริบิวต์นั้นว่างเปล่าได้ |
default
|
dict; or function ;
default = {}ค่าเริ่มต้นที่จะใช้หากไม่ได้ระบุค่าสำหรับแอตทริบิวต์นี้เมื่อสร้างอินสแตนซ์ของกฎ ใช้สตริงหรือฟังก์ชัน Label เพื่อระบุค่าเริ่มต้น เช่น attr.label_keyed_string_dict(default = {"//a:b": "value", "//a:c": "string"})
|
doc
|
ค่าเริ่มต้น = '' คำอธิบายแอตทริบิวต์ที่เครื่องมือการสร้างเอกสารดึงข้อมูลได้ |
allow_files
|
bool; or sequence of strings; or None ;
default = NoneWhether File targets are allowed. อาจเป็น True , False (ค่าเริ่มต้น) หรือรายการนามสกุลไฟล์ที่อนุญาต (เช่น [".cc", ".cpp"] )
|
allow_rules
|
sequence of strings; or None ;
ค่าเริ่มต้น = ไม่มีกฎเป้าหมาย (ชื่อคลาส) ที่อนุญาต การตั้งค่านี้เลิกใช้งานแล้ว (เก็บไว้เพื่อใช้งานร่วมกันได้เท่านั้น) ให้ใช้ผู้ให้บริการแทน |
providers
|
default = [] ผู้ให้บริการที่ต้องระบุโดยข้อกําหนดใดๆ ที่ปรากฏในแอตทริบิวต์นี้ รูปแบบของอาร์กิวเมนต์นี้คือลิสต์ของลิสต์ผู้ให้บริการ ซึ่งเป็นออบเจ็กต์ |
flags
|
sequence of strings ;
default = []เลิกใช้งานแล้วและจะถูกนำออก |
mandatory
|
default = False หากเป็น True จะต้องระบุค่าอย่างชัดเจน (แม้ว่าจะมี default ก็ตาม)
|
cfg
|
default = None การกําหนดค่าของแอตทริบิวต์ อาจเป็น "exec" ซึ่งบ่งบอกว่ามีการสร้างทรัพยากร Dependency สำหรับ execution platform หรือ "target" ซึ่งบ่งบอกว่าทรัพยากร Dependency สร้างขึ้นสำหรับ target platform ตัวอย่างทั่วไปของความแตกต่างคือการสร้างแอปบนอุปกรณ์เคลื่อนที่ โดยที่ target platform คือ Android หรือ iOS ส่วน execution platform คือ Linux , macOS หรือ Windows
|
aspects
|
sequence of Aspects ;
default = []แง่มุมที่ควรใช้กับทรัพยากร Dependency ที่ระบุโดยแอตทริบิวต์นี้ |
label_list
Attribute attr.label_list(allow_empty=True, *, default=[], doc='', allow_files=None, allow_rules=None, providers=[], flags=[], mandatory=False, cfg=None, aspects=[])
สร้างสคีมาสำหรับแอตทริบิวต์รายการป้ายกำกับ นี่เป็นแอตทริบิวต์ของทรัพยากร Dependency
แอตทริบิวต์นี้มีค่า Label
ที่ไม่ซ้ำกัน หากระบุสตริงแทน Label
ระบบจะแปลงสตริงโดยใช้เครื่องมือสร้างป้ายกำกับ ส่วนที่เกี่ยวข้องของเส้นทางป้ายกำกับ รวมถึงที่เก็บ (อาจเปลี่ยนชื่อ) ได้รับการแก้ไขตามแพ็กเกจของเป้าหมายที่สร้างอินสแตนซ์
ในเวลาวิเคราะห์ (ภายในฟังก์ชันการใช้งานของกฎ) เมื่อดึงค่าแอตทริบิวต์จาก ctx.attr
ระบบจะแทนที่ป้ายกํากับด้วย Target
ที่เกี่ยวข้อง ซึ่งจะช่วยให้คุณเข้าถึงผู้ให้บริการของข้อกําหนดของเป้าหมายปัจจุบันได้
พารามิเตอร์
พารามิเตอร์ | คำอธิบาย |
---|---|
allow_empty
|
default = True True หากแอตทริบิวต์นั้นว่างเปล่าได้ |
default
|
sequence of Labels; or function ;
default = []ค่าเริ่มต้นที่จะใช้หากไม่ได้ระบุค่าสำหรับแอตทริบิวต์นี้เมื่อสร้างอินสแตนซ์ของกฎ ใช้สตริงหรือฟังก์ชัน Label เพื่อระบุค่าเริ่มต้น เช่น attr.label_list(default = ["//a:b", "//a:c"])
|
doc
|
ค่าเริ่มต้น = '' คำอธิบายแอตทริบิวต์ที่เครื่องมือการสร้างเอกสารดึงข้อมูลได้ |
allow_files
|
bool; or sequence of strings; or None ;
default = NoneWhether File targets are allowed. อาจเป็น True , False (ค่าเริ่มต้น) หรือรายการนามสกุลไฟล์ที่อนุญาต (เช่น [".cc", ".cpp"] )
|
allow_rules
|
sequence of strings; or None ;
ค่าเริ่มต้น = ไม่มีกฎเป้าหมาย (ชื่อคลาส) ที่อนุญาต การตั้งค่านี้เลิกใช้งานแล้ว (เก็บไว้เพื่อใช้งานร่วมกันได้เท่านั้น) ให้ใช้ผู้ให้บริการแทน |
providers
|
default = [] ผู้ให้บริการที่ต้องระบุโดยข้อกําหนดใดๆ ที่ปรากฏในแอตทริบิวต์นี้ รูปแบบของอาร์กิวเมนต์นี้คือลิสต์ของลิสต์ผู้ให้บริการ ซึ่งเป็นออบเจ็กต์ |
flags
|
sequence of strings ;
default = []เลิกใช้งานแล้วและจะถูกนำออก |
mandatory
|
default = False หากเป็น True จะต้องระบุค่าอย่างชัดเจน (แม้ว่าจะมี default ก็ตาม)
|
cfg
|
default = None การกําหนดค่าของแอตทริบิวต์ ซึ่งอาจเป็น "exec" ซึ่งระบุว่ามีการบิลด์ข้อกำหนดสำหรับ execution platform หรือ "target" ซึ่งระบุว่ามีการบิลด์ข้อกำหนดสำหรับ target platform ตัวอย่างทั่วไปของความแตกต่างคือการสร้างแอปบนอุปกรณ์เคลื่อนที่ โดยที่ target platform คือ Android หรือ iOS ส่วน execution platform คือ Linux , macOS หรือ Windows
|
aspects
|
sequence of Aspects ;
default = []แง่มุมที่ควรใช้กับทรัพยากร Dependency ที่ระบุโดยแอตทริบิวต์นี้ |
เอาต์พุต
Attribute attr.output(doc='', mandatory=False)
สร้างสคีมาสำหรับแอตทริบิวต์เอาต์พุต (ป้ายกำกับ)
แอตทริบิวต์นี้มีค่า Label
ที่ไม่ซ้ำกัน หากระบุสตริงแทน Label
ระบบจะแปลงสตริงโดยใช้เครื่องมือสร้างป้ายกำกับ ระบบจะแก้ไขส่วนที่สัมพันธ์กันของเส้นทางป้ายกำกับ ซึ่งรวมถึงที่เก็บ (อาจเปลี่ยนชื่อ) โดยอิงตามแพ็กเกจของเป้าหมายที่สร้างขึ้น
ในเวลาที่วิเคราะห์ คุณสามารถดึงข้อมูล File
ที่เกี่ยวข้องได้โดยใช้ ctx.outputs
พารามิเตอร์
พารามิเตอร์ | คำอธิบาย |
---|---|
doc
|
default = '' คำอธิบายแอตทริบิวต์ที่เครื่องมือสร้างเอกสารประกอบสามารถดึงข้อมูลได้ |
mandatory
|
default = False หากเป็น True จะต้องระบุค่าอย่างชัดเจน (แม้ว่าจะมี default ก็ตาม)
|
output_list
Attribute attr.output_list(allow_empty=True, *, doc='', mandatory=False)สร้างสคีมาสําหรับแอตทริบิวต์รายการเอาต์พุต
แอตทริบิวต์นี้มีค่า Label
ที่ไม่ซ้ำกัน หากระบุสตริงแทน Label
ระบบจะแปลงสตริงโดยใช้เครื่องมือสร้างป้ายกำกับ ระบบจะแก้ไขส่วนที่สัมพันธ์กันของเส้นทางป้ายกำกับ ซึ่งรวมถึงที่เก็บ (อาจเปลี่ยนชื่อ) โดยอิงตามแพ็กเกจของเป้าหมายที่สร้างขึ้น
ในเวลาที่วิเคราะห์ คุณสามารถดึงข้อมูล File
ที่เกี่ยวข้องได้โดยใช้ ctx.outputs
พารามิเตอร์
พารามิเตอร์ | คำอธิบาย |
---|---|
allow_empty
|
default = True จริงหากแอตทริบิวต์ว่างเปล่าได้ |
doc
|
default = '' คำอธิบายแอตทริบิวต์ที่เครื่องมือสร้างเอกสารประกอบสามารถดึงข้อมูลได้ |
mandatory
|
default = False หากเป็น True จะต้องระบุค่าอย่างชัดเจน (แม้ว่าจะมี default ก็ตาม)
|
สตริง
Attribute attr.string(default='', doc='', mandatory=False, values=[])สร้างสคีมาสำหรับแอตทริบิวต์สตริง
พารามิเตอร์
พารามิเตอร์ | คำอธิบาย |
---|---|
default
|
string; or NativeComputedDefault ;
ค่าเริ่มต้น = ''ค่าเริ่มต้นที่จะใช้หากไม่มีการระบุค่าสำหรับแอตทริบิวต์นี้เมื่อเริ่มต้นกฎ |
doc
|
default = '' คำอธิบายแอตทริบิวต์ที่เครื่องมือสร้างเอกสารประกอบสามารถดึงข้อมูลได้ |
mandatory
|
default = False หากเป็น True จะต้องระบุค่าอย่างชัดเจน (แม้ว่าจะมี default ก็ตาม)
|
values
|
sequence of strings ;
default = []รายการค่าที่อนุญาตสำหรับแอตทริบิวต์ ระบบจะแสดงข้อผิดพลาดหากระบุค่าอื่น |
string_dict
Attribute attr.string_dict(allow_empty=True, *, default={}, doc='', mandatory=False)สร้างสคีมาสำหรับแอตทริบิวต์ที่มีพจนานุกรมอยู่ ซึ่งคีย์และค่าเป็นสตริง
พารามิเตอร์
พารามิเตอร์ | คำอธิบาย |
---|---|
allow_empty
|
default = True True หากแอตทริบิวต์นั้นว่างเปล่าได้ |
default
|
ค่าเริ่มต้น = {} ค่าเริ่มต้นที่จะใช้หากไม่มีการระบุค่าสำหรับแอตทริบิวต์นี้เมื่อเริ่มต้นกฎ |
doc
|
default = '' คำอธิบายแอตทริบิวต์ที่เครื่องมือสร้างเอกสารประกอบสามารถดึงข้อมูลได้ |
mandatory
|
ค่าเริ่มต้น = เท็จ หากเป็น "จริง" ต้องระบุค่าอย่างชัดแจ้ง (แม้ว่าจะมี default ก็ตาม)
|
string_list
Attribute attr.string_list(mandatory=False, allow_empty=True, *, default=[], doc='')สร้างสคีมาสำหรับแอตทริบิวต์รายการสตริง
พารามิเตอร์
พารามิเตอร์ | คำอธิบาย |
---|---|
mandatory
|
default = False หากเป็น True จะต้องระบุค่าอย่างชัดเจน (แม้ว่าจะมี default ก็ตาม)
|
allow_empty
|
default = True True หากแอตทริบิวต์นั้นว่างเปล่าได้ |
default
|
sequence of strings; or NativeComputedDefault ;
default = []ค่าเริ่มต้นที่จะใช้หากไม่ได้ระบุค่าสำหรับแอตทริบิวต์นี้เมื่อสร้างอินสแตนซ์ของกฎ |
doc
|
default = '' คำอธิบายแอตทริบิวต์ที่เครื่องมือสร้างเอกสารประกอบสามารถดึงข้อมูลได้ |
string_list_dict
Attribute attr.string_list_dict(allow_empty=True, *, default={}, doc='', mandatory=False)สร้างสคีมาสําหรับแอตทริบิวต์ที่มีพจนานุกรม โดยที่คีย์คือสตริงและค่าคือรายการสตริง
พารามิเตอร์
พารามิเตอร์ | คำอธิบาย |
---|---|
allow_empty
|
default = True True หากแอตทริบิวต์นั้นว่างเปล่าได้ |
default
|
ค่าเริ่มต้น = {} ค่าเริ่มต้นที่จะใช้หากไม่มีการระบุค่าสำหรับแอตทริบิวต์นี้เมื่อเริ่มต้นกฎ |
doc
|
default = '' คำอธิบายแอตทริบิวต์ที่เครื่องมือสร้างเอกสารประกอบสามารถดึงข้อมูลได้ |
mandatory
|
default = False หากเป็น True จะต้องระบุค่าอย่างชัดเจน (แม้ว่าจะมี default ก็ตาม)
|