代码规范

| 标签 python  code  rule  浏览次数: -

参考

行的最大长度

限制每行的最大字符是 79 个。 对于结构限制 对于结构限制 对于结构限制 较少 的文本 的文本 长块(文档字符串或注释),限制在 72 个字 符内。

注释

  • 记录写代码过程中的思考,简单准备的描述
  • 不要使用尾注释(容易被整行拷贝、不容易被编辑修改、逐渐腐烂)不理解
  • 不需要的代码删除维护到版本库,写明commit info
  • 注释应注重为何做,而不是怎么做

命名

  • bool类型值使用is_前缀

pylint检查

  • pip 安装

pip install pylint

  • apt-get安装

sudo apt-get install pylint

  • 生成配置文件
pylint --persistent=n --generate-rcfile > .pylintrc
  • 检查单个文件
find . -name "*.py" | xargs pylint

pylint --rcfile=.pylintrc test.py

若不指定 --rcfile 参数,默认值使用当前根目录下的 .pylintrc 文件

  • 检查整个包
find . -name "__init__.py" | grep -Eo "^/.+/" | xargs pylint

find . -name "__init__.py" | grep -v "venv" | awk '{sub(/.{11}$/,"")}1' | xargs pylint
  • 错误类型
(C) 惯例。违反了编码风格标准

(R) 重构。写得非常糟糕的代码。

(W) 警告。某些 Python 特定的问题。

(E) 错误。很可能是代码中的错误。

(F) 致命错误。阻止 Pylint 进一步运行的错误。

pygenie

代码打分(建议所有的函数复杂度都低于5)

clonedigger

代码查重工具


上一篇 Web框架对比     下一篇 log打印规范
目录导航