superhelp

https://github.com/grantps/superhelp

版本编号：1.9.5作者：Grant Paton-Simpson

概述

SuperHelp对人类有帮助！目标是为简单的代码段提供自定义的帮助。 SuperHelp并不是要代替内置的Python帮助，而是为基本的Python代码结构进行补充。 SuperHelp也将被认为是有用的。可以在包括终端和Web浏览器在内的各种情况下提供帮助（也许是在线教程的一部分）。

快速开始

单击下面的按钮打开活页夹jupyter笔记本，您可以在摘要或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克隆https://github.com/grantps/superhelp.git $ python3 setup.py install

示例用例

• 夏洛特喜欢在其他人看到的代码之前检查她的代码

    import superhelp
    superhelp.this(warnings_only=True)
  

  在每个脚本的顶部。当她对代码感到满意时，她评论了这两行。

• Avi是一名Python初学者，想获得有关他写的五线功能的建议，以向人列表展示问候。他了解了Python惯例，以进行可变命名和更好的组合方式。

• 扎克想在一个命名的元组方面获得建议。他学会了如何将DOC字符串添加到各个字段。

• Noor正在考虑提交一些代码以堆叠溢出，但想先改进它（或可能直接获得解决方案的想法）。她发现列表理解可能起作用。她还首次意识到字典综合。

• Al写了一个简单的Python装饰器，但想看看是否有任何可以改进的东西。他从提供的示例中学习如何使用functool.wrap。

• Moana是一位经验丰富的Python开发人员，但往往会忘记她的功能中的Doc Strings之类的事情。她学习了一种标准方法，并开始更频繁地使用它。 Moana还发现概括有用。

• 保罗想在将其包含在项目中之前检查一些代码的质量。他了解一些问题，并在整合问题之前进行改进。

示例用法

HTML输出的屏幕截图

终端输出的屏幕截图

终端主题可用（“黑暗”和“光”）

从Markdown输出中的屏幕截图

在笔记本上使用SuperHelp

最终添加新单元格，例如：

 %%shelp

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

并运行它以获取建议。

笔记本电脑在顶部有更多详细的说明。

在本地安装上使用SuperHelp

在您的脚本中

将以下内容放在脚本的顶部，然后运行脚本（注意 - 文件两侧都有两个下划线）：

 import superhelp
superhelp.this()

如果您不想要默认的Web输出，则可以指定另一个输出，例如“ CLI”（命令行接口）或“ MD”（Markdown）：

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

如果您不想要默认的“额外”消息级别，则可以指定不同的详细级别（“简短”或“ main”）

 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