Python | 项目开发中的几个习惯

良好的项目开发习惯不仅造福自己也造福他人。

1. requirement.txt

项目协作开发中,因为不同工作环境的库配置都有差别,所以 要将自己的代码在另外一个工作环境中成功复现是一件极其需要运气的事情。如果在项目中附带了运行所需的环境要求文件,并且还可以根据这个要求文件快速搭建运行环境那就再好不过了。在 Python 中,requirement.txt 用于记录所有依赖包及其精确的版本号,其作用是用来在另一台 PC 上重新构建项目所需要的运行环境依赖。

requirements.txt 可以通过 pip 命令自动生成和安装

生成 requirements.txt 文件

1
pip freeze > requirements.txt

安装 requirements.txt 依赖

1
pip install -r requirements.txt

自动生成的 requirements.txt 文件是长这样的

1
2
3
4
5
6
gevent==1.2.2
greenlet==0.4.12
pygame==1.9.3
six==1.11.0
websocket==0.2.2
websocket-client==0.44.0

2. 注释与代码规范

  • 代码的头部加入作者、创建日期、最后修改日期、代码用途等必要信息
  • 每个函数必须简要描述功能,说明变量类型及其作用,说明返回数据的数据类型和用途
  • 变量命名能有多详细就有多详细,代码注释能有多详细就多详细,造福自己也造福他人
  • 函数与函数之间空两行
  • 库的导入按照库名的首字母顺序,先 importfrom xx import xx

3. Git 提交规范

  • commit 必须说明提交类型,比如添加 [feature] 表示添加新功能、[bugfix] 表示修补 bug、[style] 表示格式改动

4. 为每个项目创建虚拟环境

最好在项目开发时,就在项目的根目录下创建虚拟环境,所有的代码测试、库的安装都必须在虚拟环境被激活的条件下运行。关于如何创建虚拟开发环境,见先前的文章: PyCharm IDE 使用笔记(1):新建虚拟环境和更换源

5. 配置文件

写好配置文件很关键,好的配置文件能够做到仅仅修改几个参数就能快速在另外一台机器复现,关于如何写配置文件,见先前的文章:Git | 项目开发中的权限管理

(未完,持续更新)

推荐阅读

  1. Google Python 风格指南
  2. PyCharm IDE 使用笔记(1):新建虚拟环境和更换源
  3. Git | 项目开发中的权限管理

继续阅读本站其他精彩文章

  1. 机器学习相关
  2. 编程语言相关
  3. 技术碎碎念
  4. 读书笔记
觉得还不错?帮我赞助点域名费吧:)