superhelp
v1.1.0:
バージョン番号：1.9.5著者：Grant Paton-Simpson
スーパーヘルプは人間の助けです！目標は、シンプルなコードスニペットにカスタマイズされたヘルプを提供することです。 SuperHelpは、ビルトインPythonヘルプを、基本的なPythonコード構造のために補足する以外に置き換えることを目的としていません。スーパーヘルプも意見を述べられます。ヘルプは、ターミナルおよびWebブラウザーを含むさまざまなコンテキスト（おそらくオンラインチュートリアルの一部として）で提供できます。
下のボタンをクリックしてバインダーJupyterノートを開くことができます。
または、Pythonスクリプトの上部に次のように配置し、スクリプトを実行します。
import superhelp
superhelp.this()
注 - Python 3.9+のみ。 Pythonの古いバージョンがある場合は、代わりにバインダーJupyterノートブックボタンを使用します（Higher Upを参照）
インストールします
注記
例えば
$ python3 -m pip install superhelp
実行して確認してください
$ shelp
それが機能せず、Linuxを使用している場合、.bashrcファイルに次のことを追加すると問題が解決する可能性があります。
export PATH=$PATH:~/.local/bin
または、レポをクローンします
$ git clone https://github.com/grantps/superhelp.git $ python3 setup.pyインストール
シャーロットは他の人がそれを見る前に彼女のコードをチェックするのが好きなので
import superhelp
superhelp.this(warnings_only=True)
各スクリプトの上部に。彼女がコードに満足しているとき、彼女はこれらの2つの行をコメントします。
AviはPythonの初心者であり、人々のリストに挨拶を表示するために書いた5行の機能についてアドバイスを受けたいと考えています。彼は、さまざまな命名と文字列を組み合わせるより良い方法のためのPython規則について学びます。
ザックは名前のタプルについてアドバイスを受けたいと思っています。彼は個々のフィールドにドキュメント文字列を追加する方法を学びます。
Noorは、オーバーフローをスタックするためにコードを提出することを検討していますが、最初に改善したい（または、ソリューションのアイデアを直接取得する可能性がある）。彼女は、リストの理解がうまくいくかもしれないことを発見します。彼女はまた、初めて辞書の包括的なものに気付くようになります。
アルはシンプルなPythonデコレーターを書いていますが、改善できるものがあるかどうかを確認したいと考えています。彼は、提供された例からfunctool.rapの使用方法を学びます。
Moanaは経験豊富なPython開発者ですが、彼女の機能のDoc文字列のようなものを忘れる傾向があります。彼女は標準的なアプローチを学び、より頻繁にそれを使用し始めます。モアナはまた、要約された糸くずが便利であると感じています。
ポールは、彼のプロジェクトにそれを含める前に、いくつかのコードの品質をチェックしたいと考えています。彼はいくつかの問題について学び、それを統合する前に改善を行います。
次のようなコンテンツで最後に新しいセルを追加します：
%%shelp
def sorted(my_list):
sorted_list = my_list.sort()
return sorted_list
アドバイスを得るために実行します。
ノートブックには、より詳細な指示があります。
次のことをスクリプトの上部に置き、スクリプトを実行します（注 - ファイルの両側に2つのアンダースコアがあります）。
import superhelp
superhelp.this()
デフォルトのWeb出力が必要ない場合は、「CLI」（コマンドラインインターフェイス）や「MD」（MarkDown）などの別の出力を指定できます。
import superhelp
superhelp.this(output='md')
デフォルトの「追加」レベルのメッセージが必要ない場合は、別の詳細レベル（「brief」または「main」）を指定できます。
import superhelp
superhelp.this(detail_level='Brief')
または：
import superhelp
superhelp.this(detail_level='Main')
警告のみを見たい場合は、警告のみを指定できます。
import superhelp
superhelp.this(warnings_only=True)
コードを実行すると、SuperHelpがコードをよりよく理解することができます。
スーパーヘルプが評価している間にコードを実行する場合は
import superhelp
superhelp.this(execute_code=True)
必要な数のオプションを使用できます
import superhelp
superhelp.this(output='md', execute_code=True, warnings_only=True)
$ 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
https://github.com/aroberge/friendly-traceback
