改善python程序的91个建议

No1.理解Pythonic概念

No2.编写Pythonic代码

No3.理解Python与C语言的不同

No4.在代码中适当添加注释

No5.通过适当添加空行使代码布局优雅

No6.编写函数的原则

No7.将常量集中到一个文件

No1.理解Pythonic概念

img

避免这种用法

1
2
for i in range(len(list1)):
do_sth_with(list1[i])

改为

1
2
for k in list1:
do_sth_with(k)

img

No2.编写Pythonic代码

(1)避免劣化代码

  • 避免只用大小写来区分不同的对象
  • 避免使用容易引起混淆的名称

img

  • 不要害怕过长的变量名

(2)深入认识Python

No3.理解Python与C语言的不同

No4.在代码中适当添加注释

块注释,行注释以及文档注释

1)使用块或行注释的时候仅仅注释那些复杂的操作、算法

2)注释和代码隔开一定的距离

3)外部可访问的函数和方法添加文档注释,描述方法的功能,并对参数、返回值以及可能发生的异常进行说明

4)推荐在文件通中包含copyright申明,模块描述等

No5.通过适当添加空行使代码布局优雅

Python 代码布局

img

img img

No6.编写函数的原则

原则1:函数设计要尽量短小,不能嵌套过深

原则2:函数申明应该做到合理,简单,易于使用

原则3:函数参数设计应该考虑向下兼容

img

这样的变化会使函数调用的接口发生改变,更好的方法是加入默认参数来避免这种退化,第一行代码改成

1
def (filename,logger=logger.info)

原则4:一个函数只做一件事,保证函数语句粒度的一致性

其他:不要在函数中定义可变对象为默认值;使用异常代替错误

No7.将常量集中到一个文件