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编程规范内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们!

(0)

相关推荐

  • 利用Python计算圆周率π的实例代码

    前言 A货:什么!你不会背圆周率(鄙夷的眼神) 3.1415926535 8979323846 26433... 桥哥:我会算呀 !!! 一.圆周率的历史 1.中国 ★ 魏晋时期,刘徽曾用使正多边形的边数逐渐增加去逼近圆周的方法 (即「割圆术」),求得π的近似值3.1416. ★ 汉朝时,张衡得出π的平方除以16等于5/8,即π等于10的开方(约为3.162).虽然这个值不太准确,但它简单易理解,所以也在亚洲风行了一阵. ★ 王蕃(229-267)发现了另一个圆周率值,这就是3.156, 但没有

  • Python一行代码实现自动发邮件功能

    1. 用Python每天给女神发送舔狗问候 用Python自动发送最基本的邮件(主题+收件人) 知识点 邮件结构 以263企业邮为例 邮件形式 内容 最基本 收件人+主题 最常用 收件人+主题+正文 一般流程申请邮件 收件人+主题+正文+抄送 发报表邮件 收件人+主题+抄送+附件 加说明报表邮件 收件人+主题+正文+抄送+附件 Python调用zmail模块 import zmail zmail.server('danzhao@sunlands.com','password').send_mai

  • Python 线程池模块之多线程操作代码

    1.线程池模块 引入 from concurrent.futures import ThreadPoolExecutor 2.使用线程池 一个简单的线程池使用案例 from concurrent.futures import ThreadPoolExecutor import time pool = ThreadPoolExecutor(10, 'Python') def fun(): time.sleep(1) print(1, end='') if __name__ == '__main__

  • python3调用c语言代码的全过程记录

    开发环境 linux: python3.5.2 + ubuntu-gnome-16.04-desktop-amd64 windows:cygwin + powershell + python3.6 胶水语言python为什么要调用c代码? c与python对比python不擅长"大量运算"任务,python程序优势在于:编写简单,适合"IO密集型作业"(比如打开文件,下载图片,运行脚本).python作为知名的"胶水语言",快速实现"计

  • python使用tkinter实现透明窗体上绘制随机出现的小球(实例代码)

    在上一篇的基础上,继续在透明窗体上绘制小球, 一.画个大球看看 (一)核心代码 在on_resize函数内部增加如下画圆的代码 canvas.create_oval(100, 100, 200, 200, outline='yellow', # 边框颜色 fill='pink', # 填充颜色 width=4 # 边框宽度 ) 运行效果如下: 嘻嘻,是不是觉得有点意思. 好吧,后续我会分享这部分的完整代码给各位,希望大家不是拿来主义,能点点赞.关注一下我啊. 二.让小球随机运动起来 (一)核心函

  • 只需要100行Python代码就可以实现的贪吃蛇小游戏

    图示 基本准备 首先,我们需要安装pygame库,小编通过pip install pygame,很快就安装好了.在完成贪吃蛇小游戏的时候,我们需要知道整个游戏分为四部分: 1.游戏显示:游戏界面.结束界面 2.贪吃蛇:头部.身体.食物判断.死亡判断 3.树莓:随机生成 4.按键控制:上.下.左.右 游戏显示 首先,我们来初始化pygame,定义颜色.游戏界面的窗口大小.标题和图标等. 游戏结束界面,我们会显示"Game Over!"和该局游戏所得分数,相关代码如下: 贪吃蛇和树莓 我们

  • 只用20行Python代码实现屏幕录制功能

    一.模块安装 首先,我们需要用到两个python的两个模块,win32gui和PyQt5 1.pip install win32gui 2.pip install PyQt5 1.pip install win32gui PS C:\Users\lex\Desktop> pip install win32gui Looking in indexes: http://mirrors.aliyun.com/pypi/simple Requirement already satisfied: win3

  • Python入门篇之编程习惯与特点

    1.代码风格 在Python中,每行程序以换行符代表结束,如果一行程序太长的话,可以用"\"符号扩展到下一行.在python中以三引号(""")括起来的字符串,列表,元组和字典都能跨行使用.并且以小括号(...).中括号[...]和大括号{...}包围的代码不用加"\"符也可扩展到多行. 在Python中是以缩进来区分程序功能块的,缩进的长度不受限制,但就一个功能块来讲,最好保持一致的缩进量. 如果一行中有多条语句,语句间要以分号(;)

  • 写好Python代码的几条重要技巧

    程序设计的好与坏,早在我们青葱岁月时就接触过了,只是那是并不知道这竟如此重要.能够立即改善程序设计.写出"好"代码的知识有以下几点: •面向对象五个基本原则: •常见的三种架构: •绘图: •起一个好名字: •优化嵌套的 if else 代码: 当然,其他技术知识的丰富程度也决定了程序设计的好坏.例如通过引入消息队列解决双端性能差异问题.通过增加缓存层提高查询效率等.下面我们一起来看看,上面列出的知识点包含哪些内容,这些内容对代码和程序设计的改善有何帮助. 面向对象五个基本原则 本书作

  • 符合语言习惯的 Python 优雅编程技巧【推荐】

    Python最大的优点之一就是语法简洁,好的代码就像伪代码一样,干净.整洁.一目了然.要写出 Pythonic(优雅的.地道的.整洁的)代码,需要多看多学大牛们写的代码,github 上有很多非常优秀的源代码值得阅读,比如:requests.flask.tornado,下面列举一些常见的Pythonic写法. 0. 程序必须先让人读懂,然后才能让计算机执行. "Programs must be written for people to read, and only incidentally f

  • 给大家整理了19个pythonic的编程习惯(小结)

    Python最大的优点之一就是语法简洁,好的代码就像伪代码一样,干净.整洁.一目了然. 要写出 Pythonic(优雅的.地道的.整洁的)代码,需要多看多学大牛们写的代码,github 上有很多非常优秀的源代码值得阅读,比如:requests.flask.tornado,下面列举一些常见的Pythonic写法. 0. 程序必须先让人读懂,然后才能让计算机执行. "Programs must be written for people to read, and only incidentally

随机推荐