Python代码风格与编程习惯重要吗?
Python代码风格
首先我们要以 PEP8 代码规范为标准,但也无需完全遵守。例如:一行不能超过 79 个字符等。
Python模块模板
模块开头指定编码格式
模块文档注释,展示模块的信息,信息内容自己决定,如:
- Author,作者
- Desc,模块描述
- Date,创建时间
有一个 main()
函数
有一个程序主入口 if __name__ == '__main__':
#!/usr/bin/python3 # -*- coding:utf-8 -*- # @Author: Hui # @Desc: { 项目主入口模块 } # @Date: 2020/05/21 13:04 def main(): print('Hello Python') if __name__ == '__main__': main()
main()
函数方便用于测试当前模块功能。
import 导入
import
导入,避免使用 from ... import *
,因为这可能导致模块、类、变量名重复而导致错误。
我自己的 import
代码风格有两种。
由短到长
根据代码的长度由短到长依次导入,import
过度到 from ... import ...
,换行分割可有可无,我是根据 from ... import ...
前面的 import
的数量和整体美观来决定要不要换行。
import os import sys import time import random import config import pygame import requests import numpy as np from PIL import Image from threading import Thread from datetime import datetime
分类导入
分类导入,是分好类后在根据代码的长度由短到长依次导入,主要有:
- Python内置模块
- Python自建模块
- Python第三方库
# Python内置模块导入 import os import sys import time import random from threading import Thread from datetime import datetime # Python自建模块、第三方库导入 import config import pygame import requests import numpy as np from PIL import Image
导入顺序依次为
Python内置模块 --> Python自建模块 --> Python第三方库
根据自己的风格,导入的自建模块、Python第三方库少时可以在一起无需换行
导入的自建模块少时可以跟Python内置模块在一起,就是转换成 由短到长 的风格
建议
导入模块代码风格无需照搬照抄地遵循,我们做任何的优化就是为了让代码更好看,结构清晰,无需刻意遵循死规则、烂规则,应该活学活用,创新变化,学习别人优秀的方案,总结出适合自己的。
例如:
假如import
导入语句比 from
导入语句更长,要遵循或者纠结 import
是要在 from
导入语句前面还是由短到长排放呢?
import numpy as np import multiprocessing from PIL import Image
import numpy as np from PIL import Image import multiprocessing
无需太过纠结、抠字眼,两种导入风格都可以。
Django代码范例
封装html的url网址
渲染 html
页面,把 html
的存放路径总体封装到一个类里面。
class BookView(object): """图书模块视图类""" # 图书首页 INDEX_VIEW = 'book/index.html' # 图书信息页 BOOK_INFO_VIEW = 'book/book_info.html' # 英雄信息页 HERO_INFO_VIEW = 'book/hero_info.html' # 定义视图函数 def index(request): """ 图书首页 """ data = { 'content': 'hello world', 'list': list(range(1, 10)), } return render(request, BookView.INDEX_VIEW, data) def show_book(request): """ 展示图书信息界面 """ book_list = BookInfo.objects.all() data = { 'book': book_list } return render(request, BookView.BOOK_INFO_VIEW, data)
封装注册的提示错误信息
返回页面提示的错误信息,统一封装到字典中,提高代码可读性、扩展性。
初始版本
class UserView(object): """用户模块视图类""" LOGIN_VIEW = 'user/login.html' REGISTER_VIEW = 'user/register.html' USER_CENTER_VIEW = 'user/user_center.html' def register(request): username = request.get('username') password = request.get('password') email = request.get('email') allow = request.get('allow') # 校验注册项是否有空值 # all()中有一个为空返回False,都有值则True if not all([username, password, email]): return render(request, UserView.REGISTER_VIEW, {'error_msg': '数据不完整'}) # 校验是否勾选(同意)用户协议 if allow != 'on': return render(request, UserView.REGISTER_VIEW, {'error_msg': '请勾选用户协议'}) # 校验用户名是否重复 try user = User.object.get(username=username) except User.DoesNotExists: user = None if user: return render(request, UserView.REGISTER_VIEW, {'error_msg': '该用户已存在'}) return render(request, 'register.html')
可以看到在返回响应数据时代码大致一样,只有提示信息不一样
return render(request, UserView.REGISTER_VIEW, {'error_msg': '数据不完整'}) return render(request, UserView.REGISTER_VIEW, {'error_msg': '请勾选用户协议'}) return render(request, UserView.REGISTER_VIEW, {'error_msg': '该用户已存在'})
因此封装后的版本
def register(request): username = request.get('username') password = request.get('password') email = request.get('email') allow = request.get('allow') error_msg = { 'email_error': '邮箱格式不正确', 'user_exists': '该用户已存在', 'data_error': '数据不完整', 'user_protocol': '请勾选用户协议', } # 返回页面的数据 data = dict() # 校验注册项是否有空值 # all()中有一个为空返回False,都有值则True if not all([username, password, email]): data['error_msg'] = error_msg['data_error'] # 校验是否勾选(同意)用户协议 elif allow != 'on': data['error_msg'] = error_msg['user_protocol'] else: # 校验用户名是否重复 user = User.object.filter(username=username) if user: data['error_msg'] = error_msg['user_error'] else: pass return render(request, UserView.REGISTER_VIEW, data)
# 校验用户名是否重复 try user = User.object.get(username=username) except User.DoesNotExists: user = None
优化后
User.object.filter(username=username)
get
获取不到数据会报异常,filter则返回一个空的 query_set
查询结果集,去除了 try ... except
异常捕获。让代码结构更清晰。
我们把 if、if..
改成了 if elif else
,把 render(request, 'register.html', data)
抽到外面去了,并不需要在每一个 if
里面 return
响应。把错误信息封装在 error_msg
字典中,下次想再添加一些错误提示信息或者想修改错误提示信息可以在 error_msg
字典中添加、修改,这样易维护、扩展,也更加明确有哪些错误信息。
到此这篇关于Python代码风格与编程习惯重要吗?的文章就介绍到这了,更多相关Python编程规范内容请搜索猪先飞以前的文章或继续浏览下面的相关文章希望大家以后多多支持猪先飞!
相关文章
- 这篇文章主要介绍了python-opencv-画外接矩形框的实例代码,代码简单易懂,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下...2021-09-04
Python astype(np.float)函数使用方法解析
这篇文章主要介绍了Python astype(np.float)函数使用方法解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-06-08- 2022虎年新年即将来临,小编为大家带来了一个利用Python编写的虎年烟花特效,堪称全网最绚烂,文中的示例代码简洁易懂,感兴趣的同学可以动手试一试...2022-02-14
- 在本篇文章里小编给大家分享的是一篇关于python中numpy.empty()函数实例讲解内容,对此有兴趣的朋友们可以学习下。...2021-02-06
python-for x in range的用法(注意要点、细节)
这篇文章主要介绍了python-for x in range的用法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2021-05-10- 这篇文章主要介绍了Python 图片转数组,二进制互转操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2021-03-09
- 这篇文章主要介绍了Python中的imread()函数用法说明,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2021-03-16
- 这篇文章主要介绍了python如何实现b站直播自动发送弹幕,帮助大家更好的理解和学习使用python,感兴趣的朋友可以了解下...2021-02-20
python Matplotlib基础--如何添加文本和标注
这篇文章主要介绍了python Matplotlib基础--如何添加文本和标注,帮助大家更好的利用Matplotlib绘制图表,感兴趣的朋友可以了解下...2021-01-26- 这篇文章主要介绍了解决python 使用openpyxl读写大文件的坑,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2021-03-13
- 今天小编就为大家分享一篇python 计算方位角实例(根据两点的坐标计算),具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2020-04-27
- 这篇文章主要为大家详细介绍了python实现双色球随机选号,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下...2020-05-02
- 在本篇文章里小编给大家整理的是一篇关于python中使用np.delete()的实例方法,对此有兴趣的朋友们可以学习参考下。...2021-02-01
- 这篇文章主要介绍了使用Python的pencolor函数实现渐变色功能,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下...2021-03-09
- 这篇文章主要介绍了python自动化办公操作PPT的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2021-02-05
Python getsizeof()和getsize()区分详解
这篇文章主要介绍了Python getsizeof()和getsize()区分详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2020-11-20- 这篇文章主要介绍了解决python 两个时间戳相减出现结果错误的问题,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2021-03-12
- 这篇文章主要为大家详细介绍了python实现学生通讯录管理系统,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下...2021-02-25
- 这篇文章主要介绍了PyTorch一小时掌握之迁移学习篇,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下...2021-09-08
- 这篇文章主要介绍了Python绘制的爱心树与表白代码,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下...2021-04-06