2、Django开发总结：官方推荐编码规范
每种编程语言或框架都有自己的编码规范, 基于Python语言的Django框架也不例外。代码规范提供的指导方针旨在提高代码的可读性，并使其在各种Python代码中保持一致。
Python编码规范
Django是Python语言写成的框架，所以其代码也要求符合Python的PEP8编码规范PEP 8 只是个指南，并非强制约束。可以使用Flake8来辅助检测的Python代码是否规范，使用pip安装即可。
PyCharm已自带代码检查工具，使用时还推荐使用.editorconfig文件来配置编码规范，比如html中使用2个空格做缩进。
- 使用4个空格做缩进。
- 系统性移除代码里多余的空格。
- 函数名用小写。
- 类名首字母大写（ShowCase）的方式命名（或能够返回类的工厂函数）。
- PEP8规范里每行代码字符数要求不超过79个，而Django允许每行最多119个字符, 这是GitHub代码审查时可以接受的每行代码的最大长度。
- 如果有一行代码非常长，建议使用如下方式换行。括号单独成行，依然使用4个空格为每行内容做缩进：
raise AttributeError(
'Here is a multiline error message '
'shortened for clarity.'
)
而不是采用如下垂直对齐的方式（这是很多新手易范的错误):
raise AttributeError('Here is a multiline error message '
'shortened for clarity.')第一种方式更好的原因是，当需要改变某行文字内容时，不需要再进行手动对齐了。
- 字符串的引号使用
Django对字符串推荐使用单引号，只有当字符串本身里包含单引号时才使用双引号。对于三引号docstring注释，Django推荐3个双引号，如下所示：
def test_foo():
"""
A test docstring looks like this (#123456).
"""
pass
导包(import)
- 包的导入规范
导包时要注意区分哪些是来未来的，哪些是python的标准库，哪些是第三方包，哪些是Django自带的标准包以及开发者自己编写的包。对于Django自带的包使用绝对路径，对于开发者自己编写的包, 使用相对路径。
另外还需要注意最后一行导包(import)与自己代码之间的空格距离，与一般模块代码空格一行即可，但与的第一个函数或类必需空格两行。
- 没有用到的包或import需要移除。
示范代码如下所示：
# future
from __future__ import unicode_literals
# standard library
import json
from itertools import chain
# third-party
import bcrypt
# Django
from django.http import Http404
from django.http.response import (
Http404, HttpResponse, HttpResponseNotAllowed, StreamingHttpResponse,
cookie,
)
# local Django
from .models import LogEntry
# try/except
try:
import yaml
except ImportError:
yaml = None
CONSTANT = 'foo'
class Example:
# ...
还可以使用isort帮实现自动化导包顺序，使用如下命令即可：
python -m pip install isort >= 5.1.0
isort -rc .模板风格
- 对于模板中的变量，遵循大括号及标签内容之间使用一个（只需一个）空格
# Good
{{ foo }}
# Bad
{{foo}}视图风格
- 对于函数视图，第一个参数永远是request, 不要擅自修改, 应该被命名为 request。
# Right
def my_view(request, foo):
# ...
# Wrong
def my_view(req, foo):
# ...
模型风格
- 模型的字段应该是小写字母，可以使用下划线连接，不要使用驼峰命名。
# Good
class Person(models.Model):
first_name = models.CharField(max_length=20)
last_name = models.CharField(max_length=40)
# Bad
class Person(models.Model):
FirstName = models.CharField(max_length=20)
Last_Name = models.CharField(max_length=40)
- 模型的Meta选项应该在自定义模型字段最后，且与最后一条字段间有一空行。
class Person(models.Model):
first_name = models.CharField(max_length=20)
last_name = models.CharField(max_length=40)
class Meta:
verbose_name_plural = 'people'model内的类和方法的定义顺序应该遵循如下顺序
有时需要给模型定义__str__方法，重写save方法或自定义其它方法，这些方法应该放在Meta选项后面，且遵循下面的顺序（不是所有项都是必需的）：
- 定义的模型字段
- 定制的Manager（管理器属性）方法
- class Meta选项
- def __unicode__()
- def __str__()
- def save()
- def get_absolute_url()
- 其它自定义方法
- 如果一个 model 字段定义了 choices，那么定义的多元元组的名称应该全部大写。
class MyModel(models.Model):
DIRECTION_UP = 'U'
DIRECTION_DOWN = 'D'
DIRECTION_CHOICES = (
(DIRECTION_UP, 'Up'),
(DIRECTION_DOWN, 'Down'),
)django.conf.settings的使用
模块不常用的设置项被储存在 django.conf.settings 中
模块通常不应使用存储在django.conf.settings中的顶级设置（即在导入模块时进行评估）。：
允许手动配置设置（即不依赖于DJANGO_SETTINGS_MODULE环境变量），并且可能如下：
from django.conf import settings
settings.configure({}, SOME_SETTING='foo')但是，如果在settings.configure行之前访问了任何设置，则此操作将不起作用。（在内部，设置是一个LazyObject，如果尚未配置，则在访问设置时会自动配置它自己）。
因此，如果有一个模块包含如下代码：
from django.conf import settings
from django.core.urlresolvers import get_callable
default_foo_view = get_callable(settings.FOO_VIEW)
…然后导入此模块将导致配置设置对象。这意味着，第三方在顶级导入模块的能力与手动配置设置对象的能力不兼容，或者在某些情况下非常困难。
必须使用一定程度的惰性或间接性来代替上面的代码，例如django.utils.functional.LazyObject, django.utils.functional.lazy() 或 lambda.。
其他项
- 标记所有字符串以进行国际化，国际化时按规范标记所有需要翻译的字符串，有关详细信息，请参阅i18n文档。
- 删除在更改代码时不再使用的导入语句。此任务最常用的工具是pyflakes和pylint。
- 系统地从代码中删除所有尾部空白，因为这些空白会添加不必要的字节，给补丁添加视觉混乱，偶尔还会导致不必要的合并冲突。一些IDE可以配置为自动删除它们，大多数VCS工具可以设置为在diff输出中突出显示它们。然而，请注意，只删除空白（或只为标称的PEP 8一致性进行更改）的补丁可能会被拒绝，因为它们只引入噪声而不是代码改进。下次在该区域更改代码时，请整理好。
- 请不要在您贡献的代码中输入您的姓名。策略是将贡献者的名字保存在与Django一起分发的AUTHORS文件中，而不是分散在整个代码库中。
最后，关于编码规范开发辅助类的工具使用，参考下篇文章：企业开发中的编码规范校验和代码提交规范校验工具使用。介绍pre-commit、pep8编码规范检查工具flake8、导包规范工具isort、删除不再使用的导入语句pyflakes、pylint等工具的实际使用。
参考资料
- Django官方规范指南：Coding style | Django documentation | Django
- JavaScript规范指南：JavaScript | Django documentation | Django
- PEP 8规范指南：https://peps.python.org/pep-0008/
- pep8检查工具：pep8 · PyPI