Python 开发编码规范

77 阅读6分钟
模块引用

Imports 应该写在代码文件的开头,并按照下面这样的顺序引用:

  1. 标准库 imports

  2. 相关第三方 imports

  3. 本地应用/库的特定 imports

禁止使用 import * 这样的方式。

模块级的双下划线命名

模块中的「双下滑线」变量,比如 __all____author____version__ 等,直接写在文件开头。

例如:

"""

This is the example module.

This module does stuff.

"""

from future import barry_as_FLUFL

all = ['a', 'b', 'c']

version = '0.1'

author = 'Cardinal Biggles'

import os

import sys

字符串引用


使用单引号来表示字符串,对于三引号字符串,使用双引号字符表示。

例如:

单引号字符串

a = 'hello'

三引号字符串

"""

这是一个三引号字符串

"""

表达式和语句中的空格


在下列情形中避免使用过多的空白:

1、方括号,圆括号和花括号之后:

正确的例子:

spam(ham[1], {eggs: 2})

错误的例子:

spam( ham[ 1 ], { eggs: 2 } )

2、逗号,分号或冒号之前:

正确的例子:

if x == 4: print x, y; x, y = y, x

错误的例子:

if x == 4 : print x , y ; x , y = y , x

3、切片操作

正确的例子:

ham[1:9], ham[1:9:3], ham[:9:3], ham[1::3], ham[1:9:]

ham[lower:upper], ham[lower:upper:], ham[lower::step]

ham[lower+offset : upper+offset]

ham[: upper_fn(x) : step_fn(x)], ham[:: step_fn(x)]

ham[lower + offset : upper + offset]

错误的例子:

ham[lower + offset:upper + offset]

ham[1: 9], ham[1 :9], ham[1:9 :3]

ham[lower : : upper]

ham[ : upper]

4、赋值

正确的例子:

x = 1

y = 2

long_variable = 3

错误的例子:

x = 1

y = 2

long_variable = 3

还有一点需要注意的是,一定要把行尾的空格删掉。

注释


对代码进行必要的注释,如果修改代码,还要修改对应的注释内容。

删除无用的注释内容,增加代码可读性。

块注释

要使用块注释,禁止使用行内注释,注释时,# 和后面的注释内容要有空格。

例如:

这是一个注释

x = 1 + 1

不要使用下面的注释方式:

x = 1 + 1 # 这是一个注释

TODO 注释

主要包含以下三点内容:

  1. 开头包含「TODO」字符串

  2. 紧跟着是用括号括起来的你的名字或者 email

  3. 再接下来是冒号,然后写接下来要做内容的文字解释

例如:

TODO(xiaoming): 明确需求之后再开发

文档字符串

对于公共模块,函数,类和方法,使用文档字符串。内容包括三个方面,分别是功能描述、参数、返回值。

例如:

class MyClass:

"""

这是一个自定义类

"""

something

def func():

"""

这是一个自定义函数

params:

params1: 第一个参数

params2: 第二个参数

return:

{'data': {}, 'status': 200}

"""

something

命名


1、文件名

采用小写字母和下划线的方式。

例如:

utils.py

mail_lib.py

2、函数名

采用小写字母和下划线的方式。

例如:

def func():

pass

def send_mail():

pass

做了那么多年开发,自学了很多门编程语言,我很明白学习资源对于学一门新语言的重要性,这些年也收藏了不少的Python干货,对我来说这些东西确实已经用不到了,但对于准备自学Python的人来说,或许它就是一个宝藏,可以给你省去很多的时间和精力。

别在网上瞎学了,我最近也做了一些资源的更新,只要你是我的粉丝,这期福利你都可拿走。

我先来介绍一下这些东西怎么用,文末抱走。


(1)Python所有方向的学习路线(新版)

这是我花了几天的时间去把Python所有方向的技术点做的整理,形成各个领域的知识点汇总,它的用处就在于,你可以按照上面的知识点去找对应的学习资源,保证自己学得较为全面。

最近我才对这些路线做了一下新的更新,知识体系更全面了。

在这里插入图片描述

(2)Python学习视频

包含了Python入门、爬虫、数据分析和web开发的学习视频,总共100多个,虽然没有那么全面,但是对于入门来说是没问题的,学完这些之后,你可以按照我上面的学习路线去网上找其他的知识资源进行进阶。

在这里插入图片描述

(3)100多个练手项目

我们在看视频学习的时候,不能光动眼动脑不动手,比较科学的学习方法是在理解之后运用它们,这时候练手项目就很适合了,只是里面的项目比较多,水平也是参差不齐,大家可以挑自己能做的项目去练练。

在这里插入图片描述

(4)200多本电子书

这些年我也收藏了很多电子书,大概200多本,有时候带实体书不方便的话,我就会去打开电子书看看,书籍可不一定比视频教程差,尤其是权威的技术书籍。

基本上主流的和经典的都有,这里我就不放图了,版权问题,个人看看是没有问题的。

(5)Python知识点汇总

知识点汇总有点像学习路线,但与学习路线不同的点就在于,知识点汇总更为细致,里面包含了对具体知识点的简单说明,而我们的学习路线则更为抽象和简单,只是为了方便大家只是某个领域你应该学习哪些技术栈。

在这里插入图片描述

(6)其他资料

还有其他的一些东西,比如说我自己出的Python入门图文类教程,没有电脑的时候用手机也可以学习知识,学会了理论之后再去敲代码实践验证,还有Python中文版的库资料、MySQL和HTML标签大全等等,这些都是可以送给粉丝们的东西。

在这里插入图片描述

这些都不是什么非常值钱的东西,但对于没有资源或者资源不是很好的学习者来说确实很不错,你要是用得到的话都可以直接抱走,关注过我的人都知道,这些都是可以拿到的。

了解详情:docs.qq.com/doc/DSnl3ZG…