首页 > 代码库 > Python基础之软件目录结构规范

Python基础之软件目录结构规范

设计一个层次清晰的目录结构,就是为了达到这两点:

  1. 可读性高:不熟悉项目的人,一眼就能看懂目录结构。
  2. 可维护性高:随着时间的推移,代码/配置的规模增加,项目结构不会混乱,仍然能够组织良好。

目录组织方式:

ATM
├── bin
│   └── start.py
├── conf
│   └── settings.py
├── core
│   └── test_main.py
├── db
│   └── db.json
├── docs
├── lib
│   └── common.py
├── log
│   └── access.log
└── README

简单解释一下:

  1. bin :存放项目的一些可执行文件,当然你可以起名script/之类的也行。
  2. conf :配置文件目录
  3. core:核心代码目录
  4. db:数据目录
  5. docs :存放一些说明文档。
  6. lib:库文件,存放一些自定义模块和包
  7. log:日志目录
  8. README 安装说明

关于README的内容:

README的作用是描述该项目的信息,让读者快速了解这个项目。
它需要说明以下几个事项:

  1. 软件定位,软件的基本功能。
  2. 运行代码的方法:安装环境、启动命令等。
  3. 简要的使用说明。
  4. 代码目录结构说明,更详细点可以说明软件的基本原理。
  5. 常见问题说明。

关于requirements.txt和setup.py

技术分享
一般来说,用setup.py来管理代码的打包、安装、部署问题。业界标准的写法是用Python流行的打包工具setuptools来管理这些事情。这种方式普遍应用于开源项目中。不过这里的核心思想不是用标准化的工具来解决这些问题,而是说,一个项目一定要有一个安装部署工具,能快速便捷的在一台新机器上将环境装好、代码部署好和将程序运行起来。
这个我是踩过坑的。
我刚开始接触Python写项目的时候,安装环境、部署代码、运行程序这个过程全是手动完成,遇到过以下问题:
1、安装环境时经常忘了最近又添加了一个新的Python包,结果一到线上运行,程序就出错了。
2、Python包的版本依赖问题,有时候我们程序中使用的是一个版本的Python包,但是官方的已经是最新的包了,通过手动安装就可能装错了。
3、如果依赖的包很多的话,一个一个安装这些依赖是很费时的事情。
4、新同学开始写项目的时候,将程序跑起来非常麻烦,因为可能经常忘了要怎么安装各种依赖。
setup.py可以将这些事情自动化起来,提高效率、减少出错的概率。"复杂的东西自动化,能自动化的东西一定要自动化。"是一个非常好的习惯。
setuptools的文档比较庞大,刚接触的话,可能不太好找到切入点。学习技术的方式就是看他人是怎么用的,可以参考一下Python的一个Web框架,flask是如何写的: setup.py
当然,简单点自己写个安装脚本(deploy.sh)替代setup.py也未尝不可。
setup.py说明
技术分享
这个文件存在的目的是:
1、方便开发者维护软件的包依赖。将开发过程中新增的包添加进这个列表中,避免在setup.py安装依赖时漏掉软件包。
2、方便读者明确项目使用了哪些Python包。
这个文件的格式是每一行包含一个包依赖的说明,通常是flask>=0.10这种格式,要求是这个格式能被pip识别,这样就可以简单的通过 pip install -r requirements.txt来把所有Python包依赖都装好了。
requirements.txt说明

关于配置文件的使用方法:

技术分享
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之类的。
配置文件说明

 

关于作业:

作业必备知识:

  1. 模块导入
  2. 目录组织结构
  3. 函数
  4. 第三方模块(序列化、logging)
  5. 装饰器
  6. 使用面向过程开发(ATM程序是不经常更改得程序)

软件开发流程:

  1. 画流程图
  2. 写README
  3. 严格按照软件开发规范去开发程序

作业需求:

模拟实现一个ATM + 购物商城程序

  1. 额度 15000或自定义
  2. 实现购物商城,买东西加入 购物车,调用信用卡接口结账
  3. 可以提现,手续费5%
  4. 每月22号出账单,每月10号为还款日,过期未还,按欠款总额 万分之5 每日计息
  5. 支持多账户登录
  6. 支持账户间转账
  7. 记录每月日常消费流水
  8. 提供还款接口
  9. ATM记录操作日志 
  10. 提供管理接口,包括添加账户、用户额度,冻结账户等。。。
  11. 用户认证用装饰器

示例代码 https://github.com/triaquae/py3_training/tree/master/atm 

简易流程图:https://www.processon.com/view/link/589eb841e4b0999184934329 

 

参考链接:http://www.cnblogs.com/alex3714/articles/5765046.html

Python基础之软件目录结构规范