根据项目的大小可以分为三种目录结构:
1. 脚本
普通的单个py文件,通常用于测试或小的代码量使用。
if __name__ == \'__main__\': run() #开始程序
2. 单可执行文件
只使用单入口的程序,通常主程序在根目录中。
3. 多可执行文件
大型的项目,有着多个入口程序(管理员,用户等)。
目录书写规范:
1. 导入模块时,遵循内置模块——第三方模块,由字数少到多的顺序依次排列。
import 内置模块(字数少的) import 内置模块(字数多的) import 第三方模块(字数少的) import 第三方模块(字数多的)
文件创建:
存放程序的文件夹一般都会有特殊的含义,代表其功能。
---------------start.py------------------------- \'\'\' 项目的启动文件,运行该文件,可以成功启动项目。 \'\'\' import os import sys BASE_PATH = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) sys.path.append(BASE_PATH) from core.src import run if __name__ == \'__main__\': run() -------------------settings.py------------------------- \'\'\' 1. 项目中的静态路径。(就是在整个程序运行过程中都不会进行改变的配置放到该文件中。) 2. 数据库的连接设置 \'\'\' -------------------src.py----------------------------- \'\'\' 主运行文件。 \'\'\' def run(): print(\'this is def-run\') ---------------------commom.py------------------------ \'\'\' 公共组件文件,将公共使用的数据放在这里。 \'\'\' ---------------------README------------------------- 1. 软件定位,软件的基本功能 2. 运行代码方法:安装环境,启动命令等 3. 简要的使用说明 4. 代码目录结构说明,更详细点可以说明软件的基本原理 5. 常见问题说明
注意点:
- 只修改config文件内的配置信息,而不改整体的代码。
- 路径导入的问题一定要注意。
- 在多可执行文件的代码编写时,一定要注意方法的使用率的问题,应尽可能让重复代码只导入一次,而不导入多次的重复使用。