python基础-目录结构规范

最新推荐文章于 2023-12-22 14:32:54 发布

_黎先生

最新推荐文章于 2023-12-22 14:32:54 发布

阅读量158

点赞数

分类专栏： python 文章标签： python

本文链接：https://blog.csdn.net/q79815321/article/details/107694835

版权

本文讨论了Python项目中设计良好目录结构的重要性，包括提高可读性和可维护性。建议的目录结构包括bin/、core/、logs/、docs/、setup.py、requirements.txt和README。setup.py用于项目的安装、部署和打包，而requirements.txt则记录了项目的依赖包。良好的目录管理和自动化工具可以提升项目管理效率。

摘要由CSDN通过智能技术生成

目录结构规范

为什么要设计好目录结构?

“设计项目目录结构”，就和"代码编码风格"一样，属于个人风格问题。对于这种风格上的规范，一直都存在两种态度:

可读性高: 不熟悉这个项目代码的人，一眼就能看懂目录结构，知道程序启动脚本是哪个，测试目录在哪儿，配置文件在哪儿等等。从而非常快速的了解这个项目。

可维护性高: 定义好组织规则后，维护者就能很明确地知道，新增的哪个文件和代码应该放在什么目录之下。这个好处是，随着时间的推移，代码/配置的规模增加，项目结构不会混乱，仍然能够组织良好。

所以保持一个层次清晰的目录结构是有必要的。更何况组织一个良好的工程目录，其实是一件很简单的事儿。

假设你的项目名为foo, 我比较建议的最方便快捷目录结构这样就足够了:

目录结构示例

Foo/
|-- bin/
|   |-- foo
|
|-- core/
|   |-- tests/
|   |   |-- __init__.py
|   |   |-- test_main.py
|   |
|   |-- __init__.py
|   |-- main.py
|
|-- logs/
|
|-- docs/
|   |-- conf.py
|   |-- abc.rst
|
|-- setup.py
|-- requirements.txt
|-- README

解释:

bin/: 存放项目的一些可执行文件，也可以起名script/之类的。
core/: 存放项目的所有源代码，也可以命名为项目名，如foo/。(1) 源代码中的所有模块、包都应该放在此目录。不要置于顶层目