说一下 Python 一般工程的目录结构

一般习惯这样规划目录，在开始一个工程前，最好先把目录结构规划好。

一、为什么要有一个比较清晰的目录结构

此处省略一万字......

二、介绍一个比较清晰的目录结构

现在先看一张目录结构图吧

目录结构图

现在介绍一下这个目录结构，项目目录 project_App下，从上到下介绍

1、docs目录：存放一些文档或全局配置文件

• config.ini--配置文件
• 使用手册
• 其他一些文档类内容

2、extas目录：程序的扩展。比如用C或C++写的东西，或Dll文件之类的

3、logs目录：日志文件放这里。（可以考虑单例模式写入日志文件哦，点击【单例模式】）

4、main包：主程序入口包。

• main.py--主程序入口

说明：主程序入口，需要把顶级目录加入到解释器中去搜索模块，默认没有这个路径只是pycharm帮助加的

# main.py 模块
import os
import sys
# 主程序入口 把项目目录加入环境变量
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
sys.path.append(BASE_DIR) # 程序启动，加入环境变量中，程序结束自动删除
print(BASE_DIR) # 返回：D:project_app

5、myproject包：这里是主程序，编写业务逻辑

• common--此包下可编写通用的模块，如工具模块，日志模块，邮件模块等等
• tests--此包为主程序单元测试包

6、requirements目录：存放整个应用依赖的外部Python包列表。简单点就一个requirements.txt，我建议三个文件，通用包、开发包、发布包区分开，看项目需要吧。

• common.txt--程序通用包列表
• develop.txt--程序开发包列表
• product.txt--程序发布包列表

# common.txt 内容
click==6.7

# develop.txt 内容
-r common.txt
coverage==4.4.1

# product.txt 内容
-r common.txt
requests==2.18.2

安装 develop.txt 文件中的依赖包

D:project_app> venv_0Scriptsactivate.bat # 进入虚拟环境
(venv_0) D:project_app> cd requirements
(venv_0) D:project_apprequirements> pip install -r develop.txt

因有 -r common.txt ，所以在安装 develop.txt 时，会先安装 common.txt内的包，如下图：

安装 product.txt 过程

7、res 目录（resource的简写）：存放各种图片资源

8、venv_0 目录：python 虚拟环境目录，一个程序对应一个虚拟环境，保证了第三方模块版本的一致性。如何安装虚拟环境点击【虚拟环境安装】

D:>cd project_app # 进入项目目录
D:project_app>python -m venv venv_0 # 创建虚拟环境
D:project_app> venv_0Scriptsactivate.bat # 进入虚拟环境
D:project_app> pip install flask # 安装flask框架
D:project_app> venv_0Scriptsdeactivate.bat # 退出虚拟环境

9、README.txt 文件：项目说明文件。

• 项目主要功能
• 代码结构
• 安装环境
• 启动命令之类

10、setup.py 文件：安装、部署、打包的脚本。项目应写好脚本自动打包

好了，你做程序时，先建一个这样的目录，然后再开始写程序吧。

记得关注、点赞哦，后面越来越精彩。