superhelp
v1.1.0:
Número de versión: 1.9.5 Autor: Grant Paton-Simpson
¡Superhelp es ayuda para los humanos! El objetivo es proporcionar ayuda personalizada para fragmentos de código simple. SuperHELP no tiene la intención de reemplazar la ayuda de Python incorporada, pero para complementarla para las estructuras básicas del código de Python. La superhelp también será obstinada. Se puede proporcionar ayuda en una variedad de contextos, incluidos los navegadores de terminal y web (tal vez como parte de los tutoriales en línea).
Haga clic en el botón a continuación para abrir un cuaderno de Binder Jupyter que puede jugar en EG Obtenga consejos sobre un fragmento o línea de Python
O coloque lo siguiente en la parte superior de su script de Python y ejecute el script:
import superhelp
superhelp.this()
Nota - Python 3.9+ solamente. Si tiene una versión anterior de Python, use el botón Binder Jupyter Notebook (ver más arriba)
Para instalar
Nota
P.ej
$ python3 -m pip install superhelp
Comprobar ejecutando
$ shelp
Si no funciona y está en Linux, agregar lo siguiente a su archivo .bashrc podría solucionar el problema:
export PATH=$PATH:~/.local/bin
O clonar el repositorio
$ git clone https://github.com/grantps/superhelp.git $ python3 setup.py install
A Charlotte le gusta revisar su código antes de que otros lo ven, así que incluye
import superhelp
superhelp.this(warnings_only=True)
en la parte superior de cada script. Cuando está contenta con el código, comenta esas dos líneas.
Avi es un principiante de Python y quiere obtener consejos sobre una función de cinco líneas que escribió para mostrar saludos a una lista de personas. Aprende sobre las convenciones de Python para nombrar variables y mejores formas de combinar cuerdas.
Zach quiere obtener consejos sobre una tupla llamada. Aprende cómo agregar cadenas de documentos a los campos individuales.
Noor está considerando enviar algún código al desbordamiento de la pila, pero primero quiere mejorarlo (o posiblemente obtener ideas para una solución directamente). Ella descubre que una comprensión de la lista podría funcionar. También se da cuenta de las comprensiones del diccionario por primera vez.
Al ha escrito un decorador simple de Python, pero quiere ver si hay algo que se pueda mejorar. Aprende cómo usar Functool.Wrap de un ejemplo proporcionado.
Moana es un desarrollador experimentado de Python, pero tiende a olvidar cosas como cuerdas de documentos en sus funciones. Ella aprende un enfoque estándar y comienza a usarlo con más frecuencia. Moana también encuentra útil la pelusa resumida.
Paul quiere verificar la calidad de algún código antes de incluirlo en su proyecto. Aprende sobre algunos problemas y hace mejoras antes de integrarlo.
Agregue la nueva celda al final con contenido como:
%%shelp
def sorted(my_list):
sorted_list = my_list.sort()
return sorted_list
Y ejecutarlo para obtener consejos.
El cuaderno tiene instrucciones más detalladas en la parte superior.
Coloque lo siguiente en la parte superior de su script y luego ejecute el script (nota: hay dos subrayadores a cada lado del archivo):
import superhelp
superhelp.this()
Si no desea la salida web predeterminada, puede especificar otra salida como 'CLI' (interfaz de línea de comandos) o 'MD' (Markdown):
import superhelp
superhelp.this(output='md')
Si no desea el nivel de mensajes 'extra' predeterminado, puede especificar un nivel de detalle diferente ('breve o' principal '), por ejemplo
import superhelp
superhelp.this(detail_level='Brief')
o:
import superhelp
superhelp.this(detail_level='Main')
Si solo desea ver advertencias, puede especificar advertencias solo, por ejemplo,
import superhelp
superhelp.this(warnings_only=True)
Ejecutar su código permite que la superhela comprenda mejor su código.
Si desea que se ejecute su código mientras SuperHelp lo evalúa
import superhelp
superhelp.this(execute_code=True)
Puedes usar tantas opciones como quieras, por ejemplo
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/fiendly-traceback
