superhelp

https://github.com/grantps/superhelp

Versionsnummer: 1.9.5 Autor: Grant Paton-Simpson

Überblick

Superhelp ist Hilfe für den Menschen! Ziel ist es, einfache Code -Ausschnitte maßgeschneiderte Hilfe zu leisten. Superhelp soll nicht die integrierte Python-Hilfe ersetzen, sondern um sie für grundlegende Python-Code-Strukturen zu ergänzen. Superhelp wird ebenfalls übereinstimmen. Hilfe kann in verschiedenen Kontexten bereitgestellt werden, einschließlich der Terminal- und Webbrowser (möglicherweise als Teil von Online-Tutorials).

Schneller Start

Klicken

Oder stellen Sie Folgendes oben in Ihr Python -Skript und führen Sie das Skript aus:

 import superhelp
superhelp.this()

Installation

Hinweis - nur Python 3.9+. Wenn Sie eine ältere Version von Python haben, verwenden Sie stattdessen die Binder Jupyter Notebook -Taste (siehe höher).

Zu installieren

Notiz

1. PIP verwenden

Z.B

 $ python3 -m pip install superhelp

Überprüfen Sie durch Laufen

 $ shelp

Wenn es nicht funktioniert und Sie unter Linux sind, kann es das Problem beheben:

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

2. Oder klonen Sie das Repo

   $ git klone https://github.com/grantps/superhelp.git $ python3 setup.py Installation

Beispiel Anwendungsfälle

• Charlotte prüft ihren Code gern, bevor andere ihn sehen

    import superhelp
    superhelp.this(warnings_only=True)
  

  oben in jedem Drehbuch. Wenn sie mit dem Code zufrieden ist, kommentiert sie diese beiden Zeilen aus.

• Avi ist ein Python-Anfänger und möchte Ratschläge zu einer fünfzeiligen Funktion erhalten, die er geschrieben hat, um einer Liste von Personen Grüße anzuzeigen. Er erfährt über Python -Konventionen für variable Namen und bessere Möglichkeiten, Saiten zu kombinieren.

• Zach möchte Ratschläge zu einem benannten Tupel bekommen. Er lernt, wie man den einzelnen Feldern Doc -Saiten hinzufügt.

• Noor erwägt, einen Code zum Stapelüberlauf einzureichen, möchte aber zuerst verbessern (oder möglicherweise Ideen für eine Lösung direkt erhalten). Sie entdeckt, dass ein Listenverständnis funktionieren könnte. Sie wird auch zum ersten Mal auf Wörterbuchverständnisse aufmerksam.

• Al hat einen einfachen Python -Dekorateur geschrieben, möchte aber sehen, ob etwas verbessert werden kann. Er lernt, wie man Functool.wrap aus einem vorgesehenen Beispiel verwendet.

• Moana ist eine erfahrene Python -Entwicklerin, neigt aber dazu, Dinge wie Doc -Streicher in ihren Funktionen zu vergessen. Sie lernt einen Standardansatz und beginnt häufiger zu verwenden. Moana findet auch die zusammengefasste Linie nützlich.

• Paul möchte die Qualität eines Codes überprüfen, bevor er ihn in sein Projekt einbezieht. Er erfährt einige Probleme und verbessert sich, bevor er es integriert.

Beispiel Verwendung

Screenshot aus der HTML -Ausgabe

Screenshot aus dem Terminalausgang

Terminalthemen verfügbar ('Dunkel' und 'Licht')

Screenshot aus Markdown -Ausgabe

Verwenden von Superhelp auf dem Notebook

Fügen Sie eine neue Zelle am Ende mit Inhalten wie:

 %%shelp

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

Und führen Sie es aus, um Ratschläge zu erhalten.

Das Notebook enthält oben detailliertere Anweisungen.

Verwenden von Superhelp bei einer lokalen Installation

In Ihrem Skript

Stellen Sie das Folgende oben in Ihr Skript ein und führen Sie das Skript aus (Hinweis - Auf beiden Seiten der Datei befinden sich zwei Unterstriche):

 import superhelp
superhelp.this()

Wenn Sie nicht die Standard -Webausgabe möchten, können Sie eine andere Ausgabe wie "CLI" (Befehlszeilenschnittstelle) oder 'MD' (Markdown) angeben:

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

Wenn Sie nicht die Standard -Nachrichtenstufe von "zusätzlicher" Nachrichten möchten, können Sie eine andere Detailstufe ('Brief' oder 'Main') angeben, z.

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

oder:

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

Wenn Sie nur Warnungen sehen möchten, können Sie nur Warnungen angeben, z.

 import superhelp
superhelp.this(warnings_only=True)

Durch die Ausführung Ihres Codes kann Superhelp Ihren Code besser verstehen.

Wenn Sie möchten, dass Ihr Code während der Superhelp ausgeführt wird

 import superhelp
superhelp.this(execute_code=True)

Sie können so viele Optionen verwenden, wie Sie möchten, z.

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

Aus der Befehlszeile (Terminal / Konsole)

 $ 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

Ideen dehnen

• Übertragen Sie über die Standardbibliothek hinaus in beliebte Bibliotheken wie Anfragen, Flaschen, Flaschen, Flaschen usw.

Andere Pakete

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