Django之代码风格

最新推荐文章于 2021-04-23 15:04:41 发布
最新推荐文章于 2021-04-23 15:04:41 发布
阅读量85 收藏
点赞数
文章标签： javascript python 开发工具 ViewUI
原文链接：http://www.cnblogs.com/dhcn/p/7121283.html
版权

1 代码风格

稍微关注一下下面这些代码标准风格指导规则将会对你大有益处，我们高度建议你通读词章，即便你此时可能正想跳过它。

1.1 让你的代码保持可读性的重要性

代码在读方面的重要性胜过写。一个代码块几分钟编写，花几个小时调试，然后有可能再也不会有人去碰它。然而当你去阅读那些昨天或者甚至10年以前编写的代码，清晰一致的代码风格就变得非常有用。清晰移动的代码能够让你不用去费劲去理解代码的不一致性，从而节省了自己的脑力，并且使代码易于维护，提高了各种规模项目的整体质量。

下面这些方法让你"多走一公里"使你的代码尽可能清晰易读：

  • 避免缩写的变量名称
  • 写出你的函数的参数名称
  • 对你的类和方法要写注释文档
  • 要对你的代码加注释
  • 把重复的代码重构为可复用的函数和方法
  • 使函数和方法短一点，一个好的经验法则是读函数和方法代码时不需要滚动鼠标(也就是函数或方法的长度不能大于一个屏幕的显示高度)

当你长时间不碰某段代码后，再重新拿起这段代码，你能很容易地找到当初是从哪儿中断编写工作的

缩写变量名是非常令人讨厌的。比如：当你看到一个balance_sheet decrease的变量名时，解释它肯定要比解释缩写版的bsd或者bal_s_d要容易。这种类型的缩写可能会帮你省一点输入时间，但是这种节省是以几小时甚至几天的技术(代码阅读)债为代价，所以这种节省不值当。

1.2 PEP8

PEP8是一个官方的Python代码风格指南。我们建议详细认真地阅读它并学会遵守PEP8的代码约定:(http://www.python.org/dev/peps/pep-0008/)

PEP8描述了类似下面这样的代码约定:

  • “每一级代码缩进使用4个空格”
  • “独立的顶级函数或者类定义语句下面必须有2个空行”
  • “类中的方法定义之间必须用一个空行隔开”

在Django项目中的所有python代码文件必须遵守PEP8。如果你记不住PEP8的代码规则，你可以为你的代码编辑器找一个检查你输入代码是否符合PEP8的插件。

当一个有经验的Python程序员在Django项目中看到对PEP8规范的严重违反，即便他当时什么也不说，也在想这是一件很坏的事情。关于这一点，一定要相信我们。

警告：不要改变现存项目的代码约定

PEP8的代码规范一般仅对新的Django项目产生约束，如果你新参与一个项目，这个项目使用的代码约定和PEP8规范不同，那你就遵守项目目前的代码约定即可。

请阅读PEP8规范的第8章节：愚蠢的一致性是令人讨厌的想法，这个规则正好适用于我们此时不死守PEP8规范的情况：

**构建技巧：使用flake8检查代码质量

flake8这个项目由Tarek Ziadé发起，由PyCQA小组维护，这是一个非常有用的检查项目代码风格、质量和逻辑错误的命令行工具。当你在本地开发时，可以把它作为持续集成的一个工具组件使用。

1.2.1 79字符限制

这不是开玩笑，我仍旧把命令行控制台控制在80个字符宽度

--- Barry Morrison：系统工程师兼本书每一个版本的审阅者

根据PEP8规范，每行的文本长度限制是79个字符。这样设计是因为79在文本环绕编辑器里面比较安全，开发团队在无需代码可读性的前提下即能够适应。

然后PEP8也提供一个弹性措施：可以为专属团队项目把这个限制提到99个字符。我们理解这个所谓的专属团队项目也就是非开源项目。

下面是我们的偏好设定：

  • 一个开源项目的行字符数必须硬性限制在79个字符以内，我们的经验已经证明：开源项目的代码贡献者和访问者会对代码行长度这个问题有抱怨。
  • 在私有项目上，我们把代码行长度限制放宽到99个字符，充分利用现代的显示器。

请阅读：(http://www.python.org/dev/peps/pep-0008/#maximum-line-length)

提示：Aymeric Augustin关于代码行长度问题的观点

Django核心开发者Aymeric Augustin曾说:"把代码行长度限制在79个字符这个限制，不是给变量、函数、类起糟糕名字的合理理由。给变量起一个可读性的名字比遵守几十年以前的硬件限制而引起的约束更重要。"

1.3 关于import语句的代码规范

PEP8规范建议import语句必须下面的规则排序分组：

  1. 标准库导入
  2. 相关的第三方库导入
  3. 本地应用或者特定库的导入

打我们开发一个Django项目时，import语句应该像下面例子这样

Example1.1

# Stdlib imports
from __future__ import absolute_import
from math import sqrt
from os.path import abspath

# Core Django imports
from django.db import models
from django.utils.translation import ugettext_lazy as _

# Third-party app imports
from django_extensions.db.models import TimeStampedModel

# Imports from your apps
from splits.models import BananaSplit

(注意：你在实际项目中不需要像上面这个例子这样注释import语句，此处的注释只是为了说明例子演示的规则)

Django项目中import语句的顺序是：

  1. 标准库导入
  2. 导入Django内建资源
  3. 从第三方App的导入，包括那些与Django没有关系的App
  4. 从Django项目所建App的导入(你将在第四章读到Django App相关的内容，第四章的主题是App设计基础)

1.4 使用显式相对路径导入

当你写代码时，使用显式相对路径导入这是很重要，因为这样可以让你便于移动、重命名、版本化你的模块包。在Python编程中，使用显式相对路径导入可以减少你的模块包的硬代码量要求，可以把模块包从它紧密依赖的架构环境中独立出来。因为Django App也是包的形式，所以个编码规则也适用于Django App编程。

为了演示显式相对路径导入方式的益处，让我们看一个例子：

假定下面的代码片段摘自一个冰激凌消费量跟踪Django项目,其中消费的冰激凌品类包括你们曾经吃过的华夫、甜筒、暴风雪。

哦，不，你的cones Django App里面有全路径硬编码导入，这太糟了:

Bad Example 1.1 
# cones/views.py
from django.views.generic import CreateView
# DON'T DO THIS!
# Hardcoding of the 'cones' package
# with implicit relative imports
from cones.models import WaffleCone 
from cones.forms import WaffleConeForm 
from core.views import FoodMixin

class WaffleConeCreateView(FoodMixin, CreateView):
    model = WaffleCone
    form_class = WaffleConeForm

确实，你的cones App在你的冰激凌消费量跟踪项目里面可以正确执行，但是它里面的那些硬编码导入会使它本身的可移植性和可复用性非常差:

  • >如果你想在另外一个跟踪通用甜食的Django项目中复用你的cones App,而同时却因为命名冲突不得不修改App的名字,你会怎样做？
  • >如果你有时候只是简单想改App的名字，那怎么做？

如果硬编码绝对路径导入，你在修改时就不能只改App的名字，而是不得不找到所有的此类导入并全部修改。虽然手工修改他们不难，但在你驳回相对路径导入这个办法前，请想想与那些带有各种各样的附加功能模块的App相比，上面这个例子是非常简单的。

现在让我们把上面这个硬编码绝对路径导入的代码片段改造成相对路径导入的好代码，下面是修正后的例子：

Example 1.2
# cones/views.py
from __future__ import absolute_import
from django.views.generic import CreateView

# Relative imports of the 'cones' package
from .models import WaffleCone
from .forms import WaffleConeForm
from core.views import FoodMixin

class WaffleConeCreateView(FoodMixin, CreateView):
    model = WaffleCone
    form_class = WaffleConeForm

另外一个具体的优势是我们可以立即辨别出本地导入和全局导入，强调Python包是一个代码单元这一点。

提示："from future import absolute_import"语句的使用

Python3以一种更好的方式更新和改进了import语句运行机制。幸运的是：我们可以使用from __future__ import absolute_import这条语句做到对Python2.7向后兼容。即使你不计划使用Python3,但是考虑到下面表中的相对路径导入，这也是一个很棒的方法。

总结一下，下面的表格给出了不同的Python导入类型以及在Django项目中何时使用它们。

导入代码导入类型使用场景
from core.views import FoodMixin绝对路径导入从目前App外部导入
from .models import WaffleCone显式相对路径导入从目前App的另一个模块导入
from models import WaffleCone隐式相对路径导入从目前App的另一个模块导入，但不推荐这么做

表格 1.1 导入类型 绝对路径导入 VS 显式相对路径导入 VS 隐式相对路径导入

养成使用显式相对路径导入的习惯，这非常容易做到，而且这也是一个Python程序员开发好习惯。

提示：PEP328规范不和PEP8规范冲突吗?

请看Python创始人吉多·范罗苏姆是怎么说的：

相关阅读: http://www.python.org/dev/peps/pep-0328/

1.5 避免使用import *

在我们所有工作中的99%的情况下，我们都应该显式导入每个模块：

Example 1.3

from django import forms 
from django.db import models

不要写下面这样的代码：

Bad Example 1.2
# ANTI-PATTERN: Don't do this! 
from django.forms import * 
from django.db.models import *

不这样做的原因是避免银式导入另外一个python模块的内部变量而导致覆盖目前模块命名空间内的变量，那样会导致不可预知的结果，有时甚至是灾难性的结果。

我们将在本书内容中讲解一个此规则的例外情况，这个例子将在第五章(章名以后再译)中出现。

我们再来看一下上面的反面案例,在Django models库模块和Django forms库模块中都有一个叫CharField的类，models库中的类会覆盖掉forms库中的同名类，这种情况也会发现在Python内建库和其他第三方库之间，那样就会导致关键功能特性对象被覆盖。

警告：Python命名冲突 假如你试图导入两个具有相同命名的对象时，也会发生相同的相似的命名覆盖问题

Bad Example 1.3
# ANTI-PATTERN: Don't do this! 
from django.forms import CharField 
from django.db.models import CharField

使用import *方式，就像一个贪婪的客人进入冰激凌店后试品了所有三十一种口味冰激凌，最后却只买了1到2个球。如果你只使用模块中1到2个对象，就不要试图导入模块中所有的对象引用。

当然如果客人走出冰激凌店的时候捧着一个巨大的冰激凌碗，而里面盛着几乎所有口味的冰激凌球，当然，这是另外一回事了。

1.6 Django代码风格

这一节内容将会覆盖Django官方代码约定规范以及非官方但是普遍被接受的代码规范

1.6.1 考虑一下Django代码风格指南

不用说，熟悉通用Django风格约定是个好做法。实际上，Django内部有它自己的代码风格指南，这个指南基于PEP8扩展而成。

另外，如果有内容不在官方代码标准里面明确指明，那在Django社区也会有非常常见的此类代码风格约定可以供你在项目中使用。

1.6.2 在ULR模式名称定义里使用下划线而不是破折号(中划线)

我们日常使用下划线(字符"-")而不是破折号(字符"-"),这样做不仅仅是因为更Pythonic,而且对更多的IDE和文本编辑器也更友好。注意我们这里下面例子里说的是url()函数的name参数的值，而不是浏览器里面实际输入的URL片段(译注：正则表达式那段)。

像下面这样在url名称里面用中划线是错误的方式：

Bad Example 1.4
patterns = [
    url(regex='^add/$',
        view=views.add_topping,
        name='add-topping'),
    ]

正确的方式，是在url名称里面用下划线：

Example 1.4
patterns = [
    url(regex='^add/$',
        view=views.add_topping,
        name='add_topping'),
    ]

注意：我们这里指的是url函数name参数的值，不是浏览器实际输入的URL片段，在URL片段里面用中划线是可以的，(比如:regex='^add-topping/$')。

1.6.3 在模板block名称里面用下划线，而不是中划线

与在URL模式名称里面用下划线一样的原因，我们建议在定义模板block时也使用下环线：这样的话就可以更Pythonic且对编辑器更友好。

1.7 选择JavaScript、HTML和CSS的代码风格指南

1.7.1 JavaScript代码风格指南

不像Python有官方的代码风格指南，JavaScript不存在官方代码风格指南，相代替的是，有很多个人或公司编纂的的javascript非官方代码风格指南:

在Django或JavaScript社区对于上面的代码风格指南都没有一致的意见，你只需要选择你偏好的并坚持它即可。

当然，如果你使用一个自带代码风格约定的JavaScript框架，你就应该使用它自带的代码约定。比如ember.js就有其自带的代码约定。

包提示：JSCS代码风格审查器

JSCS( http://jscs.info/ ) 是一个JavaScript代码风格审查工具。它预设好几种JavaScipt代码风格指南的编码规则,包括前面列出的代码约定中的一些。有面向好几种代码文本编辑器的JSCS插件，还有面向Gulp和Grunt之类构建工具的JSCS检查任务脚本。

1.7.2 HTML和CSS代码风格指南

包提示：CSScomb

CSScomb ( http://csscomb.com/ )一个CSS代码风格格式化工具。它检查你预配置好的风格的代码一致性和CSS属性的排序规则，就像JSCS一样，CSScomb也有面向文本编辑器的插件和面向任务构建工具的插件，其中包括面向brunch这样的HTML5构建工具的版本。

1.8 不要面向IDE(或者文本编辑器)编程

某些程序员在做出关于项目的文件布局和封装实现的选择时可能是基于IDE(集成开发环境)的特性来考虑,这对于那些选择不同不同开发工具的程序员试图来探索你的项目代码时将变得非常困难。

经常假设你身边的程序员和你采用不同的工具，并且你的项目代码结构足够清晰易懂，以便于他们即使使用NotePad或者Nano都可以探索你的代码。

比如：深思模板标签且查看标签源码对于那些使用功能有限的IDE工具的程序员来说是非常困难切耗时的，因此我们使用约定的标签模块命名方式：_tags.py。

1.9 小结

这一章包括了我们推荐的代码风格指南以及解释我们偏好每个技巧的原因。

即使你不遵守我们推荐的代码约定，也请你遵守任何一个统一的代码风格指南。有多种代码风格的项目代码是不易维护的，并且会拖慢快发速度且提高发生开发失误的可能性。

转载于:https://www.cnblogs.com/dhcn/p/7121283.html

dechen6073
关注
Django 官方代码风格指南学习摘要
haiiiiiyun的博客
03-24 135
Python 风格 以下没有特别提到的，都遵循 Python 的 PEP8 约定，见Python 代码风格指南 PEP8 摘要。 PEP 8 中限制行长最多 79 个字符，但 Django 允许最多到 119 个字符（这是 GitHub 代码审查工具允许的宽度）。 PEP 8 限制文档、注释、docstring 的行长为 72 个字符， Django 将它们限制到 79 个字符。 使用 Fla...
Django代码编写规范
sinat_28371057的博客
02-15 991
1. 编码声明 在 Python 解释器执行代码时，需要告诉解释器代码的编码方式。Python 代码实际上是文本数据，如果代码的编码方式与解释器读取的编码方式不一致，将会因编码错误，代码无法执行。Python 2 解释器读取代码时，默认的编码方式是 ASCII，而如果在代码中出现非 ASCII 码的字符时，就会报错。这时，就需要声明 Python 代码的编码方式。 1.1 设置解释器读取代码的编码格式 为了统一 Python 解释器读取代码的格式，建议在代码文件头部统一添加，utf-8 的编码设置：
django源代码
09-21
python写的前段web框架
Django风格指南
12-01 181
Django风格指南 Django风格指南，给Django使用者的一些关于目录结构、使用的建议。该指南中所有的例子你都可以在DeerU(https://github.com/gojuukaze/DeerU)项目中找到。 项目地址：https://github.com/gojuukaze/d...
django 代码
weixin_30830327的博客
05-15 192
Django 代码 day1 不含文件的初级版本 连抄带改 import socket from threading import Thread server = socket.socket() server.bind(('127.0.0.1',8001)) server.listen() def func(conn): # 接受请求数据 # 自从用了这个之后 不接收就不渲染...
PYTHON之Django Web框架源码下载
03-10
Django框架是Python编程语言驱动的一个开源模型-视图-控制器（MVC）风格的Web应用程序框架。使用 Django，我们在几分钟之内就可以创建高品质、易维护、数据库驱动的应用程序。 Django框架的核心组件有： 1、用于...
Python Django实现layui风格+django分页功能的例子
09-18
在Python的Django框架中，实现layui风格的分页功能是一项常见的需求，这不仅可以提高用户体验，还能有效地管理大量数据的展示。layui是一个流行的前端UI框架，它的设计简洁、优雅，与Django的后端功能结合可以创建出...
Django Web框架源码下载
最新发布
03-10
Django是Python编程语言驱动的一个开源模型-视图-控制器（MVC）风格的Web应用程序框架。使用 Django，我们在几分钟之内就可以创建高品质、易维护、数据库驱动的应用程序。 Django框架的核心组件有： 1、用于创建...
vscode-theme-django:VS代码的Django主题
04-11
其中，Django主题是专为Python的Django框架用户设计的一种主题风格，它旨在提升开发者在编写Django项目时的代码阅读和编辑体验。 Django主题的核心特点在于其色彩搭配和代码高亮，它通常采用对比度适中的颜色，使得...
Django示例代码
08-07
Django is a high-level Python Web framework that encourages rapid development and clean, pragmatic design. Built by experienced developers, it takes care of much of the hassle of Web development, so you can focus on writing your app without needing to reinvent the wheel. It’s free and open source.
Django电商网站全代码
01-26
django开发的生鲜蔬果电商网站平台。基本功能已经实现，数据库搭建完成。双向登录检测，购物车搭建，商城货架搭建等等
django学习 代码
盖乌斯的博客
04-26 266
#templates/app1/login.html#先写登录页面<form action = '/app1/login/' method='POST'> <p><input name = 'username'/></p> <p><input name = 'password'/></p> <p&am
Django Restful 风格设计
xiameimei_win的博客
12-21 317
RESTful Api设计风格 协议：API 与用户的通信协议，总是使用 HTTPS 协议 域名：应该尽量将 API 部署在专用域名之下，如果确定 API 很简单，不会有进一步的扩展，可以考虑放在主域名之下。 版本： 应该将 API 的版本放在 URL 中：https://www.shanghui.xiaxia/api/v1.0 将版本号放在 HTTP 头信息中：https://www.s...
22.Django三种风格的模型继承
Daniel
10-12 247
文章目录 1.Django 中的 model 继承和 Python 中的类继承非常相似，只不过你要选择具体的实现方式：让父 model 拥有独立的数据库；还是让父 model 只包含基本的公共信息，而这些信息只能由子 model 呈现。 基类，指的是继承了model.Model且没有生成表，而是作为基类或公共类被其他类继承 只要继承了model.Model， 就会生成一个新的表，但是，如果在Meta方法中添加abstract=True，就不会产生新的表，而是作为一个基类存放多个表共同拥有的方法和字段等
Django框架 -- 使用restful设计风格
weixin_42912498的博客
07-30 240
1）RESTful设计风格的API，每种请求方法，都对应后端一种数据库操作 2）views.py from django.http import HttpResponse, JsonResponse from django.views.generic.base import View from .models import Plan class PlansAPIView(View): def get(self, request): queryset = Plan.objec
Django3—设计模式
weixin_45666249的博客
02-01 146
MVC设计模式 经典MVC模式中，M是指业务模型，V是指用户界面，C则是控制器，使用MVC的目的是将M和V的实现代码分离，从而使同一个程序可以使用不同的表现形式。其中，View的定义比较清晰，就是用户界面。 MTV设计模式 MVC的变种，具体如图 MVVM设计模式 MVVM是Model-View-ViewModel的简写。它本质上就是MVC 的改进版。MVVM 就是将其中的View 的状态和行为抽象化，让我们将视图 UI 和业务逻辑分开。 参考链接：https://www.cnblogs.com/xiao
django常用代码
舔舔柠檬
04-23 275
运行服务器命令如下： python manage.py runserver ip:端口 python manage.py runserver 可以不写IP和端口，默认IP是127.0.0.1，默认端口为8000。 创建后台管理账户： python manage.py createsuperuser 用来同步models中的模型类，将模型类写到子应用中的那个装数据的文件夹(migrations)， python manage.py makemigrations 根据子应用中装数据的文件夹(migra
Djangon常用代码
qq_39655431的博客
10-26 216
一、实现逻辑删除： is_delete = models.BooleanField(default=False) dafault = False 二、验证(多属性判断) def validate(self,attrs): #能获取多个属性 # attrs表示请求报文中所有的属性与值，类型为字典 def validate_username(self, value): #获取一个属性 # 2.验...
Python Django框架代码示例及学习笔记
资源摘要信息:"本资源为Django代码示例以及相关笔记，适合对Python后端开发以及Django框架感兴趣的学习者下载和研究。Django是一个高级的Python Web框架，由经验丰富的开发人员设计，旨在快速、安全和可扩展的方式...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值