flake8扩展,有助于创建更可读的变量名
flake8-variables-names的Python项目详细描述
flake8变量名
flake8的一个扩展,有助于创建更可读的变量名。
我们相信,变量名应该清楚地显示出它所包含的内容。
这就是为什么我们不使用只有一个符号的varnames或者不使用
太常见的名称,例如result
、value
或info
。
此扩展有助于检测此类名称。默认情况下,它在
非严格模式。你可以用--use-varnames-strict-mode
来改变它。
参数结束扩展变量名黑名单甚至更多。
安装
pip install flake8-variables-names
示例
示例文件:
# test.pya=1foo=2result=a+foo
用法:
$ flake8 test.py test.py:1:1: VNE001 single letter variable names are not allowed test.py:2:1: VNE002 variable name should be clarified
在Python3.6和Flake8 3.5.0上测试。
贡献
我们希望你能为我们的项目做出贡献。很简单:
- 用你发现的bug或者你的提议制造一个问题。等待维护人员批准。
- 创建拉取请求。确保所有支票都是绿色的。
- 修正评论。
- 太棒了。
以下是一些有用的提示:
- 您可以使用
make check
运行所有检查和测试。请在特拉维西之前做。 - 我们用BestDoctor python styleguide。抱歉,StyleGuide目前只提供俄语版本。
- 我们尊重Django CoC。软一点,不要胡说。