【Python】编码规范和注意事项

201 阅读3分钟

其实,学习任何语言都有他们自成一套的规范体系,只是为了更好的提高代码的可读性,那Python在编码过程中需要注意什么呢?

1、每个import语句只导入一个模块,尽量避免一次导入多个模块(错误示范:import a,b)
2、不要在行尾添加分号";",其实能理解,毕竟很多语言,包括JAVA都是以分号作为一条代码的结束标记,
但是python不需要,同时我们要做到一行一段代码,这是基本规范,其他语言亦是如此
3、个人比较建议每一行的代码字符加起来不要超过80个,如果真的有需要,必须超过的话,建议使用小括
号把这些字符包括起来,而不是像JAVA一样用\n来换行[如果import语句过长或者有过长的URL可以不需要注意这个问题]
4、使用必要的空行是可以优化代码可读性的,大多数情况来说,顶级定义之间空两行,方法定义之间就
空一行,还有一个情况,在用于分割某些功能的位置也可以空一行
5、建议之谈,一般来说,运算符两侧、函数参数之间、逗号两侧都是建议用空格进行分割的,这一点和
排版后的JAVA是一样的
6、避免在循环中使用+和+=操作符累加字符串,那有人就要问了,那字符串拼接我怎么做呀?【可以将每
子字符串放在一个列表中,然后在使用join()方法进行连接列表即可,如果是在循环中,那就要在循环
体外进行join()】
7、适当使用异常处理结构,因为这样可以提高程序容错性,但是也不能太依赖这种结构

以上是比较常见的PEP8编码规范,建议严格遵守,但以上是比较常见的,那完整的规范可以自行百科一下PEP8

上面说到的是代码编写习惯,那代码中的变量、方法这些需要声明的命名,是否也有规范可循?那当然,下面我们就介绍一下

1、模块名尽量短而小,强烈要求使用小写字母,可以用下划线来分割单词,比如redis_key
2、包名的话,尽量短小,而且同样使用小写字谜,这里就不推荐使用下划线了,按照JAVA来看,其实是
一样的,像com.cb.name这种规范是推荐使用的
3、类名采用单词首字母大写的形式,即首字母大写的驼峰命名,其实是叫做Pascal风格,比如我的名
字:MyName
4、模块内部的类采用下划线+Pascal风格来组成,比如书包里的书,也就是Bag中有一个_Book
5、函数、类的属性和方法的命名规则同模块命名,也就是小写字母且用下划线隔开
6、常量名应全部大写,可以用下划线也可以不用,个人推荐用下划线分割
7、使用双下划线开头的实例变量或方法是类私有的