template_ctx

ออบเจ็กต์บริบทที่ส่งผ่านไปยังฟังก์ชันการขยายเทมเพลตการดำเนินการ

สมาชิก

args

Args template_ctx.args()

แสดงผลออบเจ็กต์ Args ที่ใช้สร้างบรรทัดคำสั่งที่มีประสิทธิภาพด้านหน่วยความจำได้

declare_file

File template_ctx.declare_file(filename, *, directory)

ประกาศว่าการใช้งานสร้างไฟล์ที่มีชื่อไฟล์ที่ระบุภายในไดเรกทอรีที่ระบุ

โปรดทราบว่านอกจากการประกาศไฟล์แล้ว คุณต้องสร้างการดำเนินการที่ปล่อยไฟล์แยกกันด้วย การสร้างการดำเนินการดังกล่าวจะต้องส่งออบเจ็กต์ File ที่แสดงผลไปยังฟังก์ชันการสร้างของการดำเนินการ

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
filename สตริง; ต้องระบุ
เส้นทางแบบสัมพัทธ์ของไฟล์ภายในไดเรกทอรี
directory ไฟล์; ต้องระบุ
ไดเรกทอรีที่ควรสร้างไฟล์

run

None template_ctx.run(*, outputs, inputs=[], executable, tools=None, arguments=[], progress_message=None)

สร้างการดำเนินการที่เรียกใช้ไฟล์ที่เรียกใช้งานได้

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
outputs ลำดับของไฟล์; ต้องระบุ
รายการไฟล์เอาต์พุตของการดำเนินการ
inputs ลำดับของไฟล์หรือdepset; ค่าเริ่มต้นคือ[]
รายการหรือdepsetของไฟล์อินพุตของการดำเนินการ
executable ไฟล์ หรือ สตริง หรือ FilesToRunProvider; ต้องระบุ
ไฟล์ที่เรียกใช้งานได้ที่การดำเนินการจะเรียก
tools ลำดับ หรือ depset หรือ None; ค่าเริ่มต้นคือ None
รายการหรือ depset ของเครื่องมือที่การดำเนินการต้องใช้ เครื่องมือคืออินพุตที่เรียกใช้งานได้ซึ่งอาจมี runfile ของตัวเองที่การดำเนินการจะใช้ได้โดยอัตโนมัติ

เมื่อระบุรายการ รายการดังกล่าวอาจเป็นคอลเล็กชันแบบผสมของรายการต่อไปนี้

  • Files
  • อินสแตนซ์ FilesToRunProvider
  • depsets ของ Files
Files จาก ctx.executable และ FilesToRunProviders ที่อยู่ในรายการโดยตรงจะมีการเพิ่ม runfile โดยอัตโนมัติ ระบบจะเพิ่มเครื่องมือทั้งหมดเป็นอินพุตโดยนัย

arguments ลำดับ; ค่าเริ่มต้นคือ []
อาร์กิวเมนต์บรรทัดคำสั่งของการดำเนินการ ต้องเป็นรายการสตริงหรือออบเจ็กต์ actions.args()
progress_message สตริง หรือ None; ค่าเริ่มต้นคือ None
ข้อความแสดงความคืบหน้าที่จะแสดงต่อผู้ใช้ระหว่างการบิลด์