python全栈开发笔记第二模块
第四章 :常用模块(第四部分)
python的书写规范:
一、软件的目录规范
1、设计目录结构的用途
设计目录结构,和‘写代码风格’一样,属于个人风格,对于书写风格的规范,存在常见的 2 种态度:
① 一类人认为:这种‘个人风纪’或‘书写规范’无关紧要,能让程序正常运行就好,风格不算什么
② 另一类人认为:规范化可以更好的控制程序结构,分工明确,
让程序具有更高的可读性和更好的维护性(资深高级程序员的心声)
a:可读性高:更快的了解项目结构 b:便于维护:定义好规范,分工明确,可以更好的排查和拓展,
结构更清晰,组织更良好
2、所以,前者会随着互联网的发展,逐步淘汰,后者的优势逐渐明显
(1) 写任何项目都要具备的书写规范原则:
(2)项目名:小写英文,不建议大写(按照作用、时间、类别的不同 创建文件夹)
① 要有日志目录(log)(logging模块)
② 配置文件目录(conf)(configparser模块)
③ 核心代码目录(core)(一般为项目名 )
④ 第三方库包括c语言目录(libs 或 modules)(内容一般为调用第三方库)
⑤ 软件文档目录(docs)
**重要目录 ⑥ 正确使用安装与结构说明(README)
⑦ 快捷的安装方式(setup.py)一般为运行文件
**重点目录 ⑧ 程序的启动脚本,或者入口脚本(bin)(内部主要是调用执行程序的总入口)
**** 以上目录几乎是任何语言及所有程序和脚本的基本目录,或许文件命名不一样,内容大同小异,都会有类似目录存在