如何规范自己的编程以及软件开发目录（二）

软件开发目录的重要性

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

设计软件目录结构，就和“代码编程风格一样”，属于个人风格问题。对于这种风格问题，一直都存在两种态度：

1.一类同学认为，这种个人风格问题"无关紧要"，只要让程序work就行，风格问题根本就不是问题。

2.另外一类同学认为，规范化能更好的控制程序结构，让程序具有更高的可读性。

大部分人都是倾向于后者的，因为大家都是前一类指导思想下的直接受害者。举个最简单的例子，我曾经维护过一个很不好读的项目，其实实现逻辑并不是很复杂，但却耗费了我非常长的时间去理解它所表达的意思。从此，我对于项目的可读性、可维护性的要求就提高了。项目目录结构也是属于"可读性"和"可维护性"的范畴，我们设置一个层次清晰的目录结构，就是为了达到两点要求：

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

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

所以，我认为保持一个良好的项目结构目录是十分有必要的。更何况组织一个良好的项目组织结构，是一件很容易的事情。

目录组织结构

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

所以，我在这里不再赘余，直接在这里说一下我的体会和理解：

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）其子目录test/存放单元测试代码；（3）程序入口最好命名为mian.py
docs/:存放一些文档
setup.py:安装、部署、打包的脚本
requirements.txt:存放软件依赖的外部python包列表
README:项目软件说明。
除此以外，有一些方案给出了更加多的内容。比如LICENSE.txt，ChangLog.txt文件等，我没有列在这里，因为这些东西主要是项目软件开源软件所要编写的东西，关于开源软件目录结构如何组织，需要自行去百度。

下面讲解一下我对软件目录的理解和要求吧。

关于README的目录内容

具体请参见文章：https://www.cnblogs.com/liuxinkai94/p/10796054.html

这个我个人觉得这应该是每个项目都应该有的一个文件，目的是简要描述项目信息，让读者快速了解这个项目。

他需要说明以下的几个事项：

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

关于setup.py以及requirements.txt

setup.py

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

以下是实际遇到的一些坑。

我刚开始接触python写项目的时候，安装环境、部署代码、运行程序这个过程全部都是手写的，遇到过以下的问题：

安装环境时候经常忘记最近添加了一个新的python包，结果一到线上运行，程序就出错了。
python包的版本依赖问题，有时候我们程序中使用的是一个版本的python包，但是官方的已经是最新的包，通过手动安装就可能装错了。
如果依赖的包很多的话，一个一个安装这些依赖的是很费时的事情。
新同学刚开始写项目的话，将程序爬起来非常麻烦，因为可能经常忘记要这么安装各种依赖。

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

setuptools的文档过于庞大，刚接触的时候，可能不太好切入，学习技术的方式就是看别人如何用，可以参照一下python的一个web框架，flask是如何写的：setup.py

当然，简单点，自己写个脚本（deploy.sh）来代替setup.py也可以。

requirements.txt

这个文件存在的目的是：

方便开发者维护软件的包依赖。将开发过程中新增的包添加进这个列表中，避免在setup.py安装依赖书时漏掉软件包
方便读者明确项目使用了哪些python包

这个文件的格式是每一行包含一个包依赖的说明，通常是flask>=0.10这种格式，要求这个格式能被pip所识别，这样就能够通过pip install -r requirements.txt来吧python所有的包依赖都安装好。具体格式说明，请自行百度。

关于配置文件的使用方法

注意，在上述的目录结构中，没有把conf.py放在源码目录下，而是放在docs/目录下：

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

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

这种做法我不太赞同：

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

所以，我认为配置的使用，更好的方式是，

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

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

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