简单python程序的目录结构

  • 学习并使用python有一段时间了,虽然能够写python达到想要目的,但是一直没有关注过一个应用程序应该有的目录结构。
  • 在测试工作中,经常需要写一些小工具来造测试数据或者帮助测试,虽然代码量很小,我之前都将所有的代码写在一个文件中,也不习惯写成方法调用,所以往往会造成代码不能复用、可读性低、通篇很多重复的代码、配置参数也是满篇都是很不方便找,并且执行程序也很麻烦需要一个个的先后执行,非常不利于维护和使用。于是尝试了进行目录结构化,下面以最近写的一个小程序为例:

  • insert_testdata/insert_testdata: 存放项目的所有源代码。business中存放业务逻辑代码,database中存放连接和操作数据库的代码,(还可以有test文件存放单元测试代码)程序入口为main.py
  • insert_testdata/setting: 存放一些配置的参数。如:连接数据库的信息,可以在该文件中配置测试环境或是生产环境的数据量连接信息
  • requirements.txt: 存放软件依赖的外部Python包列表。(方便读者明确项目使用了哪些Python包。这个文件的格式是每一行包含一个包依赖的说明,通常是flask>=0.10这种格式,要求是这个格式能被pip识别,这样就可以简单的通过 pip install -r requirements.txt来把所有Python包依赖都装好了。)
  • README: 项目说明文件(包含:1.软件定位,软件的基本功能。2.运行代码的方法: 安装环境、启动命令等。3.简要的使用说明。4.代码目录结构说明,更详细点可以说明软件的基本原理。5.常见问题说明。)

希望自己以后都养成目录结构化的好习惯,一步步的变得越来越规范和专业加油加油ヾ(๑╹◡╹)ノ”