4.软件目录结构规范
为什么要设计好目录结构?
"设计项目目录结构"就和"代码编码风格"一样，属于个人风格问题。对于这种风格上的规范，一直都存在两种态度：
1.一共同学认为，这种个人风格问题“无关紧要”。理由是能让程序work就好，风格问题根本不是问题。
2.另一类同学认为，规范化能更好的控制程序结构，让程序具有更高的可读性。
我是比较偏向于后者的，因为我是前一类同学思想行为下的直接受害者。我曾经堆护过一个非常不好读的项目，其实现的逻辑并不复杂，但是却耗费了我非常长的时间去理解它想表达的意思。
从此我个人对于提高项目可读性、可维护性的要求就很高了。“项目目录结构”其实也是属于“可读性和可维护性”的范畴，我们设计一个层次清晰的目录结构，就是为了达到以下两点：
1.可读性高：不熟悉这个项目的代码的人：一眼就能看懂目录结构，知道程序启动脚本是哪个，测试目录在哪儿，配置文件在那儿等等。从而非常快速的了解这个项目。
2.可维护性高：定义好组织规则后，维护者就能很明确地知道，新增的哪个文件和代码应该放在什么目录之下。这个好处是：随着时间的推移，代码/配置的规模增加，项目结构不会混乱，仍然能够组织良好。
所以，我认为，保持一个层次的目录结构是有必要的。更何况组织一个良好的工程目录，其实是一件很简单的事儿。
目录组织方式
关于如问组织一个较好的Python工程目录结构：已经有一些得到了共识的目录结构。在Stackoverflow的这个问题上，能看到大家对Python目录结构的讨论。
这里面说的已经很好了，我也不打算重新造轮子列举各种不同的方式，这里面我说一下我的理解和体会。
假设你的项目名为foo，我比较建议的最方便快捷目录结构这样就足够了：
Foo/ # 项目名
|-- bin /
| |--foo # 可执行文件，是启动脚本
| # 可执行文件放的目录
|--foo/ # 主程序目录，主要程序逻辑都在这里
| |--tests/ # 测试代码，就是单元测试等需要的测试代码
| | |-- __init__ ·py
| | |--test_main.py
| |
| |-- __init__ ·py # 要想实现 bin中的 foo 调用 main，必须有 这个文件
| |--main.py # 主程序中又分出一个 main，main是程序主入口，启动 bin 中的 foo 调用 main
|
|--docs/ # 文档
| |--conf.py
| |--abc.rst
|
|--setup.py # 安装部署脚本，执行后，需要装的东西一键搞定
|--requirements.txt # 依赖关系
|--README
# 符合类似规范的才可以称为软件
简要解释一下：
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文件等，没有列在这里是因为
这些东西主要是项目开源的时候需要用到。
关于README的内容
这是每个项目都应该有的一个文件，目的是能简要描述该项目的信息，让读者快速了解这个项目。
它需要说明以下几个事项：
1.软件定位，软件的基本功能。
2.达行代码的方法：安装环境、启动命令等。
3.简要的使用说明。
4.代码目录结构说明，更详细点可以说明软件的基本原理。
5.常见问题说明。
我觉得有以上几点是比较好的一个README。在软件开发初期， 由于开发过程中以上内容可能不明确或者发生变化，
并不是一定要在一开始就将所有信息都补全。但是在项目完结的时候，是需要撰写这样的一个文档的。
可以参考Redis源码中Readme的写法， 这里面简洁但是清晰的描述了Redis功能和源码结构。
关于requirements.txt和setup.py
setup.py
一般来说，用setup.py来管理代码的打包、安装、部署问题。
业界标准的写法用Python流行的打包工具setuptools来管理这些事情。这种方式普遍应用于
开源项目中。不过这里的核心思想不是用标准化的工具来解决这些问题，而是说，一个项目一定要有一个安装部署工具，能快速便捷的在一台新机器上将环
境装好、代码部署好和将程序运行起来。
# setup有一个标准的包管理工具 setuptools，可以用pip装python包；用 setuptools 就可以把自己写的代码打包成pip可以安装和管理的
这个别人是踩过坑的。
刚开始接触Python写项目的时候， 安装环境、部署代码、运行程序这个过程全是手动完成， 遇到过以下问题：
1.安装环境时经常忘了最近又添加了一个新的Python包， 结果一到线上运行， 程序就出错了。
2.Python包的版本依赖问题， 有时候我们程序中使用的是一个版本的Python包， 但是官方的已经是最新的包了， 通过手动安装就可能装错了。
3.如果依赖的包很多的话，一个一个安装这些依赖是很费时的事情。
4.开始写项目的时候，将程序跑起来非常麻烦，因为可能经常忘了要怎么安装各种依赖。
requirements.txt
这个文件存在的目的是：
1.方便开发者维护软件的包依赖。将开发过程中新增的包添加进这个列表中， 避免在setup.py安装依赖时漏掉软件包。
2.方便读者明确项目使用了哪些Python包。
这个文件的格式是每一行包含一个包依赖的说明， 通常是flask>=0.10 这种格式， 要求是这个格式能被pip识别， 这样就可以简单的通过pip install -r
requirements.txt来把所有Python包依赖都装好了。
关于配置文件的使用方法
注意，在上面的目录结构中，没有将conf.py放在源码目录下，而是放在docs/目录下。
# 那么如何跨目录？如何通过 bin 中的 foo 文件 调用 foo 中的 main.py？
# 在 pycharm 中，选择 File → New Directory，名称叫做 Atm （如果是一个项目，项目名首字母要大写）
# 在 atm 下创建 New Package，第一个是 bin，第二个是 conf，创建 Package 后，自动多出 __init__
atm.py在调用时希望调用 settings.py 和 main.py 应该怎么做？
1-1
print (__file__)
--->
C:/Users/Taburiss/PycharmProjects/pythonProject1/Atm/ bin /atm.py
# 返回一个相对路径，因为现在是在 pycharm 中
# 要动态获取到绝对路径，加载到环境变量中
1-1-2
import os
print (os.path.abspath(__file__))
--->
C:\Users\Taburiss\PycharmProjects\pythonProject1\Atm\bin\atm.py
# 通过相对路径，自动返回绝对路径
1-2
import os
# 在向上一级就可以找到 bin，如何向上找一级
# 列表拆分，去掉最后一个值，在拼起来，就可以，不过这样很麻烦
# dirname 返回目录名，不要文件名
print (os.path.dirname(os.path.abspath(__file__)))
--->
C:\Users\Taburiss\PycharmProjects\pythonProject1\Atm\bin
# 现在就找到了atm的上级目录
1-3
# 还需要往上一级到 Atm 文件夹 才可以import conf 和 core
# 所以需要继续向上一级
print (os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
--->
C:\Users\Taburiss\PycharmProjects\pythonProject1\Atm
1-3-1
# 现在给它赋值，并添加环境变量
import os
import sys
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
sys.path.append(BASE_DIR)
# 然后就可以 import conf,core 了
1-4
import os
import sys
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
sys.path.append(BASE_DIR)
import conf,core
# 标红是因为 pycharm 启动之前没有这个环境变量
查看更多关于20210330 软件目录结构规范的详细内容...