python开发规范手册,python基础目录

　　本章着重于：

　　了解开发人标软件时如何布局项目目录结构，注意开发规范的重要性。

　　第一，为什么要有一个好的目录结构？

　　二、目录组织的方式

　　三。自述文件的内容

　　四。关于requirements.txt和setup.py

　　==================================================================================

　　第一，为什么要有一个好的目录结构？

　　好的设计项目目录结构，就像编码风格一样，是每个程序员都有的风格，但在精简标准化的过程中，不鼓励个性和风格。

　　如果你去维护一个非常糟糕的项目，虽然实现逻辑并不复杂，但对于后续的维护者来说，这将是一场灾难。

　　清晰的目录结构可以提高程序的可维护性；

　　1.高可读性：

　　后续的维护人员一眼就能看懂目录结构，不用花很多精力在复杂混乱的关卡上。测试文件在哪里，配置文件在哪里，都会放在标准操作的地方，方便后续人员快速了解项目。

　　2.高维护性：

　　维护人员看清目录结构后，就可以按照规范把后续新增的文件和代码放到指定的地方。虽然后续的代码和文件增加了，但是项目目录并不会乱，依然可以组织的又快又好。

　　所以维护一个层次化的清理目录结构是非常必要的，也是体现一个程序员思维和视野格局的一个标准。

　　二、目录组织的方式

　　目前，各种开发语言已经实现了工程目录结构中一些常见的目录结构。

　　例如，通过以下简单的ATM目录结构，开发者可以快速了解启动门户、用户层模块、逻辑接口层模块、数据处理模块、日志模块等。

　　下面的foo项目是一个清晰合理的目录结构。

　　Bin:/存储项目的一些可执行文件，比如脚本/文件。

　　o:/存储项目的所有源代码

　　1.源代码中的所有模块和包都放在这个目录中，而不是顶层目录。

　　2.子目录tests/用于存储单元测试代码。

　　3.程序的入口一般命名为main.py

　　文档：/存储一些文档

　　Setup.py:/安装、部署和打包脚本

　　Requirements.txt:软件所依赖的外部Python包的列表。

　　自述文件：项目描述文件

　　另外一些开源软件会有LECENSE.txt，ChangeLog.txt等文件，目录组织和这个差不多。

　　三。自述文件的内容

　　README在GITHUB中很常见，一般是必须的。本文档将简要介绍该项目的信息，以便读者快速了解该项目的情况。

　　自述文件一般说明以下事项：

　　1.软件的定位，软件的基本功能

　　2.运行代码的方法、安装环境和启动命令。

　　3.简单的使用说明

　　4.代码的目录结构描述可以详细解释软件的基本原理。

　　5.常见问题描述

　　四。关于requirements.txt和setup.py

　　setup.py

　　一般来说，setup.py用于管理代码打包、安装和部署的问题。行业标准的编写方式是使用Python流行的打包工具setuptools来管理这些东西，在开源项目中广泛使用。

　　但是，这里的核心思想并不是用标准化的工具来解决这些问题，而是说一个项目必须有一个安装部署工具，能够快速方便地在新机器上安装环境，部署代码，运行程序。

　　requirements.txt

　　该文件的目的是：

　　1.方便开发者维护软件包依赖性。将开发过程中的新包添加到此列表中，以避免setup.py安装依赖项时丢失包。

　　2.方便读者了解项目中使用了哪些Python包。

　　这个文件的格式是每行包含一个包依赖关系的描述，通常是flask=0.10的格式。要求是这种格式可以被pip识别，这样所有Python包的依赖项都可以简单地通过pipinstall-rRequirements.txt安装。

　　转载请联系作者取得转载授权，否则将追究法律责任。

郑重声明：本文由网友发布，不代表盛行IT的观点，版权归原作者所有，仅为传播更多信息之目的，如有侵权请联系，我们将第一时间修改或删除，多谢。