กฎ
py_binary
ดูแหล่งที่มาของกฎpy_binary(name, deps, srcs, data, args, compatible_with, deprecation, distribs, env, exec_compatible_with, exec_properties, features, imports, legacy_create_init, licenses, main, output_licenses, python_version, restricted_to, srcs_version, stamp, tags, target_compatible_with, testonly, toolchains, visibility)
py_binary
คือโปรแกรม Python ที่ดำเนินการได้ ซึ่งประกอบด้วยคอลเล็กชันของไฟล์ต้นฉบับ .py
(ซึ่งอาจเป็นของกฎ py_library
อื่นๆ) โครงสร้างไดเรกทอรี *.runfiles
ที่มีโค้ดและข้อมูลทั้งหมดที่โปรแกรมต้องการขณะรันไทม์ และสคริปต์ stub ที่เริ่มต้นโปรแกรมด้วยสภาพแวดล้อมและข้อมูลเริ่มต้นที่ถูกต้อง
ตัวอย่าง
py_binary( name = "foo", srcs = ["foo.py"], data = [":transform"], # a cc_binary which we invoke at run time deps = [ ":foolib", # a py_library ], )
หากต้องการเรียกใช้ py_binary
จากภายในไบนารีหรือการทดสอบอื่น (เช่น การเรียกใช้ไบนารี Python เพื่อตั้งค่าทรัพยากรจำลองจากภายใน java_test) วิธีที่ถูกต้องคือให้ไบนารีหรือการทดสอบอื่นอ้างอิง py_binary
ในส่วนข้อมูล จากนั้นไบนารีอื่นจะค้นหา py_binary
ที่สัมพันธ์กับไดเรกทอรีต้นทางได้
py_binary( name = "test_main", srcs = ["test_main.py"], deps = [":testing"], ) java_library( name = "testing", srcs = glob(["*.java"]), data = [":test_main"] )
อาร์กิวเมนต์
Attributes | |
---|---|
name |
ชื่อ ต้องระบุ ชื่อที่ไม่ซ้ำกันสำหรับเป้าหมายนี้ หากไม่ได้ระบุ main ไว้ ชื่อนี้ควรเป็นชื่อเดียวกับชื่อไฟล์ต้นฉบับที่เป็นจุดแรกเข้าหลักของแอปพลิเคชัน ลบด้วยนามสกุลไฟล์ ตัวอย่างเช่น หากจุดแรกเข้าชื่อว่า main.py ชื่อควรเป็น main
|
deps
|
รายการป้ายกำกับ ค่าเริ่มต้นคือ deps ที่
แอตทริบิวต์ทั่วไปที่กำหนดโดยกฎของบิลด์ส่วนใหญ่
ซึ่งโดยทั่วไปจะเป็นกฎ py_library
|
srcs
|
รายการป้ายกำกับ ต้องระบุ รายการไฟล์แหล่งที่มา (.py ) ที่ประมวลผลเพื่อสร้างเป้าหมาย
ซึ่งรวมถึงโค้ดเช็คอินทั้งหมดและไฟล์ต้นฉบับที่สร้างขึ้น เป้าหมายไลบรารีจะอยู่ใน deps แทน ส่วนไฟล์ไบนารีอื่นๆ ที่ต้องใช้ขณะรันไทม์จะอยู่ใน data
|
imports
|
รายการสตริง ค่าเริ่มต้นคือ PYTHONPATH
ขึ้นอยู่กับการแทนที่ "Makeตัวแปร" ระบบจะเพิ่มไดเรกทอรีนำเข้าเหล่านี้สำหรับกฎนี้และกฎทั้งหมดที่เกี่ยวข้อง (หมายเหตุ: ไม่ใช่กฎที่กฎนี้ใช้อยู่ ระบบจะเพิ่มแต่ละไดเรกทอรีไปยัง
ระบบไม่อนุญาตให้ใช้เส้นทางสัมบูรณ์ (เส้นทางที่ขึ้นต้นด้วย |
legacy_create_init
|
จำนวนเต็ม ค่าเริ่มต้นคือ --incompatible_default_to_explicit_init_py หากเป็น "เท็จ" ผู้ใช้มีหน้าที่สร้างไฟล์ __init__.py (ซึ่งอาจว่างเปล่า) และเพิ่มไฟล์ไปยัง srcs ของเป้าหมาย Python ตามที่จำเป็น
|
main
|
ป้ายกำกับ ค่าเริ่มต้นคือ srcs ด้วย หากไม่ได้ระบุ ระบบจะใช้ name แทน (ดูด้านบน) หาก name ไม่ตรงกับชื่อไฟล์ใดๆ ใน srcs ต้องระบุ main
|
python_version
|
สตริง nonconfigurable ค่าเริ่มต้นคือ deps แบบทรานซิชัน) สำหรับ Python 2 หรือ Python
3 หรือไม่ ค่าที่ถูกต้องคือ "PY2" และ "PY3" (ค่าเริ่มต้น)
ระบบจะรีเซ็ตเวอร์ชัน Python ทุกครั้ง (อาจเป็นโดยค่าเริ่มต้น) เป็นเวอร์ชันใดก็ตามที่แอตทริบิวต์นี้ระบุไว้ โดยไม่คำนึงถึงเวอร์ชันที่ระบุบนบรรทัดคำสั่งหรือเป้าหมายอื่นๆ ที่สูงกว่าซึ่งจำเป็นต้องใช้เวอร์ชันนี้ หากต้องการ คำเตือนข้อบกพร่อง: แอตทริบิวต์นี้กำหนดเวอร์ชันที่ Bazel จะสร้างเป้าหมาย แต่เนื่องจาก #4815 สคริปต์ Stub ที่ได้จึงอาจยังเรียกใช้เวอร์ชันล่ามที่ไม่ถูกต้องขณะรันไทม์ ดูวิธีแก้ปัญหานี้ ซึ่งจะเกี่ยวข้องกับการกำหนดเป้าหมาย |
srcs_version
|
สตริง ค่าเริ่มต้นคือ srcs ของเป้าหมายที่เข้ากันได้กับ Python 2, Python 3 หรือทั้ง 2 อย่าง หากต้องการตั้งค่าเวอร์ชันรันไทม์ของ Python ให้ใช้แอตทริบิวต์ python_version ของกฎ Python ที่ดำเนินการได้ (py_binary หรือ py_test )
ค่าที่อนุญาตคือ โปรดทราบว่ามีเพียงกฎสั่งการ ( หากต้องการข้อมูลการวินิจฉัยเกี่ยวกับทรัพยากร Dependency ที่ทำให้เกิดข้อกำหนดเวอร์ชัน คุณสามารถเรียกใช้ bazel build <your target> \ --aspects=@rules_python//python:defs.bzl%find_requirements \ --output_groups=pyversioninfoวิธีนี้จะสร้างไฟล์ที่มีคำต่อท้าย -pyversioninfo.txt ซึ่งให้ข้อมูลเกี่ยวกับเหตุผลที่เป้าหมายต้องใช้ Python เวอร์ชันใดเวอร์ชันหนึ่ง โปรดทราบว่าวิธีนี้ใช้งานได้แม้ว่าเป้าหมายที่ระบุจะสร้างไม่สำเร็จเนื่องจากความขัดแย้งของเวอร์ชัน
|
stamp
|
จำนวนเต็ม ค่าเริ่มต้นคือ
ระบบจะไม่สร้างไบนารีที่ประทับตราอีกครั้ง เว้นแต่ทรัพยากร Dependency จะมีการเปลี่ยนแปลง |
py_library
ดูแหล่งที่มาของกฎpy_library(name, deps, srcs, data, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, imports, licenses, restricted_to, srcs_version, tags, target_compatible_with, testonly, visibility)
อาร์กิวเมนต์
Attributes | |
---|---|
name |
ชื่อ ต้องระบุ ชื่อที่ไม่ซ้ำกันสำหรับเป้าหมายนี้ |
deps
|
รายการป้ายกำกับ ค่าเริ่มต้นคือ deps ที่
แอตทริบิวต์ทั่วไปที่กำหนดโดยกฎของบิลด์ส่วนใหญ่
ซึ่งโดยทั่วไปจะเป็นกฎ py_library
|
srcs
|
รายการป้ายกำกับ ค่าเริ่มต้นคือ .py ) ที่ประมวลผลเพื่อสร้างเป้าหมาย
ซึ่งรวมถึงโค้ดเช็คอินทั้งหมดและไฟล์ต้นฉบับที่สร้างขึ้น
|
imports
|
รายการสตริง ค่าเริ่มต้นคือ PYTHONPATH
ขึ้นอยู่กับการแทนที่ "Makeตัวแปร" ระบบจะเพิ่มไดเรกทอรีนำเข้าเหล่านี้สำหรับกฎนี้และกฎทั้งหมดที่เกี่ยวข้อง (หมายเหตุ: ไม่ใช่กฎที่กฎนี้ใช้อยู่ ระบบจะเพิ่มแต่ละไดเรกทอรีไปยัง
ระบบไม่อนุญาตให้ใช้เส้นทางสัมบูรณ์ (เส้นทางที่ขึ้นต้นด้วย |
srcs_version
|
สตริง ค่าเริ่มต้นคือ srcs ของเป้าหมายที่เข้ากันได้กับ Python 2, Python 3 หรือทั้ง 2 อย่าง หากต้องการตั้งค่าเวอร์ชันรันไทม์ของ Python ให้ใช้แอตทริบิวต์ python_version ของกฎ Python ที่ดำเนินการได้ (py_binary หรือ py_test )
ค่าที่อนุญาตคือ โปรดทราบว่ามีเพียงกฎสั่งการ ( หากต้องการข้อมูลการวินิจฉัยเกี่ยวกับทรัพยากร Dependency ที่ทำให้เกิดข้อกำหนดเวอร์ชัน คุณสามารถเรียกใช้ bazel build <your target> \ --aspects=@rules_python//python:defs.bzl%find_requirements \ --output_groups=pyversioninfoวิธีนี้จะสร้างไฟล์ที่มีคำต่อท้าย -pyversioninfo.txt ซึ่งให้ข้อมูลเกี่ยวกับเหตุผลที่เป้าหมายต้องใช้ Python เวอร์ชันใดเวอร์ชันหนึ่ง โปรดทราบว่าวิธีนี้ใช้งานได้แม้ว่าเป้าหมายที่ระบุจะสร้างไม่สำเร็จเนื่องจากความขัดแย้งของเวอร์ชัน
|
py_test
ดูแหล่งที่มาของกฎpy_test(name, deps, srcs, data, args, compatible_with, deprecation, distribs, env, env_inherit, exec_compatible_with, exec_properties, features, flaky, imports, legacy_create_init, licenses, local, main, python_version, restricted_to, shard_count, size, srcs_version, stamp, tags, target_compatible_with, testonly, timeout, toolchains, visibility)
กฎ py_test()
จะรวมการทดสอบ การทดสอบจะเป็น Wrapper แบบไบนารีรอบๆ โค้ดทดสอบบางรายการ
ตัวอย่าง
py_test( name = "runtest_test", srcs = ["runtest_test.py"], deps = [ "//path/to/a/py/library", ], )
นอกจากนี้ยังสามารถระบุโมดูลหลักได้ด้วย ดังนี้
py_test( name = "runtest_test", srcs = [ "runtest_main.py", "runtest_lib.py", ], main = "runtest_main.py", )
อาร์กิวเมนต์
Attributes | |
---|---|
name |
ชื่อ ต้องระบุ ชื่อที่ไม่ซ้ำกันสำหรับเป้าหมายนี้ |
deps
|
รายการป้ายกำกับ ค่าเริ่มต้นคือ deps ที่
แอตทริบิวต์ทั่วไปที่กำหนดโดยกฎของบิลด์ส่วนใหญ่
ซึ่งโดยทั่วไปจะเป็นกฎ py_library
|
srcs
|
รายการป้ายกำกับ ต้องระบุ รายการไฟล์แหล่งที่มา (.py ) ที่ประมวลผลเพื่อสร้างเป้าหมาย
ซึ่งรวมถึงโค้ดเช็คอินทั้งหมดและไฟล์ต้นฉบับที่สร้างขึ้น เป้าหมายไลบรารีจะอยู่ใน deps แทน ส่วนไฟล์ไบนารีอื่นๆ ที่ต้องใช้ขณะรันไทม์จะอยู่ใน data
|
imports
|
รายการสตริง ค่าเริ่มต้นคือ PYTHONPATH
ขึ้นอยู่กับการแทนที่ "Makeตัวแปร" ระบบจะเพิ่มไดเรกทอรีนำเข้าเหล่านี้สำหรับกฎนี้และกฎทั้งหมดที่เกี่ยวข้อง (หมายเหตุ: ไม่ใช่กฎที่กฎนี้ใช้อยู่ ระบบจะเพิ่มแต่ละไดเรกทอรีไปยัง
ระบบไม่อนุญาตให้ใช้เส้นทางสัมบูรณ์ (เส้นทางที่ขึ้นต้นด้วย |
legacy_create_init
|
จำนวนเต็ม ค่าเริ่มต้นคือ --incompatible_default_to_explicit_init_py หากเป็น "เท็จ" ผู้ใช้มีหน้าที่สร้างไฟล์ __init__.py (ซึ่งอาจว่างเปล่า) และเพิ่มไฟล์ไปยัง srcs ของเป้าหมาย Python ตามที่จำเป็น
|
main
|
ป้ายกำกับ ค่าเริ่มต้นคือ srcs ด้วย หากไม่ได้ระบุ ระบบจะใช้ name แทน (ดูด้านบน) หาก name ไม่ตรงกับชื่อไฟล์ใดๆ ใน srcs ต้องระบุ main
|
python_version
|
สตริง nonconfigurable ค่าเริ่มต้นคือ deps แบบทรานซิชัน) สำหรับ Python 2 หรือ Python
3 หรือไม่ ค่าที่ถูกต้องคือ "PY2" และ "PY3" (ค่าเริ่มต้น)
ระบบจะรีเซ็ตเวอร์ชัน Python ทุกครั้ง (อาจเป็นโดยค่าเริ่มต้น) เป็นเวอร์ชันใดก็ตามที่แอตทริบิวต์นี้ระบุไว้ โดยไม่คำนึงถึงเวอร์ชันที่ระบุบนบรรทัดคำสั่งหรือเป้าหมายอื่นๆ ที่สูงกว่าซึ่งจำเป็นต้องใช้เวอร์ชันนี้ หากต้องการ คำเตือนข้อบกพร่อง: แอตทริบิวต์นี้กำหนดเวอร์ชันที่ Bazel จะสร้างเป้าหมาย แต่เนื่องจาก #4815 สคริปต์ Stub ที่ได้จึงอาจยังเรียกใช้เวอร์ชันล่ามที่ไม่ถูกต้องขณะรันไทม์ ดูวิธีแก้ปัญหานี้ ซึ่งจะเกี่ยวข้องกับการกำหนดเป้าหมาย |
srcs_version
|
สตริง ค่าเริ่มต้นคือ srcs ของเป้าหมายที่เข้ากันได้กับ Python 2, Python 3 หรือทั้ง 2 อย่าง หากต้องการตั้งค่าเวอร์ชันรันไทม์ของ Python ให้ใช้แอตทริบิวต์ python_version ของกฎ Python ที่ดำเนินการได้ (py_binary หรือ py_test )
ค่าที่อนุญาตคือ โปรดทราบว่ามีเพียงกฎสั่งการ ( หากต้องการข้อมูลการวินิจฉัยเกี่ยวกับทรัพยากร Dependency ที่ทำให้เกิดข้อกำหนดเวอร์ชัน คุณสามารถเรียกใช้ bazel build <your target> \ --aspects=@rules_python//python:defs.bzl%find_requirements \ --output_groups=pyversioninfoวิธีนี้จะสร้างไฟล์ที่มีคำต่อท้าย -pyversioninfo.txt ซึ่งให้ข้อมูลเกี่ยวกับเหตุผลที่เป้าหมายต้องใช้ Python เวอร์ชันใดเวอร์ชันหนึ่ง โปรดทราบว่าวิธีนี้ใช้งานได้แม้ว่าเป้าหมายที่ระบุจะสร้างไม่สำเร็จเนื่องจากความขัดแย้งของเวอร์ชัน
|
stamp
|
จำนวนเต็ม ค่าเริ่มต้นคือ |
py_runtime
ดูแหล่งที่มาของกฎpy_runtime(name, bootstrap_template, compatible_with, coverage_tool, deprecation, distribs, features, files, interpreter, interpreter_path, licenses, python_version, restricted_to, stub_shebang, tags, target_compatible_with, testonly, visibility)
แสดงรันไทม์ของ Python ที่ใช้เพื่อเรียกใช้โค้ด Python
เป้าหมาย py_runtime
สามารถแสดงรันไทม์ของแพลตฟอร์มหรือรันไทม์ระหว่างรุ่น รันไทม์ของแพลตฟอร์มจะเข้าถึงอินเตอร์พรีเตอร์ที่ติดตั้งโดยระบบตามเส้นทางที่รู้จัก ในขณะที่รันไทม์ในตัวจะชี้ไปยังเป้าหมายสั่งการซึ่งทำหน้าที่เป็นล่าม ในทั้ง 2 กรณี "ล่าม" หมายถึงสคริปต์ไบนารีหรือ Wrapper ที่สั่งการได้ซึ่งเรียกใช้สคริปต์ Python ที่ส่งผ่านบรรทัดคำสั่งได้ ตามรูปแบบเดียวกับอินเทอร์พรีเตอร์ CPython มาตรฐาน
รันไทม์ของแพลตฟอร์มเป็นไปอย่างเป็นธรรมชาติ แพลตฟอร์มนี้มีข้อกำหนดให้แพลตฟอร์มเป้าหมาย มีล่ามอยู่ในเส้นทางที่เจาะจง รันไทม์ภายในบิลด์อาจมีหรือไม่เฉพาะตัวหรือไม่ ขึ้นอยู่กับว่ารันไทม์ดังกล่าวชี้ไปยังล่ามแบบเช็คอินหรือสคริปต์ Wrapper ที่เข้าถึงล่ามของระบบ
เช่น
py_runtime( name = "python-2.7.12", files = glob(["python-2.7.12/**"]), interpreter = "python-2.7.12/bin/python", ) py_runtime( name = "python-3.6.0", interpreter_path = "/opt/pyenv/versions/3.6.0/bin/python", )
อาร์กิวเมนต์
Attributes | |
---|---|
name |
ชื่อ ต้องระบุ ชื่อที่ไม่ซ้ำกันสำหรับเป้าหมายนี้ |
bootstrap_template
|
ป้ายกำกับ ค่าเริ่มต้นคือ |
coverage_tool
|
ป้ายกำกับ ค่าเริ่มต้นคือ py_binary และ py_test
หากมีการตั้งค่า เป้าหมายต้องสร้างไฟล์เดียวหรือเป็นเป้าหมายที่ดำเนินการได้ เส้นทางไปยังไฟล์เดียวหรือไฟล์ปฏิบัติการหากเป้าหมายเป็นไฟล์ปฏิบัติการจะเป็นตัวกำหนดจุดแรกเข้าของเครื่องมือการครอบคลุม Python ระบบจะเพิ่มเป้าหมายและการเรียกใช้ไฟล์ไปยังการเรียกใช้ไฟล์เมื่อเปิดใช้การครอบคลุม จุดแรกเข้าของเครื่องมือต้องโหลดได้ด้วยล่าม Python (เช่น ไฟล์ |
files
|
รายการป้ายกำกับ ค่าเริ่มต้นคือ |
interpreter
|
ป้ายกำกับ ค่าเริ่มต้นคือ |
interpreter_path
|
สตริง ค่าเริ่มต้นคือ |
python_version
|
สตริง ค่าเริ่มต้นคือ "PY2" และ "PY3"
ค่าเริ่มต้นจะควบคุมด้วยแฟล็ก |
stub_shebang
|
สตริง ค่าเริ่มต้นคือ py_binary
ดูปัญหา 8685 สำหรับแรงจูงใจ แต่ไม่มีผลกับ Windows |