报告错误

用于在报告错误时收集信息的 Python 工具。

安装

python -m pip install git+https://github.com/zooba/reportabug
python -m pip install reportabug

目前建议直接从 GitHub 安装，因为并非所有改进都发布到 PyPI。

用法

reportabug [--format FORMAT] [MODULE NAMES]
python -m reportabug [--format FORMAT] [MODULE NAMES]

报告将输出到控制台。您应该将其复制粘贴到您的错误报告中。

FORMAT可以是ghmarkdown(default, Also ghmdand ghm), markdown(also mdand m), 或text(also t) 之一。一般来说，ghmarkdown 会针对 GitHub 问题进行有效和优化，同时markdown会更纯粹。

在 Windows 上，您可以通过管道clip.exe将输出存储在剪贴板上。

python -m reportabug [MODULE NAMES] | clip

一些个人信息将被隐藏，但包含其内容的不可逆转的摘要，因为这些信息可能很重要。请记住在共享之前查看您的报告以获取个人信息。

有关示例报告，请参见问题 #1 。

API

目前，reportabug没有公共 API。但是，在命令行上指定的模块可能会公开_reportabug_info生成器以提供附加信息。

def _reportabug_info(arg):
    yield 'summary', 'summary line of text'
    yield 'key', VALUE

每个键/值对都将添加到模块的结果部分。如果summary键存在，如果存在用于所选输出格式的键，它将被添加到摘要部分。

该arg参数当前未定义，但将来可能会使用。

贡献

欢迎投稿。随时提交问题或 PR。

向报告添加更多信息的请求应包括支持证据，例如使用附加信息可以更快地诊断出的错误。

隐私

此工具不传输任何信息。在与其他人共享之前，请查看并从生成的报告中删除个人信息。