Python21 软件目录开发规范

转金角大王：http://www.cnblogs.com/alex3714/articles/5765046.html

软件目录结构规范

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

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

一类同学认为，这种个人风格问题"无关紧要"。理由是能让程序work就好，风格问题根本不是问题。

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

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

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

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

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

目录组织方式

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

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

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

Foo为主目录

简要解释一下:

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

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

docs/: 存放一些文档。

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

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

README: 项目说明文件。

除此之外，有一些方案给出了更加多的内容。比如LICENSE.txt,ChangeLog.txt文件等，我没有列在这里，因为这些东西主要是项目开源的时候需要用到。如果你想写一个开源软件，目录该如何组织，可以参考这篇文章。

下面，再简单讲一下我对这些目录的理解和个人要求吧。

关于README的内容

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

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

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

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

简要的使用说明。

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

常见问题说明。

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

bin/atm.py是主文件，只是一个执行文件，主要的逻辑代码并不在其中，该主文件会将有逻辑代码的文件调用过来。

在主文件中写一个print的代码
在atm.py中去调用core/main.py和conf/settings.py

调用可以看到，根本找不到settings.py在哪
所以要确认路径

print (__file__)

现在已经确认了当前的相对路径在哪里（这里不是绝对路径，因为是在pycharm的问题，pycharm中所以显示的是绝对路径，但是在cmd中就显示的是相对路径）

我们需要动态的获取绝对路径，以防止文件被copy到其他电脑，导致之前的路径失效

import os
print (os.path.abspath(__file__))

这是动态获取了绝对路径，不过我们要去调取bin同级路径其他目录中的.py文件，但当前的路径是到了atm.py了

print (os.path.dirname(os.path.abspath(__file__)))    #dirname不显示文件名

不过这里的路径只是父集，并无法查找到和bin同级的目录

print (os.path.dirname(os.path.dirname(os.path.abspath(__file__))))

在加一个os.path.dirname，就相当于在多返回一层上层目录

这时在导入就没有报错，图中红色波浪线是因为对于pycharm当前来说是没有要导入目录的信息的，至于能导入成功，这是需要运行程序后才会动态添加环境变量，然后导入就不会报错了。

在settings和main中定义调用语句的函数

使用from来调用两个.py模块，然后运行模块中的方法

可以看到结果是OK的！

atm.py是程序的执行文件，main.py是程序的主入口