0 序
我虽然没参加过比较大型的多人协作项目,但也独立开发过上万行的C++、Python项目,所以多少有些工程经验吧,在此不辞领教,分享下如何能开发一个结构清晰,代码易维护,鲁棒性强,功能扩展性强的工程。谈不上软件工程的理念,只是一些小问题上的代码开发技巧。
在第一节《Python基础》已经谈过代码风格规范、注释代码块、文档测试,都是项目开发维护很实用的技能,本篇不再重复阐述。
1 import与代码结构组织
1.1 包、模块命名
包(package)是指目录,导入包的时候实际是导入目录下的__init__.py
文件。
模块(module)是指py文件,例如debuglib.py
。由若干包和模块组成的特定功能或项目统称为“库”,Python自带可以直接引用的称为标准库(第一方库),其他组织发布的扩展,需要pip等额外安装后才能用的称为第三方库,公司内部开发的功能称为第二方库。
开发二方库时,包和模块命名必须遵循Python标识符规则。PEP8:
模块应该用简短全小写的名字,如果为了提升可读性,下划线也是可以用的。Python包名也应该使用简短全小写的名字,但不建议用下划线。
个人经验:为了避免模块名和函数名混淆,我一般会在模块名后面统一加上lib
,例如debug.py
改为debuglib.py
。
1.2 import语法
关于Python包和模块的10个知识清单,常见导入语法:
import <package> # 导入一个包
import <module> # 导入一个模块
from <package> import <module or subpackage or object> # 从一个包中导入模块/子包/对象
from <module> import <object> # 从模块中导入对象
还可以在后缀添加as ...
取别名简化引用,如:import pandas as pd
。
PEP8推荐以下导入顺序,并在每组之间插入一个空行:
- 标准库的导入
- 相关的第三方库导入
- 特定的本地应用/库导入
关于本地库的导入,Google开源项目风格指南推荐使用模块的全路径名来导入每个模块(使用这种全路径名做项目时,一定要注意1.5要讲到的"import时的加载顺序"问题,一般不在__init__.py
写功能或者导包操作。):
# Reference in code with complete name.
import sound.effects.echo
# Reference in code with just module name (preferred).
from sound.effects import echo
为了使用完整路径,需要用setup.py安装库,或者将库配置到site-packages目录:
读者如果不知道要怎么写import,那么都按全路径名来写就对了,这样任何一个py文件都可以作为一个独立脚本文件来运行、测试,也不会遇到IDE的一些索引跳转到定义的功能bug。还有种比较常见的写法是在库的一些内部包里使用相对引用,这种写法就无法直接将build_main.py作为一个独立脚本来运行或测试了:
1.3 库的安装
如果希望自己的项目发送给别人时,能自动安装相关的三方库、二方库,可以参考该文:Python 打包分发工具 setuptools 简介。
还有一种比较简单粗暴的方法,是在代码中使用try语法:
import subprocess
try:
from bs4 import BeautifulSoup
except ModuleNotFoundError:
subprocess.run(['pip3', 'install', 'BeautifulSoup'])
from bs4 i