template_ctx

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

สมาชิก

args

Args template_ctx.args()

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

declare_file

File template_ctx.declare_file(filename, *, directory)

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

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

พารามิเตอร์

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

โฮมรัน

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

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

พารามิเตอร์

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

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

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

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