软件目录结构规范

1.为什么要设计好目录结构？

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

 

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

 

 

2.目录组织方式

假设项目名为foo, 最方便快捷目录结构这样就足够了:

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

简要解释一下:

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

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

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

config/: 存放配置文件

docs/:   存放一些文档。

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

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

README:  项目说明文件。

 

 

3.对以上目录的详细解释

(1)README: 这是每个项目都应该有的一个文件，目的是能简要描述该项目的信息，让读者快速了解这个项目

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

• 软件定位，软件的基本功能。
• 运行代码的方法: 安装环境、启动命令等。
• 简要的使用说明。
• 代码目录结构说明，更详细点可以说明软件的基本原理。
• 常见问题说明。

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

 

(2)setup.py： 管理代码的打包、安装、部署问题

业界标准的写法是用Python流行的打包工具setuptools来管理这些事情。这种方式普遍应用于开源项目中。不过这里的核心思想不是用标准化的工具来解决这些问题，而是说，一个项目一定要有一个安装部署工具，能快速便捷的在一台新机器上将环境装好、代码部署好和将程序运行起来。

setup.py可以将这些事情自动化起来，提高效率、减少出错的概率。"复杂的东西自动化，能自动化的东西一定要自动化。"是一个非常好的习惯。

setuptools的文档比较庞大，刚接触的话，可能不太好找到切入点。学习技术的方式就是看他人是怎么用的，可以参考一下Python的一个Web框架，flask是如何写的: setup.py

 

(3)requirements.txt:   方便开发者维护软件的包依赖，方便读者明确项目使用了哪些Python包。

这个文件的格式是每一行包含一个包依赖的说明，通常是flask>=0.10这种格式，要求是这个格式能被pip识别，这样就可以简单的通过 pip install -r requirements.txt来把所有Python包依赖都装好了。具体格式说明： 点这里

 

(4)配置文件:  注意在上面的目录结构中，没有将conf.py放在源码目录下，而是放在docs/目录下，当然config目录下的settings.py也可以充当配置文件

很多项目对配置文件的使用做法是:

• 配置文件写在一个或多个python文件中，比如此处的conf.py
• 项目中哪个模块用到这个配置文件就直接通过import conf这种形式来在代码中使用配置

这样会造成:

• 让单元测试变得困难（因为模块内部依赖了外部配置）
• 另一方面配置文件作为用户控制程序的接口，应当可以由用户自由指定该文件的路径。
• 程序组件可复用性太差，因为这种贯穿所有模块的代码硬编码方式，使得大部分模块都依赖conf.py这个文件。

对于配置文件的使用更好的方式是:

• 模块的配置都是可以灵活配置的，不受外部配置文件的影响
• 程序的配置也是可以灵活控制的

能够佐证这个思想的是，用过nginx和mysql的同学都知道，nginx、mysql这些程序都可以自由的指定用户配置。

所以，不应当在代码中直接import conf来使用配置文件。上面目录结构中的conf.py，是给出的一个配置样例，不是在写死在程序中直接引用的配置文件。可以通过给main.py启动参数指定配置路径的方式来让程序读取配置内容。当然，这里的conf.py你可以换个类似的名字，比如settings.py。或者你也可以使用其他格式的内容来编写配置文件，比如settings.yaml之类的