软件开发目录规范

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

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

1. 一类同学认为，这种个人风格问题"无关紧要"。理由是能让程序work就好，风格问题根本不是问题。
2. 另一类同学认为，规范化能更好的控制程序结构，让程序具有更高的可读性。

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

1. 可读性高: 不熟悉这个项目的代码的人，一眼就能看懂目录结构，知道程序启动脚本是哪个，测试目录在哪儿，配置文件在哪儿等等。从而非常快速的了解这个项目。
2. 可维护性高: 定义好组织规则后，维护者就能很明确地知道，新增的哪个文件和代码应该放在什么目录之下。这个好处是，随着时间的推移，代码/配置的规模增加，项目结构不会混乱，仍然能够组织良好。

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

目录组织方式

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

假设你的项目名为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: 项目说明文件。

django目录结构：

▸ django/  源码

▸ docs/  文档，网站看的内容基本都在这里面

▸ extras/    格外的信息，没什么用

▸ js_tests/   测试JS的代码

▸ scripts/    翻译的文件一类的东西

▸ tests/   单元测试

  AUTHORS  作者

  CONTRIBUTING.rst 贡献说明

  Gruntfile.js js构建配置Grunt

  INSTALL

  LICENSE

  LICENSE.python

  MANIFEST.in  打包配置

  package.json  js包配置

  README.rst

  setup.cfg  打包

  setup.py 打包

  tox.ini  打包

源码目录：

 ▸ apps/  App配置

  ▸ bin/

  ▸ conf/  工程模板，老的url配置

  ▸ contrib/   第三方贡献代码，但也包含常用模块如auth、session等。

  ▸ core/  核心包，缓存、邮件、HTTP处理等

  ▸ db/  数据库交互部分，Model、Field、SQL就在这个里面

  ▸ dispatch/ Signal处理的逻辑

  ▸ forms/  form以及对应的组件

  ▸ http/   request和response所在

  ▸ middleware/  常用中间件

  ▸ template/  模板引擎

  ▸ templatetags/  内置的模板tag

  ▸ test/  单元测试模块

  ▸ urls/  现代化的url包

  ▸ utils/  很多Web开发中很实用的工具都在里面

  ▸ views/  view层的内容都在这, cache、csrf、Class-based View等

    __init__.py

    __main__.py

    shortcuts.py  一些快捷方式

转载于:https://www.cnblogs.com/lshedward/p/10013606.html