python软件目录结构规范

diaozang2773

于 2017-05-03 18:32:00 发布

阅读量486

点赞数

文章标签： python 数据库测试

原文链接：http://www.cnblogs.com/xuyuanyuan123/p/6803332.html

版权

良好的Python软件目录结构有助于提高代码可读性和可维护性。本文介绍了为什么需要设计好目录结构，包括便于新开发者理解项目、保持代码组织有序。推荐了一种通用的Python工程目录组织方式，并强调了README文件的重要作用，如描述项目定位、运行方法、使用说明和代码结构。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

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

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

关于如何组织一个较好的Python工程目录结构，已经有一些得到了共识的目录结构。

假设你的项目名为ATM

ATM/
|-- bin/    存放项目的一些可执行文件，当然你可以起名script/之类的也行，但bin/更直观。易懂
|   |-- __init__
|　 |-- start.py   写启动程序
|
|-- core/   存放项目的所有源代码(核心代码）。(1) 源代码中的所有模块、包