当你熟悉了 Python 之后,就不会再满足只写一个脚本就完事,这个时候就需要考虑项目结构的事情了,尤其与别人合作完成一个项目的时候,项目的结构尤其重要。
本文分享如何优雅的开启一个 Python 项目。
简单来讲,分为 5 个步骤:
1、创建虚拟环境
你可以在项目目录中执行下面的命令,然后就会生成一个 venv 目录,这就是 Python 的虚拟环境,后面记得把 venv 添加到 .gitignore 文件中,避免被 Git 管理,从而避免上传到 GitHub。
python3 -m venv venv #创建
source venv/bin/activate #激活
deactivate #取消激活
在后面的编码过程中,我们会 pip install 一些依赖,项目依赖全部安装完成后,记得执行 pip freeze> requirements.txt
来保存项目的依赖,以便后续迁移或者部署的时候,可以很快安装依赖。
2、建立单独的单元测试目录
通常,在项目目录下建立 tests 文件夹,来存放单元测试文件,假如有一个 Python 文件名是 greetings.py 那单元测试的文件名就是 test_greetings.py,通常大家都用 pytest 来进行单元测试,可以查询 pytest 文件命名规范。
3、创建不同的内容目录
这个是灵活的,按个人风格来,总体上来说,以英文命名,体现架构层次,可以参照 Django 里面的 models,views,utils,app 等。
在一个目录中放入 __init__.py,表示这个目录是一个包,是用来导入使用的。
4、设计文档字符串及类型提示
文档字符串及类型提示,都是为了方便他人或自己来阅读和调用代码。
![384aaaaf1eea2bc1ca1eab97b0027093.png](https://i-blog.csdnimg.cn/blog_migrate/9e572721d8667096102e56fbb6be4871.png)
![f6f22fb389128fb716e1955dad77edd5.png](https://i-blog.csdnimg.cn/blog_migrate/8aee3af4647333ed135b828a6c46c1c0.png)
![879e1b3bbc4eaae4492c15d172e3ae50.png](https://i-blog.csdnimg.cn/blog_migrate/f519fbd0f80074f1e11a42ce3885c44b.png)
5、使用 Git、GitHub 进行版本管理
如果与其他人一起工作,Git GitHub 对于进行版本管理、代码审查、避免合并冲突是必不可少的。即使是自己独立编码,Git 和 GitHub 也是必备的版本控制工具。
最后
上面一些步骤在 Python 老司机看来比较繁琐,那么你可以使用 poetry 这个脚手架工具,自动为你创建好目录结构,管理虚拟环境、依赖、构建、运行等快捷服务。如果觉得有帮助,还请点个在看支持一下,感谢老铁。