python3_软件目录结构规范

深碍√TFBOYSˉ_ 2022-05-14 02:48 161阅读 0赞

# 1.为什么要设计好目录结构 #

>  "项目目录结构"其实也是属于"可读性和可维护性"的范畴，我们设计一个层次清晰的目录结构，就是为了达到以下两点:
> 
>         （1）**可读性高:** 不熟悉这个项目的代码的人，一眼就能看懂目录结构，知道程序启动脚本是哪个，测试目录在哪儿，配 置文件在哪儿等等。从而非常快速的了解这个项目。
> 
>         （2）**可维护性高:** 定义好组织规则后，维护者就能很明确地知道，新增的哪个文件和代码应该放在什么目录之下。这个好处是，随着时间的推移，代码/配置的规模增加，项目结构不会混乱，仍然能够组织良好。

# 2.目录组织方式 #

> 假设你的项目名为foo，比较建议的最方便快捷目录结构如下:

> **具体目录及文件解释如下：**
> 
> 1. **bin/**: 存放项目的一些可执行文件。
> 
> 2. **`foo/`**: 存放项目的所有源代码。(1) 源代码中的所有模块、包都应该放在此目录。不要置于顶层目录。
> 
>                                                      (2) 其子目录**`tests/`**存放单元测试代码
> 
>                                                      (3)程序的入口最好命名为**`main.py`**
> 
> 3. **`docs/`**: 存放一些文档。
> 
> 4. **`setup.py`**: 安装、部署、打包的脚本。
> 
> 5. **`requirements.txt`**: 存放软件依赖的外部Python包列表。
> 
> 6. **`README`**: 项目说明文件
> 
> 7. **log**: 存放日志

# 3.关于配置文件的使用方法 #

>         不应当在代码中直接`import conf`来使用配置文件。上面目录结构中的`conf.py`，是给出的一个配置样例，不是在写死在程序中直接引用的配置文件。可以**通过给`main.py`启动参数指定配置路径的方式来让程序读取配置内容**。当然，这里的`conf.py`你可以换个类似的名字，比如`settings.py`。或者你也可以使用其他格式的内容来编写配置文件，比如`settings.yaml`之类的。

# 4.关于setup.py #

>         一般来说，用`setup.py`来管理代码的打包、安装、部署问题。业界标准的写法是用Python流行的打包工具**[setuptools][]**来管理这些事情。这种方式普遍应用于开源项目中。不过这里的核心思想不是用标准化的工具来解决这些问题，而是说，一个项目一定要有一个安装部署工具，能快速便捷的在一台新机器上将环境装好、代码部署好和将程序运行起来。
> 
>         刚开始接触Python写项目的新手，安装环境、部署代码、运行程序这个过程全是手动完成，遇到过以下问题:（1）安装环境时经常忘了最近又添加了一个新的Python包，结果一到线上运行，程序就出错了。（2）Python包的版本依赖问题，有时候我们程序中使用的是一个版本的Python包，但是官方的已经是最新的包了，通过手动安装就可能装错了。（3）如果依赖的包很多的话，一个一个安装这些依赖是很费时的事情。
> 
> `   setup.py`**可以将这些事情自动化起来，提高效率、减少出错的概率。"复杂的东西自动化，能自动化的东西一定要自动化。"是一个非常好的习惯。**
> 
>         setuptools的[文档][setuptools]比较庞大，刚接触的话，可能不太好找到切入点。学习技术的方式就是看他人是怎么用的，可以参考一下Python的一个Web框架，flask是如何写的: [setup.py][]。当然，简单点自己写个安装脚本（`deploy.sh`）替代`setup.py`也未尝不可。

# 5.关于requirements.txt #

> 这个文件存在的目的是:
> 
>         （1）方便开发者维护软件的包依赖。将开发过程中新增的包添加进这个列表中，避免在`setup.py`安装依赖时漏掉软件包。（2）方便读者明确项目使用了哪些Python包。
> 
>         这个文件的格式是每一行包含一个包依赖的说明，通常是`flask>=0.10`这种格式，要求是这个格式能被`pip`识别，这样就可以简单的通过 **`pip install -r requirements.txt`**来把所有Python包依赖都装好了。

# 6.关于README #

> 它需要说明以下几个事项:
> 
>         （1）软件定位，软件的基本功能。（2）运行代码的方法: 安装环境、启动命令等。（3）简要的使用说明。（4）代码目录结构说明，更详细点可以说明软件的基本原理。（5）常见问题说明。
> 
>         我觉得有以上几点是比较好的一个`README`。在软件开发初期，由于开发过程中以上内容可能不明确或者发生变化，并不是一定要在一开始就将所有信息都补全。但是在项目完结的时候，是需要撰写这样的一个文档的。

[setuptools]: https://pythonhosted.org/setuptools/setuptools.html#developer-s-guide
[setup.py]: https://github.com/mitsuhiko/flask/blob/master/setup.py