Google Python编程规范:

https://www.runoob.com/w3cnote/google-python-styleguide.html  (中文版本)

https://google.github.io/styleguide/pyguide.html (英文原版)

PEP8编程规范:

https://blog.csdn.net/ratsniper/article/details/78954852

PEP257规范:

https://github.com/qiuxiang/pep/blob/master/peps/257.md

python工程结构化:

https://pythonguidecn.readthedocs.io/zh/latest/writing/structure.html


一、PEP8规范

1.换行的3种方式

(1)对齐缩进:相对于函数括号的左边

 

(2)层级缩进:

 

(3)悬挂缩进:可以空出多个空格

 

2.单行代码的最大长度

最大长度不超过79字符,如果超过可使用 \ 进行换行(直接敲回车键即可)。

使用快捷键直接格式化代码:

 

如果是注释的话,单行限制在72个字符长度。

3.空行

类中函数与函数之间使用一行隔开;

模块导入语句与类开始之间要空两行;

4.注释

先改注释,再改代码

PEP257规范:

https://github.com/qiuxiang/pep/blob/master/peps/257.md

文档字符串

查看文档字符串:

 

5.python的命名规范

变量命名:不使用 l 、o 来命名,以免发生误解;

函数命名:函数名小写,可使用下划线提高可读性;

类命名:首字母大写,不和第三方使用的库重名;

类中的函数和方法参数:self、cls相关。

6、字符串引号

7、模块和包都爱如规范

名称尽量要短,单词最好使用 _ 进行分开

导入的顺序:

(1)先导入python内置的官方库

(2)导入安装第三方的模块库

(3)最后导入自定义的库

import time (推荐)

from time import sleep (不推荐)

from time import * (不推荐)

ps:

__all__ 变量 :当使用import * 时,可以限制只导入[ ] 中的内容

 

__init__文件的中的内容会进行预先处理。

https://pythonguidecn.readthedocs.io/zh/latest/writing/structure.html

一个标准儿的工程结构如下:

 

 

 

Logo

开放原子开发者工作坊旨在鼓励更多人参与开源活动,与志同道合的开发者们相互交流开发经验、分享开发心得、获取前沿技术趋势。工作坊有多种形式的开发者活动,如meetup、训练营等,主打技术交流,干货满满,真诚地邀请各位开发者共同参与!

更多推荐