Python代码风格与Django视图重构实战

Python代码风格规范

良好的代码风格是团队协作与后期维护的基础。虽然无需死板地遵守所有规范，但遵循 PEP8 标准能显著提升代码的可读性。以下是几个关键实践点：

• 模块结构：建议单行字符数不超过 79 个。模块开头应明确指定编码格式（如 # -*- coding:utf-8 -*-），并包含作者、描述及日期等文档注释。
• 入口规范：模块应包含 main() 函数用于测试，并通过 if __name__ == '__main__': 作为程序入口。
• 导入策略：避免使用 from ... import *，这可能导致命名冲突。推荐按“由短到长”的顺序导入，并在从 import 过渡到 from ... import 时进行换行。

导入顺序通常遵循：Python 内置模块 → Python 自建模块 → 第三方库。若自建模块与内置模块较少，可合并无需换行。核心目标是追求代码的清晰与美观，而非机械照搬。

#!/usr/bin/python3
# -*- coding:utf-8 -*-
# @Author: Hui
# @Desc: { 项目主入口模块 }
# @Date: 2020/05/21 13:04


def main():
    print('Hello Python')


if __name__ == '__main__':
    main()

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内置模块导入
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

Django视图重构示例

在 Django 开发中，视图函数的结构直接影响代码的可维护性。以下通过一个用户注册视图的重构过程，展示如何通过封装提升代码质量。

1. 路径与常量的封装

将 HTML 模板路径封装在视图类中，可以提高代码的扩展性。例如，定义 BookView 类来管理图书相关页面的路径：

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)

2. 错误信息的统一处理

在用户注册视图 register 中，初始版本可能包含大量的 return render 语句，导致代码冗余。通过定义 UserView 类并封装错误信息字典，可以简化逻辑。

首先，定义视图类与错误信息字典：

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')
    
    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)

3. 使用 filter 替代 try-except

在原始代码中，查询用户是否存在时使用了 try ... except 结构。虽然 get 方法在找不到数据时会抛出异常，但使用 filter 返回空的 query_set 可以更优雅地处理这种情况，从而去除异常捕获代码。

重构前的异常处理：

# 校验用户名是否重复
try   
	user = User.object.get(username=username)
except User.DoesNotExists:
    user = None

重构后的 filter 用法：

User.object.filter(username=username)

通过将 if 改为 if elif else 结构，并将 render 响应统一抽取到函数末尾，代码逻辑更加清晰，错误信息也便于集中维护。

以上就是Python代码风格与Django视图重构的详细内容，更多关于Python编程规范与Django开发技巧的资料请关注本站其它相关文章！