python程序开发目录规范

Posted 2021-03-03 大江东流水

规范化能更好的控制程序结构，让程序具有更高的可读性。

项目目录结构"其实也是属于"可读性和可维护性"的范畴，我们设计一个层次清晰的目录结构，就是为了达到以下两点:

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

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

所以，保持一个层次清晰的目录结构是有必要的。

关于如何组织一个较好的Python工程目录结构，已经有一些得到了共识的目录结构。

假设你的项目名是foo，最方便快捷目录结构这样：

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

简单解释一下：

1. bin/: 存放项目的一些可执行文件

2. foo/: 存放项目的所有源代码。

   (1) 源代码中的所有模块、包都应该放在此目录。不要置于顶层目录。

   (2) 其子目录tests/存放单元测试代码；

   (3) 程序的入口最好命名为main.py。

3. conf/: 存放项目的一些配置文件。

4. logs/: 存放项目执行的日志信息。

5. docs/: 存放一些文档。

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

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

8. README: 项目说明文件。

README的书写要求：

它需要说明以下几个事项:

1. 软件定位，软件的基本功能。

2. 运行代码的方法: 安装环境、启动命令等。

3. 简要的使用说明。

4. 代码目录结构说明，更详细点可以说明软件的基本原理。

5. 常见问题说明。

在软件开发初期，由于开发过程中以上内容可能不明确或者发生变化，并不是一定要在一开始就将所有信息都补全。但是在项目完结的时候，是需要撰写这样的一个文档的。