该包为flake8插件编写提供基类和实用程序
flake8-plugin-utils的Python项目详细描述
flake8插件实用程序
这个包为flake8插件的编写提供了基类和实用程序。
安装
pip install flake8-plugin-utils
示例
编写简单的插件
fromflake8_plugin_utilsimportError,Visitor,PluginclassMyError(Error):code='X100'message='my error'classMyVisitor(Visitor):defvisit_ClassDef(self,node):self.error_from_node(MyError,node)classMyPlugin(Plugin):name='MyPlugin'version='0.1.0'visitors=[MyVisitor]
并用pytest进行测试
fromflake8_plugin_utilsimportassert_error,assert_not_errordeftest_code_with_error():assert_error(MyVisitor,'class Y: pass',MyError)deftest_code_without_error():assert_not_error(MyVisitor,'x = 1')
格式化
您的Error
可以在其message
:
fromflake8_plugin_utilsimportError,Visitor,assert_errorclassMyFormattedError(Error):code='X101'message='my error with {thing}'classMyFormattedVisitor(Visitor):defvisit_ClassDef(self,node):self.error_from_node(MyFormattedError,node,thing=node.name)deftest_code_with_error():assert_error(MyFormattedVisitor,'class Y: pass',MyFormattedError,thing='Y',)
许可证
麻省理工学院
更改日志
未发布
- 。
1.0.0-2019年5月23日
- 将消息格式添加到错误中
0.2.1-2019年4月1日
- 不要在src dedent in error之前从src剥离
- add is_none,is_true,is_false util函数
0.2.0-2019.02.21
- 添加断言方法
0.1.0-2019.02.09
- 首字母