python 软件目录结构规范

为什么要设计好目录结构?

"设计项目目录结构"，就和"代码编码风格"一样，属于个人风格问题。对于这种风格上的规范，一直都存在两种态度:

• 1.一类同学认为，这种个人风格问题"无关紧要"。理由是能让程序work就好，风格问题根本不是问题。
  • 2.另一类同学认为，规范化能更好的控制程序结构，让程序具有更高的可读性。

我是比较偏向于后者的，因为我是前一类同学思想行为下的直接受害者。我曾经维护过一个非常不好读的项目，其实现的逻辑并不复杂，但是却耗费了我非常长的时间去理解它想表达的意思。从此我个人对于提高项目可读性、可维护性的要求就很高了。"项目目录结构"其实也是属于"可读性和可维护性"的范畴，我们设计一个层次清晰的目录结构，就是为了达到以下两点:

• 1.可读性高: 不熟悉这个项目的代码的人，一眼就能看懂目录结构，知道程序启动脚本是哪个，测试目录在哪儿，配置文件在哪儿等等。从而非常快速的了解这个项目。

  • 2.可维护性高: 定义好组织规则后，维护者就能很明确地知道，新增的哪个文件和代码应该放在什么目录之下。这个好处是，随着时间的推移，代码/配置的规模增加，项目结构不会混乱，仍然能够组织良好。

所以，我认为，保持一个层次清晰的目录结构是有必要的。更何况组织一个良好的工程目录，其实是一件很简单的事儿。

目录组织方式

关于如何组织一个较好的Python工程目录结构，已经有一些得到了共识的目录结构。在Stackoverflow的这个问题上，能看到大家对Python目录结构的讨论。

https://stackoverflow.com/questions/193161/what-is-the-best-project-structure-for-a-python-application

这里面说的已经很好了，我也不打算重新造轮子列举各种不同的方式，这里面我说一下我的理解和体会。

假设你的项目名为foo, 我比较建议的最方便快捷目录结构这样就足够了:

Foo/
|-- bin/
|   |-- foo
|
|-- foo/
|   |-- tests/
|   |   |-- __init__.py
|   |   |-- test_main.py
|   |
|   |-- __init__.py
|   |-- main.py
|
|-- docs/
|   |-- conf.py
|   |-- abc.rst
|
|-- setup.py
|-- requirements.txt
|-- README

简要解释一下:

bin/: 存放项目的一些可执行文件，当然你可以起名script/之类的也行。

foo/: 存放项目的所有源代码。(1) 源代码中的所有模块、包都应该放在此目录。不要置于顶层目录。(2) 其子目录tests/存放单元测试代码； (3) 程序的入口最好命名为main.py。

docs/: 存放一些文档。

setup.py: 安装、部署、打包的脚本。

requirements.txt: 存放软件依赖的外部Python包列表。

README: 项目说明文件。

案例

  ├── README.md                   # 说明文件
  ├── apps                        # 子项目目录
  │   ├── README.md                   - # 项目规范说明文件
  │   ├── app1                        - # 自定义模块一
  │   ├── app2                        - # 自定义模块二
  │   ├── ...                         - # 更多自定义模块，每个模块一个文件夹
  │   └── user                        - # 用户模块（单独抽离出）
  ├── main                        # 项目主目录
  │   ├── __init__.py
  │   ├── asgi.py
  │   ├── settings.py             # 主配置文件
  │   ├── urls.py                 # 请求URL主入口
  │   └── wsgi.py
  ├── db.sqlite3                  # 自带数据库（仅开发环境）
  ├── env                         # 不同环境的配置文件
  │   ├── README.md                   - # 环境配置说明
  │   ├── env.example                 - # 配置示例文件
  │   └── env                         - # 环境配置文件
  ├── logs                        # 日志
  │   ├── access.log                 - # 访问日志
  │   ├── error.log                  - # 错误日志
  │   └── uwsgi.log                  - # 运行日志
  ├── manage.py
  ├── reload                      # (uwsgi) 监听该文件变动重启服务
  ├── requirements.txt            # 项目依赖
  ├── static                      # 静态资源文件
  │   ├── css
  │   ├── image
  │   └── js
  └── uwsgi.ini                   # uwsgi配置文件

以下几个目录比较关键

• apps 关于实现的所有业务逻辑，每个模块单独起一个 app 写，相关逻辑放到对应 app
• main 根项目，框架启动入口。不实现任何业务逻辑。固定名称，就叫 main。
• env 项目配置目录，包含一个项目配置实例。通常会以文件的方式通过容器挂载。

Django走过的一些弯路-项目结构

相关文章：
python 软件目录结构规范
写出优雅的Python分格
Django走过的一些弯路-项目结构
酷Python|谷歌开源项目风格指南-python代码规范

为者常成，行者常至