Haruskah saya menaruh #! (Shebang) dalam skrip Python, dan bagaimana bentuknya?

Haruskah saya menaruh shebang di skrip Python saya? Dalam bentuk apa?

#!/usr/bin/env python 

atau

#!/usr/local/bin/python

Apakah ini sama-sama portabel? Bentuk mana yang paling banyak digunakan?

Catatan: yang tornado proyek menggunakan peristiwa tersebut. Di sisi lainproyek Django tidak.

Baris shebang dalam skrip apa pun menentukan kemampuan skrip untuk dieksekusi seperti yang dapat dieksekusi mandiri tanpa mengetikkan pythonsebelumnya di terminal atau ketika mengklik dua kali dalam file manager (bila dikonfigurasi dengan benar). Tidak perlu tetapi umumnya diletakkan di sana sehingga ketika seseorang melihat file dibuka di editor, mereka segera tahu apa yang mereka lihat Namun, garis shebang mana yang Anda gunakan IS penting.

Penggunaan yang benar untuk skrip Python 3 adalah:

#!/usr/bin/env python3

Ini default ke versi 3. terbaru. Untuk Python 2.7.estest digunakan python2sebagai pengganti python3.

Berikut ini TIDAK boleh digunakan (kecuali untuk kasus yang jarang Anda menulis kode yang kompatibel dengan Python 2.x dan 3.x):

#!/usr/bin/env python

Alasan untuk rekomendasi ini, diberikan dalam PEP 394 , adalah yang pythondapat merujuk ke python2atau python3pada sistem yang berbeda. Saat ini mengacu python2pada sebagian besar distribusi, tetapi itu mungkin akan berubah di beberapa titik.

Juga, JANGAN Gunakan:

#!/usr/local/bin/python

"python dapat diinstal di / usr / bin / python atau / bin / python dalam kasus itu, # di atas akan gagal."

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

Ini benar-benar hanya masalah selera. Menambahkan shebang berarti orang dapat menjalankan skrip secara langsung jika mereka mau (dengan asumsi itu ditandai sebagai executable); menghilangkannya berarti pythonharus dipanggil secara manual.

Hasil akhir dari menjalankan program tidak terpengaruh; itu hanya pilihan sarana.

Haruskah saya menaruh shebang di skrip Python saya?

Masukkan shebang ke dalam skrip Python untuk menunjukkan:

• modul ini dapat dijalankan sebagai skrip
• apakah itu dapat dijalankan hanya pada python2, python3 atau apakah itu Python 2/3 kompatibel
• pada POSIX, perlu jika Anda ingin menjalankan skrip secara langsung tanpa menjalankan pythonexecutable secara eksplisit

Apakah ini sama-sama portabel? Bentuk mana yang paling banyak digunakan?

Jika Anda menulis shebang secara manual maka selalu gunakan #!/usr/bin/env pythonkecuali Anda memiliki alasan khusus untuk tidak menggunakannya. Formulir ini dipahami bahkan di Windows (peluncur Python).

Catatan: skrip yang terinstal harus menggunakan python yang dapat dieksekusi misalnya, /usr/bin/pythonatau /home/me/.virtualenvs/project/bin/python. Ini buruk jika beberapa alat rusak jika Anda mengaktifkan virtualenv di shell Anda. Untungnya, shebang yang benar dibuat secara otomatis dalam banyak kasus oleh setuptoolsatau alat paket distribusi Anda (pada Windows, setuptoolsdapat menghasilkan .exeskrip wrapper secara otomatis).

Dengan kata lain, jika skrip berada di sumber checkout maka Anda mungkin akan melihat #!/usr/bin/env python. Jika sudah diinstal maka shebang adalah path ke executable python tertentu seperti #!/usr/local/bin/python (CATATAN: Anda seharusnya tidak menulis path dari kategori terakhir secara manual).

Untuk memilih apakah Anda harus menggunakan python,, python2atau python3di shebang, lihat PEP 394 - Perintah "python" pada Sistem Unix-Like :

• ... pythonharus digunakan pada baris shebang hanya untuk skrip yang sumbernya kompatibel dengan Python 2 dan 3.

• dalam persiapan untuk perubahan akhirnya pada versi standar Python, hanya skrip Python 2 yang harus diperbarui menjadi sumber yang kompatibel dengan Python 3 atau yang lain untuk digunakan python2dalam baris shebang.

Jika Anda memiliki lebih dari satu versi Python dan skrip perlu dijalankan di bawah versi tertentu, she-bang dapat memastikan yang tepat digunakan ketika skrip dieksekusi secara langsung, misalnya:

#!/usr/bin/python2.7

Catatan skrip masih bisa dijalankan melalui baris perintah Python lengkap, atau melalui impor, dalam hal ini she-bang diabaikan. Tetapi untuk skrip yang dijalankan secara langsung, ini adalah alasan yang layak untuk menggunakan she-bang.

#!/usr/bin/env python pada umumnya pendekatan yang lebih baik, tetapi ini membantu dengan kasus-kasus khusus.

Biasanya akan lebih baik untuk membuat lingkungan virtual Python, dalam hal ini generik #!/usr/bin/env pythonakan mengidentifikasi contoh Python yang benar untuk virtualenv.

Anda harus menambahkan shebang jika skrip ini dimaksudkan untuk dieksekusi. Anda juga harus menginstal skrip dengan perangkat lunak penginstalan yang memodifikasi shebang ke sesuatu yang benar sehingga akan bekerja pada platform target. Contohnya adalah distutils dan Distribute.

Tujuan dari shebang adalah agar skrip mengenali tipe juru bahasa saat Anda ingin menjalankan skrip dari shell. Sebagian besar, dan tidak selalu, Anda menjalankan skrip dengan memasok penerjemah secara eksternal. Contoh penggunaan:python-x.x script.py

Ini akan berfungsi bahkan jika Anda tidak memiliki deklarator shebang.

Mengapa yang pertama lebih "portabel" karena, /usr/bin/envberisi PATHdeklarasi Anda yang menyumbang semua tujuan di mana executable sistem Anda berada.

CATATAN: Tornado tidak sepenuhnya menggunakan shebang, dan Django tidak menggunakan ini. Ini berbeda dengan bagaimana Anda menjalankan fungsi utama aplikasi Anda.

JUGA: Tidak berbeda dengan Python.

Kadang-kadang, jika jawabannya sangat tidak jelas (Maksudku Anda tidak dapat memutuskan apakah ya atau tidak), maka tidak peduli terlalu banyak, dan Anda dapat mengabaikan masalah sampai jawabannya adalah jelas.

Satu- #!satunya tujuan adalah untuk meluncurkan skrip. Django memuat sumbernya sendiri dan menggunakannya. Tidak perlu memutuskan juru bahasa apa yang harus digunakan. Dengan cara ini, #!sebenarnya tidak masuk akal di sini.

Secara umum, jika itu adalah modul dan tidak dapat digunakan sebagai skrip, tidak perlu menggunakan #!. Di sisi lain, sumber modul sering mengandung if __name__ == '__main__': ...setidaknya beberapa pengujian fungsionalitas yang sepele. Kemudian #!masuk akal lagi.

Salah satu alasan bagus untuk menggunakan #!adalah ketika Anda menggunakan skrip Python 2 dan Python 3 - mereka harus ditafsirkan oleh versi Python yang berbeda. Dengan cara ini, Anda harus mengingat apa yang pythonharus digunakan ketika meluncurkan skrip secara manual (tanpa bagian #!dalam). Jika Anda memiliki campuran skrip-skrip seperti itu, sebaiknya gunakan bagian #!dalamnya, buat agar dapat dieksekusi, dan luncurkan sebagai skrip yang dapat dieksekusi (chmod ...).

Saat menggunakan MS-Windows, #!tidak masuk akal - sampai saat ini. Python 3.3 memperkenalkan Windows Python Launcher (py.exe dan pyw.exe) yang bertuliskan #!baris, mendeteksi versi Python yang diinstal, dan menggunakan versi Python yang benar atau dicari secara eksplisit. Karena ekstensi dapat dikaitkan dengan program, Anda bisa mendapatkan perilaku serupa di Windows seperti halnya menjalankan flag di sistem berbasis Unix.

Ketika saya menginstal Python 3.6.1 pada Windows 7 baru-baru ini, ia juga menginstal Python Launcher untuk Windows, yang seharusnya menangani garis shebang. Namun, saya menemukan bahwa Peluncur Python tidak melakukan ini: baris shebang diabaikan dan Python 2.7.13 selalu digunakan (kecuali saya mengeksekusi skrip menggunakan py -3).

Untuk memperbaikinya, saya harus mengedit kunci registri Windows HKEY_LOCAL_MACHINE\SOFTWARE\Classes\Python.File\shell\open\command. Ini masih memiliki nilai

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

dari instalasi Python 2.7 saya sebelumnya. Saya mengubah nilai kunci registri ini menjadi

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

dan pemrosesan baris shebang Python Launcher berfungsi seperti dijelaskan di atas.

Jika Anda memiliki modul yang berbeda diinstal dan perlu menggunakan instalasi python tertentu, maka shebang tampaknya terbatas pada awalnya. Namun, Anda dapat melakukan trik seperti di bawah ini untuk memungkinkan shebang dipanggil terlebih dahulu sebagai skrip shell dan kemudian pilih python. Ini imo sangat fleksibel:

#!/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())

Atau lebih baik lagi, mungkin, untuk memfasilitasi penggunaan kembali kode di banyak skrip python:

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

dan kemudian select.sh memiliki:

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

Jawab: Hanya jika Anda berencana menjadikannya skrip yang dapat dieksekusi command-line.

Inilah prosedurnya:

Mulailah dengan memverifikasi string shebang yang tepat untuk digunakan:

which python

Ambil output dari itu dan tambahkan (dengan shebang #!) Di baris pertama.

Di sistem saya merespons seperti ini:

$which python
/usr/bin/python

Jadi shebang Anda akan terlihat seperti:

#!/usr/bin/python

Setelah menyimpan, itu akan tetap berjalan seperti sebelumnya karena python akan melihat baris pertama sebagai komentar.

python filename.py

Untuk membuatnya menjadi perintah, salinlah untuk menjatuhkan ekstensi .py.

cp filename.py filename

Beri tahu sistem file bahwa ini akan dapat dieksekusi:

chmod +x filename

Untuk mengujinya, gunakan:

./filename

Praktik terbaik adalah memindahkannya di suatu tempat di $ PATH Anda sehingga yang perlu Anda ketikkan adalah nama file itu sendiri.

sudo cp filename /usr/sbin

Dengan begitu ia akan bekerja di mana saja (tanpa ./ sebelum nama file)

Absolute vs Logical Path:

Ini benar-benar sebuah pertanyaan tentang apakah jalur ke juru bahasa Python harus mutlak atau logis ( /usr/bin/env) sehubungan dengan portabilitas.

Mengetahui jawaban lain tentang hal ini dan situs Stack lain yang membahas masalah ini secara umum tanpa bukti pendukung, saya telah melakukan beberapa pengujian & analisis granular yang BENAR-BENAR untuk pertanyaan ini di unix.stackexchange.com . Daripada menempelkan jawaban itu di sini, saya akan mengarahkan mereka yang tertarik pada analisis komparatif untuk jawaban itu:

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

Menjadi seorang Insinyur Linux, tujuan saya adalah selalu menyediakan host yang paling optimal dan dioptimalkan untuk klien pengembang saya, jadi masalah lingkungan Python adalah sesuatu yang saya benar-benar membutuhkan jawaban yang solid. Pandangan saya setelah pengujian adalah bahwa jalur logis dalam she-bang adalah yang lebih baik dari opsi (2).

Gunakan dulu

which python

Ini akan memberikan output sebagai lokasi di mana penerjemah python saya (biner) hadir.

Output ini bisa berupa

/usr/bin/python

atau

/bin/python

Sekarang dengan tepat pilih garis shebang dan gunakan itu.

Untuk menggeneralisasi kita dapat menggunakan:

#!/usr/bin/env

atau

#!/bin/env