อาร์กส์

รายงานปัญหา ดูแหล่งที่มา ตอนกลางคืน · 7.3 · 7.2 · 7.1 · 7.0 · 6.5

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

การดำเนินการมักต้องใช้บรรทัดคำสั่งขนาดใหญ่ซึ่งมีค่าที่รวบรวมจาก transitive dependencies เช่น บรรทัดคำสั่ง Linker อาจแสดงไฟล์ออบเจ็กต์ทุกรายการที่ไลบรารีทั้งหมดที่ลิงก์จำเป็นต้องใช้ แนวทางปฏิบัติแนะนำคือจัดเก็บข้อมูลที่ส่งผ่านดังกล่าวใน depset เพื่อให้เป้าหมายหลายรายการแชร์ข้อมูลได้ อย่างไรก็ตาม หากผู้เขียนกฎต้องแปลงชุดข้อมูลเหล่านี้เป็นรายการสตริงเพื่อสร้างบรรทัดคำสั่งการดำเนินการ ก็จะเป็นการทำลายการเพิ่มประสิทธิภาพการแชร์หน่วยความจำนี้

ด้วยเหตุนี้ ฟังก์ชันสร้างการดำเนินการจึงยอมรับออบเจ็กต์ Args นอกเหนือจากสตริง ออบเจ็กต์ Args แต่ละรายการแสดงการต่อสตริงและ Depset เข้าด้วยกัน โดยมีการเปลี่ยนรูปแบบที่ไม่บังคับสำหรับการจัดการข้อมูล ออบเจ็กต์ Args จะไม่ประมวลผลชุดข้อมูล Dependency ที่ออบเจ็กต์นั้นรวมไว้จนกว่าจะถึงระยะการดําเนินการเมื่อถึงเวลาคํานวณบรรทัดคําสั่ง ซึ่งจะช่วยเลื่อนเวลาการคัดลอกที่มีราคาแพงไปจนกว่าช่วงการวิเคราะห์จะเสร็จสมบูรณ์ ดูข้อมูลเพิ่มเติมได้ที่หน้าการเพิ่มประสิทธิภาพ

Args สร้างขึ้นโดยการเรียก ctx.actions.args() โดยสามารถส่งเป็นพารามิเตอร์ arguments ของ ctx.actions.run() หรือ ctx.actions.run_shell() การเปลี่ยนรูปแบบแต่ละรายการของออบเจ็กต์ Args จะเพิ่มค่าต่อท้ายบรรทัดคำสั่ง

ฟีเจอร์ map_each ช่วยให้คุณปรับแต่งวิธีเปลี่ยนรูปแบบรายการเป็นสตริงได้ หากคุณไม่ได้ระบุฟังก์ชัน map_each การแปลงมาตรฐานจะเป็นดังนี้

  • ค่าที่เป็นสตริงอยู่แล้วจะยังคงเดิม
  • ออบเจ็กต์ File จะเปลี่ยนเป็นค่า File.path
  • ส่วนประเภทอื่นๆ ทั้งหมดจะเปลี่ยนเป็นสตริงในลักษณะที่ไม่ระบุ ด้วยเหตุนี้ คุณจึงควรหลีกเลี่ยงการส่งค่าที่ไม่ใช่สตริงหรือประเภท File ไปยัง add() และหากคุณส่งไปยัง add_all() หรือ add_joined() คุณควรระบุฟังก์ชัน map_each

เมื่อใช้การจัดรูปแบบสตริง (พารามิเตอร์ format, format_each และ format_joined ของเมธอด add*()) ระบบจะตีความเทมเพลตรูปแบบในลักษณะเดียวกับการแทนที่ % ในสตริง ยกเว้นว่าเทมเพลตต้องมีตัวยึดตําแหน่งการแทนที่เพียงรายการเดียวและต้องเป็นตัวยึดตําแหน่ง %s เปอร์เซ็นต์จริงอาจกำหนดเป็น %% ได้ ใช้การจัดรูปแบบหลังจากแปลงค่าเป็นสตริงตามวิธีข้างต้นแล้ว

เมธอด add*() แต่ละรายการมีรูปแบบอื่นที่ยอมรับพารามิเตอร์ตำแหน่งเพิ่มเติม ซึ่งเป็นสตริง "ชื่ออาร์กิวเมนต์" เพื่อแทรกไว้ก่อนอาร์กิวเมนต์ที่เหลือ สำหรับ add_all และ add_joined ระบบจะไม่เพิ่มสตริงอื่นๆ หากลำดับว่างเปล่า ตัวอย่างเช่น การใช้งานเดียวกันนี้อาจเพิ่ม --foo val1 val2 val3 --bar หรือเพียง --bar ลงในบรรทัดคำสั่ง โดยขึ้นอยู่กับว่าลำดับที่ระบุมี val1..val3 หรือว่างเปล่า

หากขนาดของบรรทัดคำสั่งขยายเกินขนาดสูงสุดที่ระบบอนุญาต อาจใส่อาร์กิวเมนต์ลงในไฟล์พารามิเตอร์ได้ โปรดดู use_param_file() และ set_param_file_format()

ตัวอย่าง: สมมติว่าเราต้องการสร้างบรรทัดคำสั่ง: 

--foo foo1.txt foo2.txt ... fooN.txt --bar bar1.txt,bar2.txt,...,barM.txt --baz
เราใช้ออบเจ็กต์ Args ต่อไปนี้ได้ 
# foo_deps and bar_deps are depsets containing
# File objects for the foo and bar .txt files.
args = ctx.actions.args()
args.add_all("--foo", foo_deps)
args.add_joined("--bar", bar_deps, join_with=",")
args.add("--baz")
ctx.actions.run(
  ...
  arguments = [args],
  ...
)

สมาชิก

เพิ่ม

Args Args.add(arg_name_or_value, value=unbound, *, format=None)

เพิ่มอาร์กิวเมนต์ในบรรทัดคำสั่งนี้

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
arg_name_or_value required
หากมีการส่งพารามิเตอร์ตำแหน่ง 2 รายการ ระบบจะตีความค่านี้เป็นชื่ออาร์กิวเมนต์ เพิ่มชื่ออาร์กิวเมนต์ไว้หน้าค่าโดยไม่มีการประมวลผลใดๆ หากส่งพารามิเตอร์ตำแหน่งเพียงรายการเดียว ระบบจะตีความเป็น value (ดูด้านล่าง)
value ค่าเริ่มต้นคือ unbound
ออบเจ็กต์ที่จะเพิ่มต่อท้าย ระบบจะแปลงเป็นสตริงโดยใช้การแปลงมาตรฐานที่กล่าวถึงข้างต้น เนื่องจากไม่มีพารามิเตอร์ map_each สําหรับฟังก์ชันนี้ value จึงควรเป็นสตริงหรือ File ต้องส่งรายการ, tuple, Depset หรือไดเรกทอรี File ไปยัง add_all() หรือ add_joined() แทนวิธีการนี้
format string; หรือ None; ค่าเริ่มต้นคือ None
รูปแบบสตริงรูปแบบ ที่จะใช้กับ value เวอร์ชันสตริง

add_all

Args Args.add_all(arg_name_or_values, values=unbound, *, map_each=None, format_each=None, before_each=None, omit_if_empty=True, uniquify=False, expand_directories=True, terminate_with=None, allow_closure=False)

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

การประมวลผลส่วนใหญ่จะเกิดขึ้นกับรายการอาร์กิวเมนต์ที่จะต่อท้าย ตามขั้นตอนต่อไปนี้

  1. รายการ File แต่ละรายการในไดเรกทอรีจะแทนที่ด้วย File ทั้งหมดที่อยู่ในไดเรกทอรีนั้นแบบซ้ำ
  2. หากระบุ map_each ระบบจะใช้กับแต่ละรายการ และต่อสตริงที่เป็นผลลัพธ์เข้าด้วยกันเพื่อสร้างรายการอาร์กิวเมนต์เริ่มต้น มิฉะนั้น รายการอาร์กิวเมนต์เริ่มต้นจะเป็นผลลัพธ์จากการใช้การเปลี่ยนรูปแบบมาตรฐานกับแต่ละรายการ
  3. อาร์กิวเมนต์แต่ละรายการในรายการจะอยู่ในรูปแบบ format_each หากมี
  4. หาก uniquify เป็นจริง ระบบจะนำอาร์กิวเมนต์ที่ซ้ำกันออก ครั้งแรกคือครั้งนั้นที่เหลืออยู่
  5. หากระบุสตริง before_each ระบบจะแทรกสตริงดังกล่าวเป็นอาร์กิวเมนต์ใหม่ก่อนอาร์กิวเมนต์ที่มีอยู่แต่ละรายการในรายการ ซึ่งจะช่วยเพิ่มจำนวนอาร์กิวเมนต์ที่จะเพิ่มเข้ามาด้วยจุดนี้ได้อย่างมีประสิทธิภาพ
  6. ยกเว้นในกรณีที่ลิสต์ว่างและ omit_if_empty เป็นจริง (ค่าเริ่มต้น) ระบบจะแทรกชื่ออาร์กิวเมนต์และ terminate_with เป็นอาร์กิวเมนต์แรกและสุดท้ายตามลำดับ หากระบุไว้
โปรดทราบว่าสตริงว่างเป็นอาร์กิวเมนต์ที่ถูกต้อง ซึ่งต้องปฏิบัติตามขั้นตอนการประมวลผลเหล่านี้ทั้งหมด

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
arg_name_or_values required
หากมีการส่งพารามิเตอร์ตำแหน่ง 2 รายการ ระบบจะตีความค่านี้เป็นชื่ออาร์กิวเมนต์ ระบบจะเพิ่มชื่ออาร์กิวเมนต์ไว้หน้า values เป็นอาร์กิวเมนต์แยกต่างหากโดยไม่มีการประมวลผล ระบบจะไม่เพิ่มชื่ออาร์กิวเมนต์นี้หาก omit_if_empty เป็นจริง (ค่าเริ่มต้น) และไม่มีรายการอื่นๆ ต่อท้าย (ซึ่งจะเกิดขึ้นหาก values ว่างเปล่าหรือมีตัวกรองรายการทั้งหมด) หากส่งพารามิเตอร์ตำแหน่งเพียงรายการเดียว ระบบจะตีความเป็น values (ดูด้านล่าง)
values sequence หรือ depset ค่าเริ่มต้นคือ unbound
รายการ, tup หรือ depset ที่จะมีรายการต่อท้าย
map_each callable; หรือ None; ค่าเริ่มต้นคือ None
ฟังก์ชันที่แปลงแต่ละรายการเป็นสตริงตั้งแต่ 0 รายการขึ้นไป ซึ่งอาจประมวลผลเพิ่มเติมก่อนต่อท้าย หากไม่ได้ระบุพารามิเตอร์นี้ ระบบจะใช้ Conversion มาตรฐาน

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

ประเภทของผลลัพธ์จะขึ้นอยู่กับจำนวนอาร์กิวเมนต์ที่จะสร้างสำหรับรายการ ดังนี้

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

โดยปกติแล้ว รายการที่เป็นไดเรกทอรีจะขยายไปยังเนื้อหาโดยอัตโนมัติเมื่อตั้งค่า expand_directories=True อย่างไรก็ตาม การดำเนินการนี้จะไม่ขยายไดเรกทอรีที่อยู่ภายในค่าอื่นๆ เช่น เมื่อรายการเป็นสตรูคเจอร์ที่มีไดเรกทอรีเป็นช่อง ในกรณีนี้ คุณจะใช้อาร์กิวเมนต์ DirectoryExpander เพื่อรับไฟล์ของไดเรกทอรีที่ระบุด้วยตนเองได้

คุณต้องประกาศฟังก์ชัน map_each ด้วยคำสั่ง def ระดับบนสุดเพื่อหลีกเลี่ยงการเก็บโครงสร้างข้อมูลขนาดใหญ่ในระยะการวิเคราะห์ไว้ในระยะการดําเนินการโดยไม่ตั้งใจ โดยฟังก์ชันดังกล่าวต้องไม่ใช่การปิดฟังก์ชันที่ฝังอยู่โดยค่าเริ่มต้น

คำเตือน: คำสั่ง print() ที่ดำเนินการระหว่างการเรียก map_each จะไม่แสดงเอาต์พุตใดๆ

format_each string; หรือ None; ค่าเริ่มต้นคือ None
รูปแบบสตริงที่ไม่บังคับ ใช้กับแต่ละสตริงที่ฟังก์ชัน map_each แสดงผล สตริงรูปแบบต้องมี "%s" 1 รายการ ตัวยึดตําแหน่ง
before_each string; หรือ None; ค่าเริ่มต้นคือ None
อาร์กิวเมนต์ที่ไม่บังคับใส่ต่อท้ายแต่ละอาร์กิวเมนต์ที่ได้มาจาก values ต่อท้าย
omit_if_empty ค่าเริ่มต้นคือ True
หากเป็นจริง หากไม่มีอาร์กิวเมนต์ที่ได้มาจาก values เพื่อต่อท้าย การประมวลผลเพิ่มเติมทั้งหมดจะถูกระงับและบรรทัดคำสั่งจะไม่มีการเปลี่ยนแปลง หากเป็นเท็จ ระบบจะยังคงใส่ชื่ออาร์กิวเมนต์และ terminate_with ต่อท้าย (หากระบุไว้) ไม่ว่าจะมีอาร์กิวเมนต์อื่นๆ หรือไม่ก็ตาม
uniquify ค่าเริ่มต้นคือ False
หากเป็น "จริง" ระบบจะไม่รวมอาร์กิวเมนต์ที่ซ้ำกันซึ่งมาจาก values เฉพาะการเกิดอาร์กิวเมนต์แรกของแต่ละอาร์กิวเมนต์เท่านั้นที่จะยังคงอยู่ โดยปกติแล้วไม่จำเป็นต้องใช้ฟีเจอร์นี้เนื่องจากชุดข้อมูลจะละเว้นรายการที่ซ้ำกันอยู่แล้ว แต่อาจมีประโยชน์หาก map_each ส่งออกสตริงเดียวกันสำหรับหลายรายการ
expand_directories ค่าเริ่มต้นคือ True
หากเป็น "จริง" ระบบจะขยายไดเรกทอรีใน values เป็นรายการไฟล์แบบแบน ซึ่งจะเกิดขึ้นก่อนที่จะมีการใช้ map_each
terminate_with string; หรือ None; ค่าเริ่มต้นคือ None
อาร์กิวเมนต์ที่ไม่บังคับต่อท้ายอาร์กิวเมนต์อื่นๆ ทั้งหมด ระบบจะไม่เพิ่มอาร์กิวเมนต์นี้หาก omit_if_empty เป็นจริง (ค่าเริ่มต้น) และไม่มีรายการอื่นๆ ต่อท้าย (เช่น กรณีที่ values ว่างเปล่าหรือมีการกรองรายการทั้งหมด)
allow_closure ค่าเริ่มต้นคือ False
หากเป็น "จริง" อนุญาตให้ใช้การปิดในพารามิเตอร์ฟังก์ชัน เช่น map_each ขั้นตอนเหล่านี้มักไม่จำเป็นและเสี่ยงต่อการรักษาโครงสร้างข้อมูลระยะการวิเคราะห์ขนาดใหญ่ไว้ในระยะการดำเนินการ

add_joined

Args Args.add_joined(arg_name_or_values, values=unbound, *, join_with, map_each=None, format_each=None, format_joined=None, omit_if_empty=True, uniquify=False, expand_directories=True, allow_closure=False)

ต่ออาร์กิวเมนต์ต่อท้ายบรรทัดคำสั่งนี้โดยการต่อค่าหลายค่าเข้าด้วยกันโดยใช้ตัวคั่น ระบบจะประมวลผลรายการแบบล่าช้าในระหว่างระยะการดําเนินการ

การประมวลผลจะคล้ายกับ add_all() แต่ระบบจะรวมรายการอาร์กิวเมนต์ที่มาจาก values เข้าด้วยกันเป็นอาร์กิวเมนต์เดียวเหมือนกับใช้ join_with.join(...) จากนั้นจึงจัดรูปแบบโดยใช้เทมเพลตสตริง format_joined ที่ระบุ ซึ่งต่างจาก add_all() ตรงที่ไม่มีพารามิเตอร์ before_each หรือ terminate_with เนื่องจากพารามิเตอร์เหล่านี้ไม่มีประโยชน์โดยทั่วไปเมื่อมีการรวมรายการเป็นอาร์กิวเมนต์เดียว

หากหลังจากการกรองไม่มีสตริงให้ผนวกในอาร์กิวเมนต์ และหาก omit_if_empty เป็น True (ค่าเริ่มต้น) ก็จะไม่มีการประมวลผล มิเช่นนั้น หากไม่มีสตริงที่เข้าร่วม แต่ omit_if_empty เป็นเท็จ สตริงที่เข้าร่วมจะเป็นสตริงว่าง

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
arg_name_or_values required
หากมีการส่งพารามิเตอร์ตำแหน่ง 2 รายการ ระบบจะตีความค่านี้เป็นชื่ออาร์กิวเมนต์ เพิ่มชื่ออาร์กิวเมนต์ก่อน values โดยไม่มีการประมวลผลใดๆ ระบบจะไม่เพิ่มอาร์กิวเมนต์นี้หาก omit_if_empty เป็นจริง (ค่าเริ่มต้น) และไม่มีสตริงที่มาจาก values เพื่อนำมารวมกัน (ซึ่งอาจเกิดขึ้นหาก values ว่างเปล่าหรือมีตัวกรองรายการทั้งหมด) หากส่งพารามิเตอร์ตำแหน่งเพียงรายการเดียว ระบบจะตีความเป็น values (ดูด้านล่าง)
values sequence; หรือ depset ค่าเริ่มต้นคือ unbound
รายการ Tuple หรือ Depset ที่ระบบจะผนวกรายการ
join_with ต้องระบุ
สตริงตัวคั่นที่ใช้รวมสตริงที่ได้รับจากการใช้ map_each และ format_each เข้าด้วยกันในลักษณะเดียวกับ string.join()
map_each callable; หรือ None; ค่าเริ่มต้นคือ None
ซึ่งเหมือนกับของ add_all
format_each string; หรือ None; ค่าเริ่มต้นคือ None
เช่นเดียวกับ add_all
format_joined string; หรือ None; ค่าเริ่มต้นคือ None
รูปแบบสตริงรูปแบบที่ไม่บังคับใช้กับสตริงที่รวม สตริงรูปแบบต้องมี "%s" 1 รายการ ตัวยึดตําแหน่ง
omit_if_empty ค่าเริ่มต้นคือ True
หากเป็นจริง หากไม่มีสตริงที่จะผูกเข้าด้วยกัน (เนื่องจาก values ว่างเปล่าหรือมีการกรองรายการทั้งหมด) การประมวลผลเพิ่มเติมทั้งหมดจะถูกระงับและบรรทัดคำสั่งจะไม่มีการเปลี่ยนแปลง หากเป็น "เท็จ" แม้ว่าจะไม่มีสตริงที่เชื่อมเข้าด้วยกัน จะมีการเพิ่มอาร์กิวเมนต์ 2 รายการต่อท้าย ได้แก่ ชื่ออาร์กิวเมนต์ตามด้วยสตริงว่าง (ซึ่งเป็นการรวมตรรกะของสตริงศูนย์)
uniquify ค่าเริ่มต้นคือ False
เหมือนกับ add_all
expand_directories ค่าเริ่มต้นคือ True
ซึ่งเหมือนกับของ add_all
allow_closure ค่าเริ่มต้นคือ False
ซึ่งเหมือนกับของ add_all

set_param_file_format

Args Args.set_param_file_format(format)

ตั้งค่ารูปแบบของไฟล์พารามิเตอร์ หากใช้

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
format ต้องระบุ
ต้องเป็นอย่างใดอย่างหนึ่งต่อไปนี้
  • "multiline": แต่ละรายการ (ชื่ออาร์กิวเมนต์หรือค่า) จะเขียนแบบคำต่อคำลงในไฟล์พารามิเตอร์โดยมีอักขระบรรทัดใหม่ต่อท้าย
  • "shell": เหมือนกับ "multiline" แต่รายการจะอยู่ในเครื่องหมายคำพูดของเชลล์
  • "flag_per_line": เหมือนกับ "multiline" แต่จะ (1) เขียนเฉพาะ Flag (ขึ้นต้นด้วย "--") ลงในไฟล์ param และ (2) ค่าของ Flag (หากมี) จะเขียนในบรรทัดเดียวกันโดยคั่นด้วย "=" เป็นรูปแบบที่ไลบรารีแฟล็ก Abseil คาดหวัง

รูปแบบเริ่มต้นจะเป็น "shell" หากไม่ได้เรียกใช้

use_param_file

Args Args.use_param_file(param_file_arg, *, use_always=False)

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

Bazel อาจเลือกที่จะละเว้นการเขียนไฟล์ params ลงในต้นไม้เอาต์พุตระหว่างการดำเนินการเพื่อประสิทธิภาพ หากคุณกำลังแก้ไขข้อบกพร่องของการดำเนินการและต้องการตรวจสอบไฟล์ param ให้ส่ง --materialize_param_files ไปยังบิลด์

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
param_file_arg ต้องระบุ
สตริงรูปแบบที่มี "%s" รายการเดียว หากมีการแยก args ไปยังไฟล์ params ระบบจะแทนที่ args ด้วยอาร์กิวเมนต์ที่ประกอบด้วยสตริงนี้ซึ่งจัดรูปแบบด้วยเส้นทางของไฟล์ params

เช่น หากมีการแยก args ไปยังไฟล์ params "params.txt" การระบุ "--file=%s" จะทำให้บรรทัดคำสั่งการดำเนินการมี "--file=params.txt"

use_always ค่าเริ่มต้นคือ False
Whether to always spill the args to a params file. หากเป็นเท็จ Bazel จะตัดสินใจว่าต้องแยกอาร์กิวเมนต์หรือไม่โดยอิงตามระบบและความยาวของอาร์กิวเมนต์