superhelp

https://github.com/grantps/superhelp

Номер версии: 1.9.5 Автор: Grant Paton-Simpson

Обзор

SuperHelp - это помощь для людей! Цель состоит в том, чтобы предоставить индивидуальную помощь для простых фрагментов кода. SuperHelp не предназначен для замены встроенной справки Python, но дополнить ее для основных структур кода Python. SuperHelp также будет самоуверен. Помощь может быть оказана в различных контекстах, включая терминал и веб-браузеры (возможно, в рамках онлайн-учебных пособий).

Быстрый старт

Нажмите кнопку ниже, чтобы открыть ноутбук Jupyter, который вы можете поиграть в EG Получите советы по фрагменту или линии Python

или поместите следующее в верхней части сценария Python и запустите сценарий:

 import superhelp
superhelp.this()

Установка

Примечание - только Python 3.9+. Если у вас есть более старая версия Python, вместо этого используйте ноутбук Binder Jupyter (см. Выше)

Установить

Примечание

1. Используйте PIP

Например

 $ python3 -m pip install superhelp

Проверьте, запустив

 $ shelp

Если это не сработает, и вы находитесь на Linux, добавление следующего в вашем файле .bashrc может решить проблему:

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

2. Или клонировать репо

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

Пример вариантов использования

• Шарлотта любит проверять свой код, прежде чем другие увидят его, так что включает

    import superhelp
    superhelp.this(warnings_only=True)
  

  В верхней части каждого сценария. Когда она довольна кодом, она комментирует эти две строки.

• Avi-начинающий Python и хочет получить советы по функции из пяти строк, которую он написал, чтобы показать приветствия в список людей. Он узнает о соглашениях Python для переменного именования и лучших способов сочетания строк.

• Зак хочет получить совет по именованному корте. Он узнает, как добавить строки доктора в отдельные поля.

• NOOR рассматривает возможность отправки некоторого кода для переполнения стека, но сначала хочет улучшить его (или, возможно, получить идеи для решения напрямую). Она обнаруживает, что понимание списка может работать. Она также впервые узнает о понимании словаря.

• AL написал простой декоратор Python, но хочет посмотреть, есть ли что -то, что можно улучшить. Он узнает, как использовать functool.wrap из приведенного примера.

• Моана - опытный разработчик Python, но имеет тенденцию забывать такие вещи, как Doc Strings в своих функциях. Она изучает стандартный подход и начинает использовать его чаще. Моана также обнаруживает, что суммированная линейка полезна.

• Пол хочет проверить качество какого -то кода, прежде чем включить его в свой проект. Он узнает о некоторых проблемах и делает улучшения, прежде чем интегрировать их.

Пример использования

Снимки экрана с вывода HTML

Снимки экрана с вывода терминала

Доступны терминальные темы («темный» и «свет»)

Экраншот от вывода Marckdown

Использование SuperHelp в ноутбуке

Добавить новую ячейку в конце с таким контентом, как:

 %%shelp

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

И запустите его, чтобы получить советы.

В ноутбуке есть более подробные инструкции вверху.

Использование SuperHelp на локальной установке

Внутри вашего сценария

Поместите следующее в верхней части вашего сценария, а затем запустите сценарий (примечание - есть два подчеркивания по обе стороны от файла):

 import superhelp
superhelp.this()

Если вы не хотите, чтобы веб -вывод по умолчанию вы можете указать другой вывод, такой как «CLI» (интерфейс командной строки) или «MD» (Markdown):

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

Если вы не хотите по умолчанию «дополнительный» уровень сообщений, вы можете указать другой уровень детализации («краткий» или «главный»), например,

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

или:

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

Если вы хотите увидеть только предупреждения, вы можете указать только предупреждения, например, например, например,

 import superhelp
superhelp.this(warnings_only=True)

Выполнение вашего кода позволяет SuperHelp лучше понять ваш код.

Если вы хотите, чтобы ваш код был выполнен, пока 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