跳转到主要内容

一个flake8扩展,帮助使变量名更具可读性

项目描述

flake8-variables-names

Build Status Maintainability Test Coverage PyPI version PyPI - Python Version

一个flake8扩展,帮助使变量名更具可读性。

我们相信,变量名应该明确表示其包含的内容。这就是为什么我们尽量避免使用只有一个符号的变量名,或者避免使用过于常见的名称,如resultvalueinfo

这个扩展帮助检测这样的名称。默认情况下,它在非严格模式下工作。您可以使用 --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。确保所有检查都是绿色的。
  • 如果有,修复审查评论。
  • 表现得棒棒的。

以下是一些有用的提示

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解更多关于 安装包 的信息。

源代码分发

flake8_variables_names-0.0.6.tar.gz (5.3 kB 查看哈希值)

上传时间 源代码

构建分发

flake8_variables_names-0.0.6-py3-none-any.whl (6.1 kB 查看哈希值)

上传时间 Python 3

支持者

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面