Artikel ini memperincikan bagaimana untuk mengkonfigurasi Bash Auto-Completion untuk alat Python CLI yang dibina di atas kerangka klik. Untuk kesilapan konfigurasi biasa, terutamanya masalah yang disebabkan oleh keletihan melaksanakan skrip Python sebagai skrip bash, dua penyelesaian teras disediakan: secara eksplisit menentukan penterjemah Python atau menggunakan shebang. Di samping itu, artikel itu membincangkan cara untuk menyediakan kesempurnaan auto untuk pakej python yang dipasang, menerangkan batasan `PIP Install` dalam mengautomasikan proses ini, dan membimbing pengguna untuk mengambil langkah konfigurasi yang betul.

Fahami mekanisme penyempurnaan automatik klik

Klik adalah perpustakaan Python yang kuat untuk mencipta antara muka baris arahan dengan cepat (CLI). Ia mempunyai sokongan auto-kesempurnaan terbina dalam pelbagai cangkang seperti Bash dan ZSH. Prinsip teras ialah apabila pengguna menekan kekunci tab di dalam shell, shell akan memanggil aplikasi klik melalui arahan khas (biasanya eval "$ (_ cli_name_complete = bash_source cli-name)"), dan aplikasi klik akan menghasilkan cadangan penyelesaian yang mungkin berdasarkan input dan konteks semasa.

Dalam mekanisme ini, _cli_name_complete = bash_source adalah pembolehubah persekitaran yang memberitahu klik bahawa aplikasi sedang melakukan autocompletion bash. CLI-NAME adalah nama titik masuk alat baris arahan anda.

Soalan Lazim dan Analisis Ralat

Ramai pemaju mungkin menghadapi kesilapan yang serupa dengan yang berikut apabila mengkonfigurasi klik Auto-Completion:

 Import-IM6.Q16: Tidak dapat membuka X Server `' @ error/import.c/importimagecommand/359.
dari: tidak dapat membaca /var/mail/my-module.delete
dari: tidak dapat membaca /var/mail/my-module.init
/path/to/my-module/my_module/__main__.py: garis 9: ralat sintaks berhampiran token yang tidak dijangka `('
/path/to/my-module/my_module/__main__.py: baris 9: `dari some_module import ('

Kesilapan ini biasanya disebabkan oleh pengguna yang cuba mengkonfigurasi autocompletion secara langsung oleh eval "$ (_ my_module_complete = bash_source /path/to/my-module/my_module/__main__.py)". Masalahnya ialah shell akan melaksanakan fail /path/my-module/my_module/__main__.py sebagai skrip bash secara lalai, bukan skrip python.

Apabila Bash cuba melaksanakan kod Python, ia salah menafsirkan pernyataan import Python sebagai arahan import dalam pakej ImageMagick (digunakan untuk tangkapan skrin), mengakibatkan ralat import-im6.q16. Begitu juga, kata kunci dari Python akan disalahpahami sebagai perintah shell, menyebabkan satu siri kesilapan sintaks seperti dari: tidak dapat membaca/var/mel/... dll.

Penyelesaian 1: Menentukan penterjemah python dengan jelas

Penyelesaian yang paling mudah adalah dengan jelas memberitahu shell dalam perintah eval untuk menggunakan penterjemah python untuk menjalankan skrip anda. Dengan cara ini, shell tidak akan cuba menghuraikan kod Python sebagai skrip bash.

 Fail ini ke dalam fail ~//.bashrc atau ~/////

Penerangan Kod:

• Python: Secara eksplisit panggil penterjemah Python untuk melaksanakan skrip berikutnya.
• /path/to/my-module/my_module/__main__.py: Laluan mutlak ke skrip masuk utama aplikasi klik anda.
• _My_module_complete = bash_source: Klik pembolehubah persekitaran yang digunakan untuk mengenal pasti permintaan autocompletion.

Nota: Apabila menggunakan kaedah ini, anda tidak perlu menambah keizinan yang boleh dilaksanakan (CHMOD X) ke fail __main__.py kerana ia dipanggil secara eksplisit melalui penterjemah Python.

Penyelesaian 2: Tambah garis shebang

Penyelesaian lain adalah untuk menambah garis shebang di bahagian atas skrip python anda. A Shebang adalah komen khas yang memberitahu sistem operasi yang penterjemah harus digunakan untuk melaksanakan fail tersebut.

Tambahkan yang berikut ke baris pertama fail my_module/__ main__.py:

 #!/usr/bin/env python

# ... berikut ialah kod klik CLI anda ...

@click.group (rantai = benar)
def cli ():
    lulus

cli.add_command (init_cmd)
cli.add_command (delete_cmd)

Penerangan Kod:

• #!/usr/bin/env python: Baris ini memberitahu sistem operasi bahawa apabila fail ini dilaksanakan secara langsung, perintah Env harus digunakan untuk mencari jurubahasa python untuk menjalankannya.

Nota: Selepas menambah garis shebang, anda juga perlu memberikan kebenaran pelaksanaan ke fail __main__.py supaya sistem pengendalian dapat melaksanakannya secara langsung:

 chmod x /path/to/my-module/my_module/__main__.py

Kemudian, garis konfigurasi autokomplet anda dapat dipermudahkan untuk:

 # Tambah baris ini ke ~/.bashrc atau ~/.zshrc File eval "$ (_ my_module_complete = bash_source /path/to/my-module/my_module/__main__.py)"

Konfigurasi AutoComplete untuk pakej yang dipasang

Dua penyelesaian di atas menyelesaikan masalah skrip python yang salah dibaca sebagai skrip bash. Walau bagaimanapun, untuk pakej python yang dipasang melalui pemasangan PIP, secara langsung merujuk laluan fail sumber (seperti /path/to/my-module/my_module/__main__.py) tidak sesuai kerana laluan pemasangan mungkin berbeza untuk pengguna yang berbeza.

Klik pendekatan yang disyorkan adalah menggunakan titik entri skrip konsol yang ditakrifkan dalam persediaan.py untuk pakej anda. Sebagai contoh, jika persediaan anda.py ditakrifkan seperti berikut:

 setuptools.setup (
    Nama = "My-Module",
    entry_points = {
        "Console_scripts": [
            "My-Module = my_module .__ Utama __: CLI"
        ]
    },
    # ... konfigurasi lain ...
)

Ini bermakna alat CLI anda boleh dilaksanakan secara langsung melalui perintah My-Module. Dalam kes ini, konfigurasi autokomplet yang betul harus menggunakan nama arahan yang dipasang ini dan bukannya laluan skrip Python dalaman:

 # Tambahkan baris ini ke fail ~/.bashrc atau ~/.

Mata Utama:

• _My_module_complete: Nama pembolehubah persekitaran ini biasanya versi huruf besar dari nama arahan CLI anda dengan garis bawah. Sebagai contoh, jika arahan anda adalah modul my, nama pembolehubah adalah _my_module_complete.
• My-Module: Ini adalah nama arahan bahawa alat CLI anda boleh memanggil terus dalam shell selepas ia dipasang. Klik secara automatik mengendalikan mencari dan melaksanakan kod python yang betul.

Pemasangan automatik dan konfigurasi pengguna

Mengenai bagaimana untuk mengautomasikan konfigurasi auto-lengkap semasa proses pemasangan PIP, satu perkara perlu dijelaskan: pemasangan PIP tidak boleh (dan tidak seharusnya) secara automatik mengubah suai fail konfigurasi shell pengguna (seperti .bashrc atau .zshrc). Ini adalah untuk alasan keselamatan dan kawalan pengguna.

Oleh itu, apa yang dipanggil "automasi" dicerminkan dalam aspek berikut:

1. Automasi dalam Klik: Setelah pengguna menambah eval line "$ (_ my_module_complete = bash_source my-module)" Dalam fail konfigurasi shell, klik secara automatik akan mengendalikan logik penyelesaian berikutnya tanpa memerlukan pengguna untuk melakukan konfigurasi lain.
2. Menyediakan panduan yang jelas: Sebagai pemaju, amalan terbaik adalah untuk memberikan arahan konfigurasi autokomplet yang jelas dan ringkas dalam dokumentasi projek anda. Mengarahkan pengguna untuk menambah arahan Eval di atas ke fail konfigurasi shell mereka, dan ingatkan mereka untuk melaksanakan sumber ~/.bashrc (atau fail setara) untuk perubahan yang berkuatkuasa.

Ringkasan dan amalan terbaik

Untuk mengkonfigurasi autocompletion bash untuk alat klik CLI, ikuti amalan terbaik berikut:

1. Pastikan skrip python dilaksanakan dengan betul:
   • Kaedah 1 (disyorkan untuk senario debug atau tidak pemasangan): Secara jelas menentukan penterjemah python dalam perintah eval:

      eval "$ (_ my_module_complete = bash_source python /path/to/my-module/my_module/__main__.py)"

   • Kaedah 2 (berkenaan dengan skrip yang boleh dilaksanakan): Tambah Shebang (#!/Usr/bin/env python) di bahagian atas skrip dan keizinan pelaksanaan pemberian (CHMOD X).
2. Untuk pakej python yang dipasang:
   • Sentiasa konfigurasikan autokompletion menggunakan nama entri entri skrip konsol yang ditakrifkan dalam persediaan.py.
   • Format konfigurasi adalah: eval "$ (_ your_cli_name_complete = Bash_source your-cli-name)".
   • Contohnya: eval "$ (_ my_module_complete = bash_source my-module)"
3. Konfigurasi Pengguna dan bukannya Pengubahsuaian Automatik: Pemasangan PIP tidak boleh mengubahsuai Konfigurasi Shell Pengguna secara automatik. Sediakan panduan yang jelas mengenai penubuhan autokompletion dalam dokumentasi projek anda, dan mengarahkan pengguna untuk menambahkan arahan EVAL yang diperlukan secara manual ke fail .bashrc atau .zshrc.

Dengan mengikuti langkah-langkah ini, anda boleh memastikan bahawa alat klik CLI anda mempunyai fungsi autokompletsi yang mantap dan mesra pengguna.

Atas ialah kandungan terperinci Bash Autocompletion untuk Alat Klik CLI: Dari Bugs ke Amalan Terbaik. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!