ฉันควรใส่ #! (shebang) ในสคริปต์ Python และควรใช้รูปแบบใด

ฉันควรใส่ shebang ในสคริปต์ Python ของฉันหรือไม่ ในรูปแบบใด

#!/usr/bin/env python 

หรือ

#!/usr/local/bin/python

เหล่านี้พกพาได้อย่างเท่าเทียมกัน? รูปแบบใดที่ใช้มากที่สุด

หมายเหตุ:ทอร์นาโดโครงการใช้ shebang ในทางตรงกันข้ามโครงการ Djangoก็ทำไม่ได้

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

การใช้งานที่ถูกต้องสำหรับสคริปต์ Python 3 คือ:

#!/usr/bin/env python3

ค่าเริ่มต้นนี้เป็นเวอร์ชัน 3. ล่าสุด สำหรับงูหลาม 2.7.latest การใช้งานในสถานที่ของpython2python3

ไม่ควรใช้สิ่งต่อไปนี้(ยกเว้นกรณีที่ไม่ค่อยเกิดขึ้นซึ่งคุณกำลังเขียนรหัสซึ่งเข้ากันได้กับทั้ง Python 2.x และ 3.x):

#!/usr/bin/env python

เหตุผลสำหรับคำแนะนำเหล่านี้ที่ให้ไว้ในPEP 394คือpythonสามารถอ้างถึงpython2หรือpython3ในระบบที่แตกต่างกัน ปัจจุบันอ้างถึงการpython2กระจายส่วนใหญ่ แต่อาจมีการเปลี่ยนแปลงในบางจุด

นอกจากนี้ห้ามใช้:

#!/usr/local/bin/python

"python อาจถูกติดตั้งที่ / usr / bin / python หรือ / bin / python ในกรณีเหล่านั้น #! # ด้านบนจะล้มเหลว"

- "#! / usr / bin / env python" vs "#! / usr / local / bin / python"

มันเป็นเรื่องของรสนิยมจริงๆ การเพิ่ม shebang หมายถึงผู้ใช้สามารถเรียกใช้สคริปต์ได้โดยตรงหากพวกเขาต้องการ (สมมติว่ามันถูกทำเครื่องหมายว่าสามารถใช้งานได้); ไม่ต้องpythonมีการเรียกใช้ด้วยตนเอง

ผลลัพธ์สุดท้ายของการรันโปรแกรมไม่ได้รับผลกระทบทั้งสองทาง เป็นเพียงตัวเลือกของวิธีการ

ฉันควรใส่ shebang ในสคริปต์ Python ของฉันหรือไม่

ใส่ Shebang ลงในสคริปต์ Python เพื่อระบุ:

• โมดูลนี้สามารถเรียกใช้เป็นสคริปต์
• ไม่ว่าจะสามารถทำงานได้เฉพาะกับ python2, python3 หรือเป็น Python 2/3
• บน POSIX มีความจำเป็นหากคุณต้องการรันสคริปต์โดยตรงโดยไม่ต้องเรียกใช้งานได้pythonอย่างชัดเจน

เหล่านี้พกพาได้อย่างเท่าเทียมกัน? รูปแบบใดที่ใช้มากที่สุด

หากคุณเขียน Shebang ด้วยตนเองให้ใช้ทุกครั้ง#!/usr/bin/env pythonเว้นแต่ว่าคุณมีเหตุผลเฉพาะที่จะไม่ใช้ เข้าใจแบบฟอร์มนี้ได้แม้ใน Windows (Python launcher)

หมายเหตุ: การติดตั้งสคริปต์ควรใช้เฉพาะหลามปฏิบัติการเช่นหรือ/usr/bin/python /home/me/.virtualenvs/project/bin/pythonมันจะไม่ดีถ้ามีเครื่องมือบางอย่างแตกถ้าคุณเปิดใช้งาน virtualenv ในเปลือกของคุณ โชคดีที่ shebang ที่ถูกต้องนั้นถูกสร้างขึ้นโดยอัตโนมัติในกรณีส่วนใหญ่โดยsetuptoolsหรือเครื่องมือแพ็คเกจการแจกจ่ายของคุณ (บน Windows setuptoolsสามารถสร้าง.exeสคริปต์ตัวตัดคำโดยอัตโนมัติ)

ในคำอื่น ๆ #!/usr/bin/env pythonถ้าสคริปต์ที่อยู่ในแหล่งที่มาเช็คเอาท์แล้วคุณอาจจะเห็น หากมีการติดตั้ง shebang จะเป็นพา ธ ไปยังไฟล์ python ที่สามารถใช้งานได้เช่น#!/usr/local/bin/python (หมายเหตุ: คุณไม่ควรเขียนพา ธ จากหมวดหมู่หลังด้วยตนเอง)

เพื่อเลือกว่าคุณควรใช้ python , python2หรือpython3ใน shebang ให้ดูPEP 394 - ทีม "งูใหญ่" คำสั่งบน Unix เหมือนระบบ :

• ... pythonควรใช้ในบรรทัด shebang สำหรับสคริปต์ที่เข้ากันได้กับทั้ง Python 2 และ 3 เท่านั้น

• ในการเตรียมตัวสำหรับการเปลี่ยนแปลงครั้งสุดท้ายในเวอร์ชันเริ่มต้นของ Python สคริปต์ Python 2 เท่านั้นที่ควรได้รับการอัปเดตให้เป็นแหล่งที่เข้ากันได้กับ Python 3 หรืออย่างอื่นเพื่อใช้python2ในบรรทัด Shebang

หากคุณมี Python มากกว่าหนึ่งเวอร์ชันและสคริปต์จำเป็นต้องทำงานภายใต้เวอร์ชันที่เฉพาะเจาะจง She-bang สามารถตรวจสอบให้แน่ใจว่ามีการใช้งานที่ถูกต้องเมื่อสคริปต์ถูกเรียกใช้งานโดยตรงตัวอย่างเช่น:

#!/usr/bin/python2.7

โปรดทราบว่าสคริปต์ยังคงสามารถเรียกใช้ผ่านบรรทัดคำสั่ง Python ที่สมบูรณ์หรือผ่านการนำเข้าซึ่งในกรณีนี้ she-bang จะถูกละเว้น แต่สำหรับสคริปต์ทำงานโดยตรงนี่คือเหตุผลที่เหมาะสมในการใช้ she-bang

#!/usr/bin/env python โดยทั่วไปแล้วเป็นวิธีที่ดีกว่า แต่สิ่งนี้จะช่วยในกรณีพิเศษ

โดยปกติแล้วจะเป็นการดีกว่าที่จะสร้างสภาพแวดล้อมเสมือน Python ซึ่งในกรณีทั่วไป#!/usr/bin/env pythonจะระบุอินสแตนซ์ที่ถูกต้องของ Python สำหรับ virtualenv

คุณควรเพิ่ม Shebang หากสคริปต์นั้นต้องการให้เรียกใช้งานได้ คุณควรติดตั้งสคริปต์ด้วยซอฟต์แวร์การติดตั้งที่แก้ไข shebang ให้ถูกต้องเพื่อให้ทำงานบนแพลตฟอร์มเป้าหมาย ตัวอย่างของสิ่งนี้คือ distutils และ Distribute

วัตถุประสงค์ของ shebang มีไว้สำหรับสคริปต์ที่จะรับรู้ประเภทของล่ามเมื่อคุณต้องการรันสคริปต์จากเชลล์ ส่วนใหญ่และไม่เสมอไปที่คุณเรียกใช้งานสคริปต์โดยการจัดหาล่ามจากภายนอก ตัวอย่างการใช้งาน:python-x.x script.py

สิ่งนี้จะใช้ได้แม้ว่าคุณจะไม่มีผู้ประกาศ Shebang

สาเหตุแรกคือ "พกพา" มากกว่าเพราะ/usr/bin/envมีของคุณPATHการประกาศที่บัญชีสำหรับปลายทางทั้งหมดที่ระบบปฏิบัติการของคุณอยู่

หมายเหตุ: ทอร์นาโดไม่ได้ใช้ shebangs อย่างเคร่งครัดและ Django ก็ไม่ได้ใช้อย่างเด็ดขาด มันแตกต่างกันไปตามวิธีที่คุณใช้งานฟังก์ชั่นหลักของแอปพลิเคชันของคุณ

นอกจากนี้: มันไม่ได้แตกต่างกับ Python

บางครั้งถ้าคำตอบไม่ชัดเจนมาก (ฉันหมายความว่าคุณไม่สามารถตัดสินใจได้ว่าใช่หรือไม่) ก็ไม่สำคัญเกินไปและคุณสามารถเพิกเฉยต่อปัญหาได้จนกว่าคำตอบจะชัดเจน

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

#!โดยทั่วไปถ้ามันเป็นโมดูลและไม่สามารถนำมาใช้เป็นสคริปต์มีความจำเป็นสำหรับการใช้ไม่มี ในทางกลับกันแหล่งโมดูลมักจะมีif __name__ == '__main__': ...อย่างน้อยการทดสอบเล็กน้อยของการทำงาน จากนั้น#!ทำให้รู้สึกอีกครั้ง

เหตุผลที่ดีสำหรับการใช้งาน#!คือเมื่อคุณใช้ทั้งสคริปต์ Python 2 และ Python 3 สคริปต์เหล่านั้นต้องตีความโดย Python เวอร์ชันต่าง ๆ วิธีนี้คุณต้องจำสิ่งที่pythonต้องใช้เมื่อเรียกใช้สคริปต์ด้วยตนเอง (โดยไม่ต้องใช้#!ภายใน) หากคุณมีการผสมผสานของสคริปต์ดังกล่าวมันเป็นความคิดที่ดีที่จะใช้#!ภายในทำให้พวกเขาปฏิบัติการและเปิดพวกเขาเป็นปฏิบัติการ (chmod ... )

เมื่อใช้ MS-Windows #!ไม่มีความหมายจนกระทั่งเมื่อไม่นานมานี้ Python 3.3 แนะนำ Windows Python Launcher (py.exe และ pyw.exe) ที่อ่าน#!บรรทัดตรวจพบ Python เวอร์ชันที่ติดตั้งและใช้ Python เวอร์ชันที่ถูกต้องหรือต้องการอย่างชัดเจน เนื่องจากส่วนขยายสามารถเชื่อมโยงกับโปรแกรมคุณสามารถรับพฤติกรรมที่คล้ายกันใน Windows เช่นเดียวกับการดำเนินการตั้งค่าสถานะในระบบที่ใช้ Unix

เมื่อฉันติดตั้ง Python 3.6.1 บน Windows 7 เมื่อเร็ว ๆ นี้มันก็ติดตั้ง Python Launcher สำหรับ Windows ซึ่งควรจะจัดการกับสาย Shebang อย่างไรก็ตามฉันพบว่า Python Launcher ไม่ได้ทำสิ่งนี้: บรรทัด shebang ถูกละเว้นและ Python 2.7.13 มักจะถูกใช้เสมอ (เว้นแต่ฉันจะเรียกใช้สคริปต์โดยใช้ py -3)

HKEY_LOCAL_MACHINE\SOFTWARE\Classes\Python.File\shell\open\commandเพื่อแก้ไขปัญหานี้ผมต้องแก้ไขคีย์รีจิสทรีของ Windows สิ่งนี้ยังคงมีค่า

"C:\Python27\python.exe" "%1" %*

จากการติดตั้ง Python 2.7 ก่อนหน้าของฉัน ฉันแก้ไขค่าคีย์รีจิสทรีนี้เป็น

"C:\Windows\py.exe" "%1" %*

และการประมวลผลบรรทัด Python Launcher ของ shebang ทำงานตามที่อธิบายไว้ข้างต้น

หากคุณมีการติดตั้งโมดูลที่แตกต่างกันและจำเป็นต้องใช้การติดตั้งหลามแบบเฉพาะเจาะจงดังนั้น shebang จะถูก จำกัด ในตอนแรก อย่างไรก็ตามคุณสามารถใช้เทคนิคต่าง ๆ ด้านล่างเพื่ออนุญาตให้เรียกใช้ shebang เป็นเชลล์สคริปต์ก่อนแล้วจึงเลือกหลาม นี่คือ IMO ที่ยืดหยุ่นมาก:

#!/bin/sh
#
# Choose the python we need. Explanation:
# a) '''\' translates to \ in shell, and starts a python multi-line string
# b) "" strings are treated as string concat by python, shell ignores them
# c) "true" command ignores its arguments
# c) exit before the ending ''' so the shell reads no further
# d) reset set docstrings to ignore the multiline comment code
#
"true" '''\'
PREFERRED_PYTHON=/Library/Frameworks/Python.framework/Versions/2.7/bin/python
ALTERNATIVE_PYTHON=/Library/Frameworks/Python.framework/Versions/3.6/bin/python3
FALLBACK_PYTHON=python3

if [ -x $PREFERRED_PYTHON ]; then
    echo Using preferred python $PREFERRED_PYTHON
    exec $PREFERRED_PYTHON "$0" "$@"
elif [ -x $ALTERNATIVE_PYTHON ]; then
    echo Using alternative python $ALTERNATIVE_PYTHON
    exec $ALTERNATIVE_PYTHON "$0" "$@"
else
    echo Using fallback python $FALLBACK_PYTHON
    exec python3 "$0" "$@"
fi
exit 127
'''

__doc__ = """What this file does"""
print(__doc__)
import platform
print(platform.python_version())

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

#!/bin/bash
"true" '''\'; source $(cd $(dirname ${BASH_SOURCE[@]}) &>/dev/null && pwd)/select.sh; exec $CHOSEN_PYTHON "$0" "$@"; exit 127; '''

แล้ว select.sh มี:

PREFERRED_PYTHON=/Library/Frameworks/Python.framework/Versions/2.7/bin/python
ALTERNATIVE_PYTHON=/Library/Frameworks/Python.framework/Versions/3.6/bin/python3
FALLBACK_PYTHON=python3

if [ -x $PREFERRED_PYTHON ]; then
    CHOSEN_PYTHON=$PREFERRED_PYTHON
elif [ -x $ALTERNATIVE_PYTHON ]; then
    CHOSEN_PYTHON=$ALTERNATIVE_PYTHON
else
    CHOSEN_PYTHON=$FALLBACK_PYTHON
fi

คำตอบ: ถ้าคุณวางแผนที่จะทำให้มันเป็นสคริปต์ที่ปฏิบัติการบรรทัดคำสั่ง

นี่คือขั้นตอน:

เริ่มต้นด้วยการยืนยันสตริง shebang ที่เหมาะสมเพื่อใช้:

which python

ใช้เอาต์พุตจากนั้นและเพิ่ม (ด้วย shebang #!) ในบรรทัดแรก

ในระบบของฉันมันตอบสนองเช่นนั้น:

$which python
/usr/bin/python

ดังนั้นรูปแบบของคุณจะเป็นดังนี้:

#!/usr/bin/python

หลังจากบันทึกแล้วจะยังคงทำงานเหมือนเดิมเนื่องจาก python จะเห็นบรรทัดแรกเป็นความคิดเห็น

python filename.py

หากต้องการให้มันเป็นคำสั่งให้คัดลอกเพื่อวางส่วนขยาย. py

cp filename.py filename

บอกระบบไฟล์ว่าสิ่งนี้จะสามารถเรียกใช้งานได้:

chmod +x filename

เพื่อทดสอบใช้:

./filename

แนวปฏิบัติที่ดีที่สุดคือย้ายมันไปไว้ที่ $ PATH ของคุณดังนั้นสิ่งที่คุณต้องพิมพ์ก็คือชื่อไฟล์นั่นเอง

sudo cp filename /usr/sbin

ด้วยวิธีนี้มันจะทำงานได้ทุกที่ (โดยไม่ต้อง. / หน้าชื่อไฟล์)

แอบโซลูท vs เส้นทางตรรกะ:

นี่เป็นคำถามเกี่ยวกับเส้นทางของล่าม Python ที่ควรจะเป็นแบบสัมบูรณ์หรือLogical ( /usr/bin/env) ที่เกี่ยวกับการพกพา

เผชิญหน้ากับคำตอบอื่น ๆ เกี่ยวกับเรื่องนี้และเว็บไซต์กองอื่น ๆ ที่พูดคุยเกี่ยวกับปัญหาในลักษณะทั่วไปโดยไม่ต้องพิสูจน์สนับสนุนผมได้ดำเนินการบางอย่างจริงๆจริงๆทดสอบที่ละเอียดและการวิเคราะห์เกี่ยวกับคำถามนี้มากในunix.stackexchange.com แทนที่จะวางคำตอบนั้นไว้ที่นี่ฉันจะชี้ให้ผู้ที่สนใจในการวิเคราะห์เปรียบเทียบกับคำตอบนั้น:

https://unix.stackexchange.com/a/566019/334294

การเป็นวิศวกร Linux เป้าหมายของฉันคือการจัดหาโฮสต์ที่เหมาะสมที่สุดและเหมาะสมที่สุดสำหรับลูกค้านักพัฒนาของฉันดังนั้นปัญหาของสภาพแวดล้อม Python จึงเป็นสิ่งที่ฉันต้องการคำตอบที่ชัดเจน มุมมองของฉันหลังจากการทดสอบคือเส้นทางตรรกะใน she-bang เป็นตัวเลือกที่ดีกว่า (2)

ใช้ก่อน

which python

สิ่งนี้จะให้ผลลัพธ์เป็นที่ตั้งของตัวแปลหลาม (ไบนารี) ของฉัน

ผลลัพธ์นี้อาจเป็นเช่น

/usr/bin/python

หรือ

/bin/python

ตอนนี้เลือกเส้น shebang อย่างเหมาะสมและใช้งาน

ในการพูดคุยทั่วไปเราสามารถใช้:

#!/usr/bin/env

หรือ

#!/bin/env