一 程序配置
选择一个文件settings.py放置项目中的静态参数,比如文件路径,数据库配置,软件的默认设置等等
二 文件划分而治
针对不同的函数功能的模块,放在不同的文件中。具体分类如下
1 配置文件:settings.py 放置项目中的静态参数,比如文件路径,数据库配置,软件的默认设置等等
2 公共组件文件common.py 放置我们常用的公共组件函数,并不是核心逻辑函数,像是服务于整个程序的公用的插件,比如装饰器,日志功能,序列化功能
3 核心逻辑文件 src.py 放置核心功能函数
4 项目启动文件 start.py 项目需要专门的文件启动
5 文本数据库文件,项目中有的数据需要存储在文件中,与程序交互的时候需要设置这样的文件
6 log文件 存储日志的文件,主要供开发者使用,用来检测bug
7 创建目录存放不同功能类型的文件
三 进一步规范
1 为了方便导入模块中的函数,需要将文件路径添加到系统path
import sys
import os
print(os.path.dirname(__file__)) //获取本文件的绝对路径
print(os.path.dirname(os.path.dirname(__file__)))
BATH_DIR=os.path.dirname(os.path.dirname(__file__))
sys.path.append(BATH_DIR) //添加路径到系统路径中
from core.src import run
run()
2 配置start.py:为了安全性,仅让启动文件具有执行权限,需要进一步完善文件
if __name__=='__main__':
run()
3 配置settings.py:项目的静态路径,数据库连接文件存放在这里。
src.py文件代码片段如下:
status_dic = {
'username': None,
'status': False,
}
flag = True
register_path = r'D:lnh.pythonpy project eaching_showlog
egister'
核心代码中有几个变量,并非所有的变量都会存放在settings.py,只有静态,长时间不变的才会存放。比如register_path。但是为了避免src.py中出现引用register_path错误的问题,还需要添加导入语句。from settings.py import register_path
4 配置common.py文件
这里可以放装饰器,由于装饰器会调用到src.py的某些变量或者函数,所以需要在common.py导入src.py. from core import src
而由于src.py中也会用到装饰器,所以也需要导入common.py。from lib import common
5 readme
软件定位,软件的基本功能
运行代码的方法,安装环境,启动命令
简要的使用说明
代码的目录结构说明
常见问题说明