Téléchargement de superhelp - Téléchargement du code source superhelp

superhelp

Autre code source

v1.1.0:

Télécharger

https://github.com/grantps/superhelp

Exemple de sortie HTML

Numéro de version: 1.9.5 Auteur: Grant Paton-Simpson

Aperçu

Superhelp est une aide pour les humains! L'objectif est de fournir une aide personnalisée pour les extraits de code simples. SuperHelp n'est pas destiné à remplacer l'aide Python intégrée mais à la compléter pour les structures de code Python de base. Superhelp sera également opiniâtre. L'aide peut être fournie dans une variété de contextes, y compris les terminaux et les navigateurs Web (peut-être dans le cadre des tutoriels en ligne).

Démarrage rapide

Cliquez sur le bouton ci-dessous pour ouvrir un ordinateur portable Jupyter que vous pouvez jouer dans EG Get Conseils sur un extrait ou une ligne de Python

Ou mettez ce qui suit en haut de votre script Python et exécutez le script:

 import superhelp
superhelp.this()

Installation

Remarque - Python 3.9+ uniquement. Si vous avez une ancienne version de Python, utilisez plutôt le bouton du cahier Jupyter Binder (voir plus haut)

Pour installer

Note

Utiliser Pip

Par exemple

 $ python3 -m pip install superhelp

Vérifier en fonctionnant

 $ shelp

Si cela ne fonctionne pas et que vous êtes sur Linux, l'ajout de ce qui suit à votre fichier .bashrc peut résoudre le problème:

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

Ou cloner le repo
$ git clone https://github.com/grantps/superhelp.git $ python3 setup.py install

Exemple de cas d'utilisation

Charlotte aime vérifier son code avant que les autres ne le voient donc comprend
```
  import superhelp
  superhelp.this(warnings_only=True)
```
en haut de chaque script. Quand elle est satisfaite du code, elle commente ces deux lignes.
Avi est un débutant Python et veut obtenir des conseils sur une fonction à cinq lignes qu'il a écrite pour afficher les salutations à une liste de personnes. Il apprend les conventions Python pour la dénomination variable et les meilleures façons de combiner les chaînes.
Zach veut obtenir des conseils sur un tuple nommé. Il apprend à ajouter des chaînes de doc aux champs individuels.
Noor envisage de soumettre un code pour empiler le débordement mais veut l'améliorer d'abord (ou peut-être d'obtenir des idées directement pour une solution). Elle découvre qu'une compréhension de la liste pourrait fonctionner. Elle prend également conscience des compréhensions du dictionnaire pour la première fois.
Al a écrit un simple décorateur Python mais veut voir s'il y a quelque chose qui peut être amélioré. Il apprend à utiliser Functool.wrap à partir d'un exemple fourni.
Moana est une développeur Python expérimentée mais a tendance à oublier des choses comme les cordes de Doc dans ses fonctions. Elle apprend une approche standard et commence à l'utiliser plus souvent. Moana trouve également le libellé résumé utile.
Paul veut vérifier la qualité d'un code avant de l'inclure dans son projet. Il apprend certains problèmes et apporte des améliorations avant de l'intégrer.

Exemple d'utilisation

Capture d'écran de la sortie HTML

Exemple de sortie HTML

Capture d'écran de la sortie du terminal

Exemple de sortie de terminal

Thèmes de terminal disponibles («sombre» et «lumière»)

Exemple de thèmes terminaux

Capture d'écran de la sortie de Markdown

Exemple de sortie de Markdown

Utilisation de superhelp sur le cahier

Ajoutez une nouvelle cellule à la fin avec du contenu comme:

 %%shelp

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

et exécutez-le pour obtenir des conseils.

Le cahier a des instructions plus détaillées en haut.

Utilisation de superhelp sur une installation locale

À l'intérieur de votre script

Mettez ce qui suit en haut de votre script, puis exécutez le script (Remarque - il y a deux soulignements de chaque côté du fichier):

 import superhelp
superhelp.this()

Si vous ne souhaitez pas la sortie Web par défaut, vous pouvez spécifier une autre sortie telle que «CLI» (interface de ligne de commande) ou «MD» (Markdown):

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

Si vous ne voulez pas le niveau de messages «supplémentaire» par défaut, vous pouvez spécifier un niveau de détail différent («bref» ou «main»), par exemple

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

ou:

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

Si vous voulez seulement voir des avertissements, vous pouvez spécifier des avertissements uniquement, par exemple

 import superhelp
superhelp.this(warnings_only=True)

L'exécution de votre code permet à SuperHelp de mieux comprendre votre code.

Si vous souhaitez que votre code soit exécuté pendant que Superhelp l'évalue

 import superhelp
superhelp.this(execute_code=True)

Vous pouvez utiliser autant d'options que vous le souhaitez par exemple

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

À partir de la ligne de commande (terminal / console)

 $ 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