一个flake8扩展,帮助使变量名更具可读性
项目描述
flake8-variables-names
一个flake8扩展,帮助使变量名更具可读性。
我们相信,变量名应该明确表示其包含的内容。这就是为什么我们尽量避免使用只有一个符号的变量名,或者避免使用过于常见的名称,如result
、value
或info
。
这个扩展帮助检测这样的名称。默认情况下,它在非严格模式下工作。您可以使用 --use-varnames-strict-mode
参数将其更改,并进一步扩展变量名称黑名单。
安装
pip install flake8-variables-names
示例
示例文件
# test.py
a = 1
foo = 2
result = 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
错误代码
错误代码 | 描述 |
---|---|
VNE001 | 不允许使用单个字母变量名,如'XXX'。 |
VNE002 | 变量名'XXX'需要明确。 |
VNE003 | 不允许变量名覆盖内置函数。 |
贡献
我们非常欢迎您为我们项目做出贡献。这很简单
- 创建一个问题,报告您找到的bug或您提出的建议。等待维护者的批准。
- 创建一个pull request。确保所有检查都是绿色的。
- 如果有,修复审查评论。
- 表现得棒棒的。
以下是一些有用的提示
- 您可以使用
make check
运行所有检查和测试。请在此之前执行。 - 我们使用 BestDoctor Python 编码规范。
- 我们尊重 Django 行为准则。做正确的事,不要胡说八道。
项目详情
下载文件
下载适合您平台的文件。如果您不确定选择哪个,请了解更多关于 安装包 的信息。
源代码分发
flake8_variables_names-0.0.6.tar.gz (5.3 kB 查看哈希值)
构建分发
关闭
哈希值 for flake8_variables_names-0.0.6-py3-none-any.whl
算法 | 哈希摘要 | |
---|---|---|
SHA256 | 4aff935d54b3f7afcd026b4dae55029877bd05a7c507b294b45bc7bf577d7b47 |
|
MD5 | a38953e0328dd3302cfd97d825857d3c |
|
BLAKE2b-256 | 3ae8845c33c7ac0f6c495c5cbcfebc6a281b28017570f2edea65b24daaed47f0 |