自定义错误消息
error-explainer的Python项目详细描述
错误解释程序
这是一个针对想要创建自定义错误检查的工具开发人员的项目 为Python中的不同错误提供更好的消息,改进位置、准确性和消息质量。在
一些语法错误的检查是现成的。在
当前可用的检查可以在error-explainer/messages.py
中找到
安装
要安装此软件包,请使用pip install error-explainer
使用
检查Python文件中是否存在可能的错误
fromerror_explainer.check_runnerimportrun_checksmessages=run_checks("path/to/file")
消息将是包含生成消息的字符串列表。在
添加新的自定义检查
在调用run_checks()时,可以将自定义检查添加到运行的检查列表中。
要添加新的检查,请使用@add_check(force: bool, level=99)
注释。Force参数定义
仅当代码未编译(False)或始终不编译(True)时才运行check
检查也在从0到99的多个级别中运行。
当前图层如下:
- 0-docstring错误,引号错误
- 1-缺少匹配括号错误、缺少括号错误、python 2样式打印使用错误
- 2-无效函数定义错误
- 3-缺少冒号错误,无效的赋值错误
- 99-缩进错误,在赋值错误中使用coma代替句点
管理消息
支票中使用的消息可以是:
已添加
fromerror_explainer.messagesimportcreate_message# message text can contain arguments in curly brackets these can be later given values using kwargscreate_message("code_for_the_message","Message text with {dynamic_arguments}")
已删除
fromerror_explainer.messagesimportremove_messageremove_message("code_for_the_message")
覆盖
fromerror_explainer.messagesimportoverwrite_messageoverwrite_message("code_for_the_message","Message text with {dynamic_arguments}")
- 项目
标签: