python基础——软件目录规范

此文摘自这篇博文中的软件目录规范，本人所写的有关于python博文大部分是通过学习该链接中的课程所记录总结的，如有雷同，纯属事实！
软件目录规范的好处：
1、可读性高: 不熟悉这个项目的代码的人，一眼就能看懂目录结构，知道程序启动脚本是哪个，测试目录在哪儿，配置文件在哪儿等等。从而非常快速的了解这个项目。
2、 可维护性高: 定义好组织规则后，维护者就能很明确地知道，新增的哪个文件和代码应该放在什么目录之下。这个好处是，随着时间的推移，代码/配置的规模增加，项目结构不会混乱，仍然能够组织良好。

目录组织方式

目录说明：
1、bin/: 存放项目的一些可执行文件，当然你可以起名script/之类的也行。
2、foo/: 存放项目的所有源代码。(1) 源代码中的所有模块、包都应该放在此目录。不要置于顶层目录。(2) 其子目录tests/存放单元测试代码； (3) 程序的入口最好命名为main.py。
3、docs/: 存放一些文档。
4、setup.py: 安装、部署、打包的脚本。
5、requirements.txt: 存放软件依赖的外部Python包列表。
6、README: 项目说明文件
除此之外，有一些方案给出了更加多的内容。比如LICENSE.txt,ChangeLog.txt文件等，我没有列在这里，因为这些东西主要是项目开源的时候需要用到。如果你想写一个开源软件，目录该如何组织，可以参考这篇文章。

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

requirements.txt
这个文件存在的目的是:
1、方便开发者维护软件的包依赖。将开发过程中新增的包添加进这个列表中，避免在setup.py安装依赖时漏掉软件包。
2、方便读者明确项目使用了哪些Python包。
这个文件的格式是每一行包含一个包依赖的说明，通常是flask>=0.10这种格式，要求是这个格式能被pip识别，这样就可以简单的通过 pip install -r requirements.txt来把所有Python包依赖都装好了。具体格式说明： 点这里。

关于配置文件的使用方法

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

很多项目对配置文件的使用做法是:
1、配置文件写在一个或多个python文件中，比如此处的conf.py。
2、项目中哪个模块用到这个配置文件就直接通过import conf这种形式来在代码中使用配置。

这种做法我不太赞同:
1、这让单元测试变得困难（因为模块内部依赖了外部配置）
2、另一方面配置文件作为用户控制程序的接口，应当可以由用户自由指定该文件的路径。
3、程序组件可复用性太差，因为这种贯穿所有模块的代码硬编码方式，使得大部分模块都依赖conf.py这个文件。
所以，我认为配置的使用，更好的方式是，
1、模块的配置都是可以灵活配置的，不受外部配置文件的影响。
2、程序的配置也是可以灵活控制的。

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

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

那么问题来了，如何通过给main.py启动参数指定配置路径的方式来让程序读取配置内容，就是跨目录导入模块。

方法如下：
我的目录结构如下：

#目的：为了使模块放在任何电脑上都能用，即该程序能调用core目录下的main模块中的方法，只能动态的获取绝对路径
import os
import sys
#print(os.path.abspath(__file__))#获取改程序的绝对路径
#print(os.path.dirname(os.path.abspath(__file__)))#os.path.dirname返回目录名不要文件名,返回到bin目录下
#print(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))#到达Atm目录下
BASE_DIR=os.path.dirname(os.path.dirname(os.path.abspath(__file__)))#获取绝对路径
sys.path.append(BASE_DIR)#添加环境变量
from core import main  #添加了环境变量之后可以导入main模块了
main.log()