superhelp

https://github.com/grantps/superhelp

Nomor Versi: 1.9.5 Penulis: Grant Paton-Simpson

Ringkasan

Superhelp adalah bantuan untuk manusia! Tujuannya adalah untuk memberikan bantuan khusus untuk cuplikan kode sederhana. Superhelp tidak dimaksudkan untuk menggantikan bantuan Python bawaan tetapi untuk melengkapinya untuk struktur kode Python dasar. Superhelp juga akan didampingi. Bantuan dapat disediakan dalam berbagai konteks termasuk terminal dan browser web (mungkin sebagai bagian dari tutorial online).

Awal yang cepat

Klik tombol di bawah ini untuk membuka Binder Jupyter Notebook yang dapat Anda mainkan di EG dapatkan saran tentang cuplikan atau barisan Python

Atau letakkan yang berikut di bagian atas skrip Python Anda dan jalankan skrip:

 import superhelp
superhelp.this()

Instalasi

Catatan - Python 3.9+ saja. Jika Anda memiliki versi python yang lebih lama, gunakan tombol Binder Jupyter Notebook sebagai gantinya (lihat lebih tinggi)

Untuk menginstal

Catatan

1. Gunakan pip

Misalnya

 $ python3 -m pip install superhelp

Periksa dengan berjalan

 $ shelp

Jika tidak berhasil, dan Anda berada di Linux, menambahkan yang berikut ini ke file .bashrc Anda mungkin memperbaiki masalah:

 export PATH=$PATH:~/.local/bin

2. Atau mengkloning repo

   $ git clone https://github.com/grantps/superhelp.git $ python3 setup.py install

Contoh penggunaan kasus

• Charlotte suka memeriksa kodenya sebelum orang lain melihatnya

    import superhelp
    superhelp.this(warnings_only=True)
  

  di bagian atas setiap skrip. Ketika dia senang dengan kode, dia berkomentar kedua baris itu.

• Avi adalah pemula Python dan ingin mendapatkan nasihat tentang fungsi lima baris yang ia tulis untuk menampilkan salam ke daftar orang. Dia belajar tentang konvensi Python untuk penamaan variabel dan cara yang lebih baik untuk menggabungkan string.

• Zach ingin mendapatkan nasihat tentang tuple bernama. Dia belajar bagaimana menambahkan string dok ke bidang individu.

• Noor sedang mempertimbangkan untuk mengirimkan beberapa kode untuk menumpuk overflow tetapi ingin memperbaikinya terlebih dahulu (atau mungkin mendapatkan ide untuk solusi secara langsung). Dia menemukan bahwa pemahaman daftar mungkin berhasil. Dia juga menjadi sadar akan komprehensial kamus untuk pertama kalinya.

• Al telah menulis dekorator Python sederhana tetapi ingin melihat apakah ada sesuatu yang dapat ditingkatkan. Dia belajar cara menggunakan functool.wrap dari contoh yang disediakan.

• Moana adalah pengembang Python yang berpengalaman tetapi cenderung melupakan hal -hal seperti string dokumen dalam fungsinya. Dia belajar pendekatan standar dan mulai menggunakannya lebih sering. Moana juga menemukan serangkaian serangkai bermanfaat.

• Paul ingin memeriksa kualitas beberapa kode sebelum memasukkannya ke dalam proyeknya. Dia belajar tentang beberapa masalah dan melakukan perbaikan sebelum mengintegrasikannya.

Contoh penggunaan

Tangkapan layar dari output HTML

Tangkapan layar dari output terminal

Tema terminal tersedia ('gelap' dan 'terang')

Tangkapan layar dari output markdown

Menggunakan Superhelp di Notebook

Tambahkan sel baru di akhir dengan konten seperti:

 %%shelp

def sorted(my_list):
    sorted_list = my_list.sort()
    return sorted_list

dan jalankan untuk mendapatkan nasihat.

Notebook memiliki instruksi yang lebih rinci di atas.

Menggunakan superhelp pada instalasi lokal

Di dalam skrip Anda

Letakkan yang berikut di bagian atas skrip Anda dan kemudian jalankan skrip (Catatan - ada dua garis bawah di kedua sisi file):

 import superhelp
superhelp.this()

Jika Anda tidak ingin output web default, Anda dapat menentukan output lain seperti 'CLI' (antarmuka baris perintah) atau 'md' (markdown):

 import superhelp
superhelp.this(output='md')

Jika Anda tidak ingin tingkat pesan 'tambahan' default, Anda dapat menentukan tingkat detail yang berbeda ('singkat' atau 'utama') misalnya

 import superhelp
superhelp.this(detail_level='Brief')

atau:

 import superhelp
superhelp.this(detail_level='Main')

Jika Anda hanya ingin melihat peringatan, Anda hanya dapat menentukan peringatan misalnya

 import superhelp
superhelp.this(warnings_only=True)

Melaksanakan kode Anda memungkinkan SuperHelp untuk lebih memahami kode Anda.

Jika Anda ingin kode Anda dieksekusi saat SuperHelp sedang mengevaluasinya

 import superhelp
superhelp.this(execute_code=True)

Anda dapat menggunakan opsi sebanyak yang Anda inginkan misalnya

 import superhelp
superhelp.this(output='md', execute_code=True, warnings_only=True)

Dari baris perintah (terminal / konsol)

 $ shelp -h  ## get extended help on usage (purpose, defaults, etc)

$ shelp --code "people = ['Tomas', 'Sal', 'Raj']" --output html --detail-level Main
$ shelp -c "people = ['Tomas', 'Sal', 'Raj']" -o html -d Main

$ shelp --file-path my_script.py --output cli --theme light --detail-level Extra
$ shelp -f my_snippet.py -o cli -t light -d Extra

$ shelp --project-path /home/g/proj --exclude-folders env
$ shelp -p /home/g/proj -e env

$ shelp --file-path my_script.py --warnings-only
$ shelp -f my_snippet.py -w

$ shelp --file-path my_script.py --execute-code
$ shelp -f my_snippet.py -x

$ shelp  ## to see advice on an example snippet displayed (detail level 'Extra')

$ shelp --advice-list  ## to see all types of help listed
$ shelp -a

Ide peregangan

• Perpanjang melampaui perpustakaan standar ke perpustakaan populer seperti permintaan, botol, labu dll.

Paket lainnya

https://github.com/aroberge/friendly-traceback