Python 风格
- 以下没有特别提到的,都遵循 Python 的 PEP8 约定,见Python 代码风格指南 PEP8 摘要。
PEP 8 中限制行长最多 79 个字符,但 Django 允许最多到 119 个字符(这是 GitHub 代码审查工具允许的宽度)。 PEP 8 限制文档、注释、docstring 的行长为 72 个字符, Django 将它们限制到 79 个字符。
使用 Flake8 来检查代码质量。
-
每层缩进使用 4 个空格
-
变量、函数、方法名中使用下划线
_
,而非 camelCase ,如应写成poll.get_unique_voters()
,而不要写成poll.getUniqueVoters()
-
类名和返回类的工厂函数名要用 InitiaCaps 形式
-
尽可能使用便捷式的
import
,比如使用from django.views.generic import View
,而不要用from django.views.generic.base import View
-
在 docstring