“报告错误时收集信息的python工具。”
reportabug的Python项目详细描述
报告abug
报告错误时收集信息的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
(默认情况下,也是ghmd
和ghm
)之一,
markdown
(也是md
和m
),或者text
(也是t
)。一般来说,ghmarkdown
将对github问题有效并进行优化,而markdown
将更
纯粹的。
在windows上,可以通过管道到clip.exe
将输出存储在剪贴板上。
python -m reportabug [MODULE NAMES] | clip
一些个人信息将被隐藏,尽管其中包含不可逆的内容摘要,因为这些信息可能很重要。在共享之前,请记住查看报告中的个人信息。
有关示例报告,请参见issue #1。
API
目前,reportabug
没有公共api。但是,在命令行上指定的模块可能会公开一个_reportabug_info
生成器来提供附加信息。
def_reportabug_info(arg):yield'summary','summary line of text'yield'key',VALUE
每个键/值对都将添加到模块的结果部分。如果存在{{CD15}}键,如果存在一个选定的输出格式,它将被添加到摘要段。
arg
参数当前未定义,但将来可能会使用。
贡献
欢迎捐款。请随时提交问题或公关。
向报告中添加更多信息的请求应包括支持性证据,例如使用附加信息可以更快地诊断出的错误。
隐私
此工具不传输任何信息。在与其他人共享之前,请查看并从生成的报表中删除个人信息。