ctx.actions
สมาชิก
- args
- declare_directory
- declare_file
- declare_symlink
- do_nothing
- expand_template
- run
- run_shell
- symlink
- template_dict
- write
args
Args actions.args()แสดงผลออบเจ็กต์ Args ที่ใช้สร้างบรรทัดคำสั่งที่ประหยัดหน่วยความจำได้
declare_directory
File actions.declare_directory(filename, *, sibling=None)ประกาศว่ากฎหรือแง่มุมสร้างไดเรกทอรีที่มีชื่อที่ระบุในแพ็กเกจปัจจุบัน คุณต้องสร้างการดำเนินการที่สร้างไดเรกทอรี เนื้อหาของไดเรกทอรีจะเข้าถึงจาก Starlark โดยตรงไม่ได้ แต่สามารถขยายในคำสั่งการดำเนินการด้วย
Args.add_all()
พารามิเตอร์
พารามิเตอร์ | คำอธิบาย |
---|---|
filename
|
ต้องระบุ หากไม่ได้ระบุ "sibling" เส้นทางของไดเรกทอรีใหม่จะสัมพันธ์กับแพ็กเกจปัจจุบัน หรือจะเป็นชื่อฐานของไฟล์ก็ได้ ('sibling' จะกำหนดไดเรกทอรี) |
sibling
|
File; or None ;
default = Noneเป็นไฟล์ที่อยู่ในไดเรกทอรีเดียวกับไดเรกทอรีที่ประกาศใหม่ ไฟล์ต้องอยู่ในแพ็กเกจปัจจุบัน |
declare_file
File actions.declare_file(filename, *, sibling=None)ประกาศว่ากฎหรือแง่มุมสร้างไฟล์ที่มีชื่อไฟล์ที่ระบุ หากไม่ได้ระบุ
sibling
ชื่อไฟล์จะสัมพันธ์กับไดเรกทอรีแพ็กเกจ หรือไฟล์จะอยู่ในไดเรกทอรีเดียวกับ sibling
คุณสร้างไฟล์นอกแพ็กเกจปัจจุบันไม่ได้โปรดทราบว่านอกจากการประกาศไฟล์แล้ว คุณยังต้องสร้างการดำเนินการที่ส่งออกไฟล์แยกต่างหากด้วย การสร้างการดําเนินการดังกล่าวจะต้องส่งออบเจ็กต์ File
ที่แสดงผลไปยังฟังก์ชันการสร้างของการดําเนินการ
โปรดทราบว่าไฟล์เอาต์พุตที่ประกาศไว้ล่วงหน้าไม่จําเป็นต้อง (และไม่สามารถ) ประกาศโดยใช้ฟังก์ชันนี้ คุณสามารถรับออบเจ็กต์ File
ได้จาก ctx.outputs
แทน ดูตัวอย่างการใช้งาน
พารามิเตอร์
พารามิเตอร์ | คำอธิบาย |
---|---|
filename
|
ต้องระบุ หากไม่ได้ระบุ "sibling" เส้นทางของไฟล์ใหม่จะสัมพันธ์กับแพ็กเกจปัจจุบัน หรือจะเป็นชื่อฐานของไฟล์ก็ได้ ('sibling' จะกำหนดไดเรกทอรี) |
sibling
|
File; or None ;
default = Noneเป็นไฟล์ที่อยู่ในไดเรกทอรีเดียวกับไฟล์ที่สร้างขึ้นใหม่ ไฟล์ต้องอยู่ในแพ็กเกจปัจจุบัน |
declare_symlink
File actions.declare_symlink(filename, *, sibling=None)
ทดลอง พารามิเตอร์นี้ยังอยู่ในขั้นทดลองและอาจมีการเปลี่ยนแปลงได้ทุกเมื่อ โปรดอย่าใช้ข้อมูลนี้ คุณอาจเปิดใช้ฟีเจอร์นี้เป็นการทดลองได้โดยการตั้งค่า --experimental_allow_unresolved_symlinks
ประกาศว่ากฎหรือแง่มุมสร้างสัญลักษณ์ลิงก์ที่มีชื่อที่ระบุในแพ็กเกจปัจจุบัน คุณต้องสร้างการดำเนินการที่สร้างลิงก์สัญลักษณ์นี้ Bazel จะไม่ยกเลิกการอ้างอิงลิงก์สัญลักษณ์นี้และจะโอนไปยังแซนด์บ็อกซ์หรือผู้ดำเนินการระยะไกลโดยถอดเสียง
พารามิเตอร์
พารามิเตอร์ | คำอธิบาย |
---|---|
filename
|
ต้องระบุ หากไม่ได้ระบุ "sibling" เส้นทางของลิงก์สัญลักษณ์ใหม่ซึ่งสัมพันธ์กับแพ็กเกจปัจจุบัน หรือจะเป็นชื่อฐานของไฟล์ก็ได้ ('sibling' จะกำหนดไดเรกทอรี) |
sibling
|
File; or None ;
default = Noneเป็นไฟล์ที่อยู่ในไดเรกทอรีเดียวกับสัญลักษณ์ลิงก์ที่ประกาศใหม่ |
do_nothing
None actions.do_nothing(mnemonic, inputs=[])สร้างการดำเนินการที่ว่างเปล่าซึ่งไม่เรียกใช้คำสั่งหรือสร้างเอาต์พุตใดๆ แต่มีประโยชน์สำหรับการแทรก "การดำเนินการเพิ่มเติม"
พารามิเตอร์
พารามิเตอร์ | คำอธิบาย |
---|---|
mnemonic
|
ต้องระบุ คําอธิบายการดําเนินการแบบ 1 คํา เช่น CppCompile หรือ GoLink |
inputs
|
sequence of Files; or depset ;
default = []รายการไฟล์อินพุตของการดำเนินการ |
expand_template
None actions.expand_template(template, output, substitutions={}, is_executable=False, computed_substitutions=unbound)สร้างการดําเนินการขยายเทมเพลต เมื่อดำเนินการแล้ว ระบบจะสร้างไฟล์ตามเทมเพลต ระบบจะแทนที่บางส่วนของเทมเพลตโดยใช้พจนานุกรม
substitutions
ตามลำดับที่ระบุการแทนที่ เมื่อใดก็ตามที่คีย์ของพจนานุกรมปรากฏในเทมเพลต (หรือเป็นผลมาจากการแทนที่ก่อนหน้านี้) ระบบจะแทนที่คีย์ด้วยค่าที่เกี่ยวข้อง คีย์ไม่มีไวยากรณ์พิเศษ เช่น คุณอาจใช้วงเล็บปีกกาเพื่อหลีกเลี่ยงข้อขัดแย้ง (เช่น {KEY}
) ดูตัวอย่างการใช้งาน
พารามิเตอร์
พารามิเตอร์ | คำอธิบาย |
---|---|
template
|
ต้องระบุ ไฟล์เทมเพลต ซึ่งเป็นไฟล์ข้อความที่เข้ารหัส UTF-8 |
output
|
ต้องระบุ ซึ่งเป็นไฟล์เอาต์พุตที่เป็นไฟล์ข้อความที่เข้ารหัส UTF-8 |
substitutions
|
default = {} การแทนที่ที่จะทำเมื่อขยายเทมเพลต |
is_executable
|
default = False กำหนดว่าไฟล์เอาต์พุตควรเป็นแบบเรียกใช้ได้หรือไม่ |
computed_substitutions
|
TemplateDict ;
default = unboundทดลอง พารามิเตอร์นี้ยังอยู่ในขั้นทดลองและอาจมีการเปลี่ยนแปลงได้ทุกเมื่อ โปรดอย่าใช้ข้อมูลนี้ คุณอาจเปิดใช้การตั้งค่านี้ในขั้นทดลองได้โดยการตั้งค่า --+experimental_lazy_template_expansion ทดลอง: การเปลี่ยนทดแทนที่จะทำเมื่อขยายเทมเพลต |
โฮมรัน
None actions.run(outputs, inputs=[], unused_inputs_list=None, executable, tools=unbound, arguments=[], mnemonic=None, progress_message=None, use_default_shell_env=False, env=None, execution_requirements=None, input_manifests=None, exec_group=None, shadowed_action=None, resource_set=None, toolchain=None)สร้างการดำเนินการที่เรียกใช้ไฟล์ปฏิบัติการ ดูตัวอย่างการใช้งาน
พารามิเตอร์
พารามิเตอร์ | คำอธิบาย |
---|---|
outputs
|
sequence of Files ;
ต้องระบุชื่อไฟล์เอาต์พุตของการดำเนินการ |
inputs
|
sequence of Files; or depset ;
default = []List or depset of the input files of the action. |
unused_inputs_list
|
File; or None ;
default = Noneไฟล์ที่มีรายการอินพุตที่การดำเนินการไม่ได้ใช้ เนื้อหาของไฟล์นี้ (โดยทั่วไปคือเอาต์พุตรายการใดรายการหนึ่งของการดำเนินการ) สอดคล้องกับรายการไฟล์อินพุตที่ไม่ได้ใช้ในระหว่างการดำเนินการทั้งหมด การเปลี่ยนแปลงในไฟล์เหล่านั้นต้องไม่ส่งผลต่อเอาต์พุตของการดำเนินการไม่ว่าในทางใดก็ตาม |
executable
|
File; or string; or FilesToRunProvider ;
ต้องระบุชื่อไฟล์ที่เรียกใช้ได้ซึ่งการดำเนินการจะเรียกใช้ |
tools
|
sequence; or depset ;
default = unboundList or depset of any tools needed by the action. เครื่องมือคืออินพุตที่มีไฟล์เรียกใช้เพิ่มเติมซึ่งพร้อมใช้งานสําหรับการดำเนินการโดยอัตโนมัติ เมื่อระบุรายการ รายการดังกล่าวอาจเป็นคอลเล็กชันไฟล์ที่หลากหลาย อินสแตนซ์ FilesToRunProvider หรือชุด Dep ของไฟล์ ระบบจะเพิ่มไฟล์รันไทม์ของไฟล์ที่อยู่ในรายการโดยตรงและมาจาก ctx.executable โดยอัตโนมัติ เมื่อระบุชุดข้อมูล จะต้องมีเฉพาะไฟล์เท่านั้น ในทั้ง 2 กรณี ระบบจะไม่ตรวจสอบไฟล์ภายใน depset กับ ctx.executable สำหรับไฟล์รันไทม์ |
arguments
|
sequence ;
default = []Command line arguments of the action. ต้องเป็นรายการสตริงหรือออบเจ็กต์ actions.args()
|
mnemonic
|
string; or None ;
default = Noneคำอธิบายการดำเนินการแบบ 1 คำ เช่น CppCompile หรือ GoLink |
progress_message
|
string; or None ;
default = Noneข้อความแสดงสถานะที่จะแสดงต่อผู้ใช้ระหว่างการบิลด์ เช่น "กำลังคอมไพล์ foo.cc เพื่อสร้าง foo.o" ข้อความอาจมีรูปแบบ %{label} , %{input} หรือ %{output} ซึ่งระบบจะแทนที่ด้วยสตริงป้ายกำกับ อินพุตแรก หรือเส้นทางเอาต์พุตตามลำดับ แนะนำให้ใช้รูปแบบแทนสตริงแบบคงที่ เนื่องจากรูปแบบมีประสิทธิภาพมากกว่า
|
use_default_shell_env
|
default = False การดำเนินการควรใช้สภาพแวดล้อมเชลล์ในตัวหรือไม่ |
env
|
dict; or None ;
default = Noneกําหนดพจนานุกรมของตัวแปรสภาพแวดล้อม |
execution_requirements
|
dict; or None ;
default = Noneข้อมูลสำหรับการตั้งเวลาการดำเนินการ ดูคีย์ที่มีประโยชน์ในแท็ก |
input_manifests
|
sequence; or None ;
default = None(ทดลอง) ตั้งค่าข้อมูลเมตาของไฟล์รันไทม์อินพุต ซึ่งโดยปกติแล้วระบบจะสร้างจาก resolve_command |
exec_group
|
string; or None ;
default = Noneเรียกใช้การดำเนินการบนแพลตฟอร์มการดำเนินการของกลุ่ม exec ที่ระบุ หากไม่มี จะใช้แพลตฟอร์มการเรียกใช้เริ่มต้นของเป้าหมาย |
shadowed_action
|
Action ;
default = Noneเรียกใช้การดำเนินการโดยใช้อินพุตและสภาพแวดล้อมของการดำเนินการที่ซ้อนทับซึ่งระบุไว้ซึ่งเพิ่มลงในรายการอินพุตและสภาพแวดล้อมของการดำเนินการ สภาพแวดล้อมการดําเนินการสามารถเขียนทับตัวแปรสภาพแวดล้อมของการดําเนินการที่ซ้อนทับได้ หากไม่มี ให้ใช้เฉพาะอินพุตของการดำเนินการและสภาพแวดล้อมที่ระบุ |
resource_set
|
callable; or None ;
default = Noneฟังก์ชันการเรียกกลับที่แสดงพจนานุกรมชุดทรัพยากร ซึ่งใช้เพื่อประมาณการใช้ทรัพยากร ณ เวลาดำเนินการหากการดำเนินการนี้ทำงานในเครื่อง ฟังก์ชันนี้ยอมรับอาร์กิวเมนต์ตำแหน่ง 2 รายการ ได้แก่ สตริงที่แสดงชื่อระบบปฏิบัติการ (เช่น "osx") และจำนวนเต็มซึ่งแสดงจํานวนอินพุตสําหรับการดําเนินการ พจนานุกรมที่แสดงผลอาจมีรายการต่อไปนี้ ซึ่งแต่ละรายการอาจเป็น float หรือ int
หากตั้งค่าพารามิเตอร์นี้เป็น ฟังก์ชัน Callback ต้องเป็นระดับบนสุด (ไม่อนุญาตให้ใช้ฟังก์ชัน LAMBDA และฟังก์ชันที่ฝัง) |
toolchain
|
Label; or string; or None ;
default = Noneประเภท Toolchain ของไฟล์ปฏิบัติการหรือเครื่องมือที่ใช้ในการดำเนินการนี้ คุณต้องตั้งค่าพารามิเตอร์เพื่อให้การดำเนินการทํางานบนแพลตฟอร์มการดําเนินการที่ถูกต้อง ปัจจุบันค่านี้ไม่มีผล แต่เราขอแนะนำให้ตั้งค่าเมื่อใช้ชุดเครื่องมือ เนื่องจากจะต้องใช้ค่านี้ในรุ่น Bazel ในอนาคต โปรดทราบว่ากฎที่สร้างการดำเนินการนี้ต้องกำหนดเครื่องมือนี้ภายในฟังก์ชัน "rule()" เมื่อตั้งค่าทั้งพารามิเตอร์ `toolchain` และ `exec_group` ระบบจะใช้ `exec_group` ระบบจะแสดงข้อผิดพลาดในกรณีที่ `exec_group` ไม่ได้ระบุค่าเดียวกัน |
run_shell
None actions.run_shell(outputs, inputs=[], tools=unbound, arguments=[], mnemonic=None, command, progress_message=None, use_default_shell_env=False, env=None, execution_requirements=None, input_manifests=None, exec_group=None, shadowed_action=None, resource_set=None, toolchain=None)สร้างการดำเนินการที่เรียกใช้คำสั่ง Shell ดูตัวอย่างการใช้งาน
พารามิเตอร์
พารามิเตอร์ | คำอธิบาย |
---|---|
outputs
|
sequence of Files ;
ต้องระบุชื่อไฟล์เอาต์พุตของการดำเนินการ |
inputs
|
sequence of Files; or depset ;
default = []List or depset of the input files of the action. |
tools
|
sequence of Files; or depset ;
default = unboundList or depset of any tools needed by the action. เครื่องมือคืออินพุตที่มีไฟล์เรียกใช้เพิ่มเติมซึ่งพร้อมใช้งานสําหรับการดำเนินการโดยอัตโนมัติ รายการอาจมีอินสแตนซ์ Files หรือ FilesToRunProvider |
arguments
|
sequence ;
default = []Command line arguments of the action. ต้องเป็นรายการสตริงหรือออบเจ็กต์ actions.args() Bazel จะส่งองค์ประกอบในแอตทริบิวต์นี้เป็นอาร์กิวเมนต์ไปยังคําสั่ง คําสั่งจะเข้าถึงอาร์กิวเมนต์เหล่านี้ได้โดยใช้การแทนที่ตัวแปรเชลล์ เช่น ในกรณีที่ |
mnemonic
|
string; or None ;
default = Noneคำอธิบายการดำเนินการแบบ 1 คำ เช่น CppCompile หรือ GoLink |
command
|
string; or sequence of strings ;
ต้องระบุคําสั่ง Shell ที่จะเรียกใช้ ซึ่งอาจเป็นสตริง (แนะนำ) หรือลำดับสตริง (เลิกใช้งานแล้ว) หาก (เลิกใช้งานแล้ว) หาก Bazel ใช้เชลล์เดียวกันเพื่อเรียกใช้คำสั่งเช่นเดียวกับที่ใช้สำหรับ genrules |
progress_message
|
string; or None ;
default = Noneข้อความแสดงสถานะที่จะแสดงต่อผู้ใช้ระหว่างการบิลด์ เช่น "กำลังคอมไพล์ foo.cc เพื่อสร้าง foo.o" ข้อความอาจมีรูปแบบ %{label} , %{input} หรือ %{output} ซึ่งระบบจะแทนที่ด้วยสตริงป้ายกำกับ อินพุตแรก หรือเส้นทางเอาต์พุตตามลำดับ แนะนำให้ใช้รูปแบบแทนสตริงแบบคงที่ เนื่องจากรูปแบบมีประสิทธิภาพมากกว่า
|
use_default_shell_env
|
default = False การดำเนินการควรใช้สภาพแวดล้อมเชลล์ในตัวหรือไม่ |
env
|
dict; or None ;
default = Noneกําหนดพจนานุกรมของตัวแปรสภาพแวดล้อม |
execution_requirements
|
dict; or None ;
default = Noneข้อมูลสำหรับการตั้งเวลาการดำเนินการ ดูคีย์ที่มีประโยชน์ในแท็ก |
input_manifests
|
sequence; or None ;
default = None(ทดลอง) ตั้งค่าข้อมูลเมตาของไฟล์รันไทม์อินพุต ซึ่งโดยปกติแล้วระบบจะสร้างจาก resolve_command |
exec_group
|
string; or None ;
default = Noneเรียกใช้การดำเนินการบนแพลตฟอร์มการดำเนินการของกลุ่ม exec ที่ระบุ หากไม่มี จะใช้แพลตฟอร์มการเรียกใช้เริ่มต้นของเป้าหมาย |
shadowed_action
|
Action ;
default = Noneเรียกใช้การดำเนินการโดยใช้อินพุตที่ค้นพบของการดำเนินการที่ซ้อนทับซึ่งระบุไว้ซึ่งเพิ่มลงในรายการอินพุตของการดำเนินการ หากไม่มี ให้ใช้เฉพาะอินพุตของการดำเนินการ |
resource_set
|
callable; or None ;
default = Noneฟังก์ชันการเรียกกลับสำหรับการประมาณการใช้ทรัพยากรหากเรียกใช้ในพื้นที่ โปรดดู ctx.actions.run()
|
toolchain
|
Label; or string; or None ;
default = Noneประเภท Toolchain ของไฟล์ปฏิบัติการหรือเครื่องมือที่ใช้ในการดำเนินการนี้ คุณต้องตั้งค่าพารามิเตอร์เพื่อให้การดำเนินการทํางานบนแพลตฟอร์มการดําเนินการที่ถูกต้อง ปัจจุบันค่านี้ไม่มีผล แต่เราขอแนะนำให้ตั้งค่าเมื่อใช้ชุดเครื่องมือ เนื่องจากจะต้องใช้ค่านี้ในรุ่น Bazel ในอนาคต โปรดทราบว่ากฎที่สร้างการดำเนินการนี้ต้องกำหนดเครื่องมือนี้ภายในฟังก์ชัน "rule()" เมื่อตั้งค่าทั้งพารามิเตอร์ `toolchain` และ `exec_group` ระบบจะใช้ `exec_group` ระบบจะแสดงข้อผิดพลาดในกรณีที่ `exec_group` ไม่ได้ระบุเครื่องมือชุดเดียวกัน |
ลิงก์สัญลักษณ์
None actions.symlink(output, target_file=None, target_path=None, is_executable=False, progress_message=None)สร้างการดำเนินการที่จะเขียนลิงก์สัญลักษณ์ (symlink) ในระบบไฟล์
ฟังก์ชันนี้ต้องเรียกโดยระบุ target_file
หรือ target_path
เพียงอย่างใดอย่างหนึ่ง
เมื่อใช้ target_file
ให้ประกาศ output
ด้วย declare_file()
หรือ declare_directory()
และจับคู่กับประเภทของ target_file
ซึ่งจะทำให้ลิงก์สัญลักษณ์ชี้ไปยัง target_file
Bazel จะลบล้างเอาต์พุตของการดำเนินการนี้ทุกครั้งที่มีการเปลี่ยนแปลงเป้าหมายของลิงก์สัญลักษณ์หรือเนื้อหาของลิงก์สัญลักษณ์
หรือเมื่อใช้ target_path
ให้ประกาศ output
ด้วย declare_symlink()
) ในกรณีนี้ สัญลักษณ์ลิงก์จะชี้ไปยัง target_path
Bazel จะไม่แก้ไขลิงก์สัญลักษณ์ และเอาต์พุตของการดำเนินการนี้จะใช้งานไม่ได้ก็ต่อเมื่อเนื้อหาข้อความของลิงก์สัญลักษณ์ (นั่นคือค่าของ readlink()
) เปลี่ยนแปลงเท่านั้น โดยเฉพาะอย่างยิ่ง สามารถใช้คำสั่งนี้เพื่อสร้างลิงก์สัญลักษณ์ที่ไม่มีการอ้างอิง
พารามิเตอร์
พารามิเตอร์ | คำอธิบาย |
---|---|
output
|
required เอาต์พุตของการดำเนินการนี้ |
target_file
|
File; or None ;
default = Noneไฟล์ที่ลิงก์สัญลักษณ์เอาต์พุตจะชี้ไป |
target_path
|
string; or None ;
default = None(ทดลอง) เส้นทางที่แน่นอนซึ่งลิงก์สัญลักษณ์เอาต์พุตจะชี้ไป โดยไม่มีการทำให้เป็นมาตรฐานหรือการประมวลผลอื่นๆ คุณต้องตั้งค่า --experimental_allow_unresolved_symlinks เพื่อเข้าถึงฟีเจอร์นี้
|
is_executable
|
default = False ใช้กับ target_file ได้เท่านั้น จะใช้กับ target_path ไม่ได้ หากเป็น "จริง" เมื่อดำเนินการ ระบบจะตรวจสอบเส้นทางของ target_file เพื่อยืนยันว่าสามารถเรียกใช้ได้ และจะรายงานข้อผิดพลาดหากเรียกใช้ไม่ได้ การตั้งค่า is_executable เป็น False ไม่ได้หมายความว่าเป้าหมายจะไม่สามารถเรียกใช้ได้ เพียงแต่ไม่มีการยืนยันเท่านั้นฟีเจอร์นี้ไม่เหมาะกับ |
progress_message
|
string; or None ;
default = Noneข้อความแสดงสถานะความคืบหน้าที่จะแสดงต่อผู้ใช้ระหว่างการสร้าง |
template_dict
TemplateDict actions.template_dict()ทดลอง API นี้ยังอยู่ในขั้นทดลองและอาจมีการเปลี่ยนแปลงได้ทุกเมื่อ โปรดอย่าใช้ข้อมูลนี้ คุณอาจเปิดใช้เป็นการทดลองได้โดยการตั้งค่า
--+experimental_lazy_template_expansion
ทดลอง: แสดงผลออบเจ็กต์ TemplateDict สำหรับการขยายเทมเพลตที่ประหยัดหน่วยความจำ
เขียน
None actions.write(output, content, is_executable=False)สร้างการดำเนินการเขียนไฟล์ เมื่อดำเนินการแล้ว ระบบจะเขียนเนื้อหาที่ระบุลงในไฟล์ ซึ่งจะใช้ในการสร้างไฟล์โดยใช้ข้อมูลที่มีอยู่ในขั้นตอนการวิเคราะห์ หากไฟล์มีขนาดใหญ่และมีเนื้อหาแบบคงที่จำนวนมาก ให้ลองใช้
expand_template
พารามิเตอร์
พารามิเตอร์ | คำอธิบาย |
---|---|
output
|
ต้องระบุ ไฟล์เอาต์พุต |
content
|
string; or Args ;
ต้องระบุเนื้อหาของไฟล์ อาจเป็นสตริงหรือออบเจ็กต์ actions.args()
|
is_executable
|
default = False กำหนดว่าไฟล์เอาต์พุตควรเป็นแบบเรียกใช้ได้หรือไม่ |