Python代码风格与编程习惯重要吗?


Posted in Python onJune 03, 2021

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 相关文章推荐
python实现根据ip地址反向查找主机名称的方法
Apr 29 Python
Scrapy-redis爬虫分布式爬取的分析和实现
Feb 07 Python
Python中模块与包有相同名字的处理方法
May 05 Python
Python使用三种方法实现PCA算法
Dec 12 Python
python点击鼠标获取坐标(Graphics)
Aug 10 Python
Python实现微信机器人的方法
Sep 06 Python
简单了解Pandas缺失值处理方法
Nov 16 Python
python模式 工厂模式原理及实例详解
Feb 11 Python
MoviePy常用剪辑类及Python视频剪辑自动化
Dec 18 Python
详解pycharm的python包opencv(cv2)无代码提示问题的解决
Jan 29 Python
pytorch 6 batch_train 批训练操作
May 28 Python
Python中OpenCV实现简单车牌字符切割
Jun 11 Python
python 经纬度求两点距离、三点面积操作
Jun 03 #Python
如何使用PyCharm及常用配置详解
python for循环赋值问题
Jun 03 #Python
python批量创建变量并赋值操作
Jun 03 #Python
详解运行Python的神器Jupyter Notebook
Jun 03 #Python
python中如何对多变量连续赋值
Python连续赋值需要注意的一些问题
Jun 03 #Python
You might like
发款php蜘蛛统计插件只要有mysql就可用
2010/10/12 PHP
PHP模板引擎Smarty的缓存使用总结
2014/04/24 PHP
php批量删除超链接的实现方法
2015/10/19 PHP
JQuery 实现的页面滚动时浮动窗口控件
2009/07/10 Javascript
JavaScript 动态生成方法的例子
2009/07/22 Javascript
jQuery基础框架浅入剖析
2012/12/27 Javascript
script的async属性以非阻塞的模式加载脚本
2013/01/15 Javascript
解析img图片没找到onerror事件 Stack overflow at line: 0
2013/12/23 Javascript
js实现正方形颜色从下往上升的效果
2014/08/04 Javascript
javascript中的遍历for in 以及with的用法
2014/12/22 Javascript
js插件YprogressBar实现漂亮的进度条效果
2015/04/20 Javascript
AngularJs bootstrap详解及示例代码
2016/09/01 Javascript
写jQuery插件时的注意点
2017/02/20 Javascript
详解node如何让一个端口同时支持https与http
2017/07/04 Javascript
js实现导航跟随效果
2018/11/17 Javascript
Vue使用Clipboard.JS在h5页面中复制内容实例详解
2019/09/03 Javascript
基于aotu.js实现微信自动添加通讯录中的联系人功能
2020/05/28 Javascript
[01:01:29]2018DOTA2亚洲邀请赛 4.4 淘汰赛 VP vs Liquid 第一场
2018/04/05 DOTA
[01:06:12]VP vs NIP 2019国际邀请赛小组赛 BO2 第一场 8.15
2019/08/17 DOTA
[00:34]拔城逐梦,热血永恒!2020(秋)完美世界城市挑战赛报名开启
2020/10/09 DOTA
python爬取网站数据保存使用的方法
2013/11/20 Python
python实现通过pil模块对图片格式进行转换的方法
2015/03/24 Python
Python简单删除目录下文件以及文件夹的方法
2015/05/27 Python
Python导出DBF文件到Excel的方法
2015/07/25 Python
利用Python进行异常值分析实例代码
2017/12/07 Python
Pycharm 文件更改目录后,执行路径未更新的解决方法
2019/07/19 Python
python使用列表的最佳方案
2020/08/12 Python
一套英文Java笔试题面试题
2016/04/21 面试题
新学期开学寄语
2014/01/18 职场文书
岗位明星事迹材料
2014/05/18 职场文书
韩语专业职业生涯规划范文:成功之路就在我们脚下
2014/09/11 职场文书
人民调解协议书范本
2014/10/11 职场文书
部门2014年度工作总结
2014/11/12 职场文书
世界文化遗产导游词
2015/02/13 职场文书
2016年党员创先争优承诺书
2016/03/25 职场文书
如何使用CocosCreator对象池
2021/04/14 Javascript