python写接口规范_Python 入门之 软件开发规范

1、软件开发规范 -- 分文件

(1)为什么使用软件开发规范

当几百行--大几万行代码存在于一个py文件中时存在的问题：

不便于管理、修改

可读性差

加载速度慢

这时可以使用软件开发规范，规范项目目录结构，规范代码，遵循PEP8规范，能够更加清晰，合理的开发。

(2)软件开发规范 -- 约定俗称

<1> bin -- 启动文件 (启动接口)

start.py 项目启动

<2> lib -- 公共文件 (大家需要的功能)

commom.py 放置一些常用的公共组件函数，像是服务于整个程序中的公用的插件。(加密，序列化，日志等功能)

<3> conf -- 配置文件 (静态文件)变量

settings.py 放置一些项目中需要的静态参数，比如文件路径，数据库配置，软件的默认设置等。

<4> core -- 主逻辑 (核心)

src.py 主要存放的是核心功能函数

<5> db -- 用户相关数据 (账号和密码等文件)

register.py 用户的相关数据

<6> log -- 日志 (记录主要信息，记录开发人员的行为)

access.log 存储日志文件

<7> README文件 简要描述该项目的信息

文件中要说明几个注意事项：

软件的定位，软件的基本功能。

运行代码的方法，安装环境，启动命令等

简要的使用说明

代码目录结构说明，更详细点可以说明软件的基本原理

常见问题说明

2、软件开发规范

"""

blog

├─ bin

│ └─ starts.py 启动文件

├─ conf

│ └─ settings.py 配置文件

├─ core

│ └─ src.py 逻辑文件

├─ db

│ └─ register.py 数据文件

├─ lib

│ └─ common.py 公共文件

└─ log

│ └─ logg.log 日志文件

├─ README.md 使用手册

"""