python 软件目录结构规范

发布时间：2018-03-02 14:36:11编辑：admin阅读（3609）

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

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




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

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

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




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

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

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




目录组织方式

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

https://stackoverflow.com/questions/193161/what-is-the-best-project-structure-for-a-python-application




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




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

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) 其子目录tests/存放单元测试代码； (3) 程序的入口最好命名为main.py。

docs/: 存放一些文档。

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

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

README: 项目说明文件。

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

https://pip.readthedocs.io/en/1.1/requirements.html




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




关于README的内容

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




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




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

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

  3.简要的使用说明。

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

  5.常见问题说明。




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




可以参考Redis源码中Readme的写法，这里面简洁但是清晰的描述了Redis功能和源码结构。

https://github.com/antirez/redis#what-is-redis




关于requirements.txt和setup.py

setup.py




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




这个我是踩过坑的。




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




安装环境时经常忘了最近又添加了一个新的Python包，结果一到线上运行，程序就出错了。

Python包的版本依赖问题，有时候我们程序中使用的是一个版本的Python包，但是官方的已经是最新的包了，通过手动安装就可能装错了。

如果依赖的包很多的话，一个一个安装这些依赖是很费时的事情。

新同学开始写项目的时候，将程序跑起来非常麻烦，因为可能经常忘了要怎么安装各种依赖。

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




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




当然，简单点自己写个安装脚本（deploy.sh）替代setup.py也未尝不可。




requirements.txt

这个文件存在的目的是:




  1.方便开发者维护软件的包依赖。将开发过程中新增的包添加进这个列表中，避免在setup.py安装依赖时漏掉软件包。

  2.方便读者明确项目使用了哪些Python包。

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

https://pip.readthedocs.io/en/1.1/requirements.html




关于配置文件的使用方法

注意，在上面的目录结构中，没有将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之类的。




举个简单的例子

有一个Atm项目，目录结果如下:



目前所有文件内容都是空的

编辑main.py，内容如下

def login():
    print("Welcome to my atm")




bin/atm.py想要执行core/main.py文件的代码，怎么办呢？


先编辑bin/atm.py，打印文件路径，内容如下:

print(__file__)

执行输出

E:/python_script/Atm/bin/atm.py

注意，这是一个相对路径，这是Pycharm编辑器显示的。

如果用cmd执行，就不是这样了



动态获取绝对路径


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

cmd再次执行




返回当前目录名

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

执行输出

E:\python_script\Atm\bin

返回上一级目录，也就是程序根目录


import os
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
print(BASE_DIR)

执行输出

E:\python_script\Atm




将程序根目录加入到环境变量中，并执行login()

import os
import sys
#项目根目录
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
#添加系统环境变量
sys.path.append(BASE_DIR)
#导入模块
from conf import settings
from core import main
#执行函数
if __name__ == '__main__':
    main.login()

执行输出

Welcome to my atm

关键字：