python命名规范-PEP8

本文详细介绍了遵循PEP8的Python编码规范,包括编码格式、命名规则、import顺序、异常处理、返回策略以及权限校验。同时,提到了前端编码规范,如命名规则和代码注释,日志输出格式,代码提交备注,接口设计原则和数据验证逻辑。此外,还强调了代码注释的重要性,推荐使用绝对路径引用,并提供了模块导入的建议。
摘要由CSDN通过智能技术生成

PEP8基本规范:

建议修改在使用的 IDE 中修改 PEP8 的每行字数不超79字符规范,可修改为 Django 建议的 119 字符

一、python编码规范:

(一)代码编码:

1、国际惯例,文件编码和 Python 编码格式全部为 utf-8 ,例如:在 Python 代码的开头,要统一加上 # -- coding: utf-8 --。
2、Python 代码中,非 ascii 字符的字符串,请需添加u前缀
3、若出现 Python编 码问题,可按照以下操作尝试解决:

import sys
reload(sys)
sys.setdefaultencoding('utf-8')
123

(二)命名规范:
1、包名、模块名、局部变量名、函数名

  全小写+下划线式驼峰 示例:this_is_var
1

2、全局变量

全大写+下划线式驼峰 示例:GLOBAL_VAR
1

3、类名

首字母大写式驼峰 示例:ClassName()
1

4、变量名命名

尽量体现变量的数据类型和具体意义
1

注:

变量名、类名取名必须有意义,严禁用单字母
变量名不要用系统关键字,如 dir type str等等
12

建议:

bool变量一般加上前缀 is_ 如:is_success
1

(三)、import 顺序:

1、标准库   2、第三方库  3、项目本身
(之间用空行分隔)
12

(四)、models 内部定义顺序:

All database fields
Custom manager attributes
class Meta
def (str)
def save()
def get_absolute_url()
Any custom methods

(五)、异常捕获处理原则:

尽量只包含容易出错的位置,不要把整个函数 try catch
对于不会出现问题的代码,就不要再用 try catch了
只捕获有意义,能显示处理的异常
能通过代码逻辑处理的部分,就不要用 try catch
异常忽略,一般情况下异常需要被捕获并处理,但有些情况下异常可被忽略,只需要用 log 记录即可,可参考一下代码:

def ignored():
    try:
        yield
    except Exceptions as e:
        logger.warning(e)
        pass

(六)、return early原则

提前判断并 return,减少代码层级,增强代码可读性(简单逻辑往前放)

if not condition
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值