python中的项目目录结构

更新时间：2024年02月18日 14:37:46 作者：没有刺的仙人掌

这篇文章主要介绍了python中的项目目录结构,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教

一、常见的结构

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

在Stackoverflow的这个问题上，能看到大家对Python目录结构的讨论。

这里面说的已经很好了，我也不打算重新造轮子列举各种不同的方式，这里面我说一下我的理解和体会。

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

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

简要解释一下

bin/: 存放项目的一些可执行文件，当然你可以起名script/之类的也行。
foo/: 存放项目的所有源代码。

(1) 源代码中的所有模块、包都应该放在此目录。不要置于顶层目录。

(2) 其子目录tests/存放单元测试代码；

(3) 程序的入口最好命名为main.py。

docs/: 存放一些文档。
setup.py: 安装、部署、打包的脚本。
requirements.txt: 存放软件依赖的外部Python包列表。
README: 项目说明文件。

除此之外，有一些方案给出了更加多的内容。

比如LICENSE.txt,ChangeLog.txt文件等，我没有列在这里，因为这些东西主要是项目开源的时候需要用到。

二、如何解决多次目录下数据的导入？

1.比如main.py

导入docs文件中的conf.py中的函数

from docs improt conf         #这样的导入是不成功的

因为from导入的是该目录即foo文件下的文件夹，docs与foo文件夹是一级的目录导入不成功

2.解决方案

import os,sys
 
path = os.path.join(os.path.dirname(os.path.abspath(__file__))) 
#返回脚本的绝对路径
sys.path.append(path)
#临时添加搜索路径，这种方法导入的路径会在python程序退出后失效。
 
 
 
#path1=os.path.abspath(__file__)
#print(path1)#当前文件的绝对路径
 
#path2=os.path.dirname(os.path.abspath(__file__))
#print(path2)#当前文件的上一层目录的绝对路径
 
#path3=os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
#print(path3)#当前文件的上上层目录的绝对路径
 
#os.path.join()函数用于路径拼接文件路径

总结

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

Python实现可视化CSV文件中的数据
CSV文件包含许多记录,数据分布在各行和各列中,在这篇文章中,小编主要为大家详细介绍了Python如何实现可视化CSV文件中的数据,感兴趣的小伙伴可以跟随小编一起学习一下
2023-11-11
详解Python中的序列化与反序列化的使用
这篇文章主要介绍了详解Python中的序列化与反序列化的使用,针对pickle和cPickle对象进行了探究,需要的朋友可以参考下
2015-06-06
Python中的自省（反射）详解
这篇文章主要介绍了Python中的自省（反射）详解,本文讲解了通过访问对象的属性、访问对象的元数据、确定对象的类型等内容,需要的朋友可以参考下
2015-06-06
浅谈Python 字符串格式化输出(format/printf)
下面小编就为大家带来一篇浅谈Python 字符串格式化输出(format/printf)。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2016-07-07
通过conda把已有虚拟环境的python版本进行降级操作指南
当使用conda创建虚拟环境时,有时候可能会遇到python版本不对的问题,下面这篇文章主要给大家介绍了关于如何通过conda把已有虚拟环境的python版本进行降级操作的相关资料,需要的朋友可以参考下
2024-05-05
Python技能树共建之python urllib 模块
这篇文章介绍了Python技能树共建之python urllib 模块，urllib模块是 Python 标准库，更多相关介绍需要的小伙伴可以参考下面文章的详细内容
2022-05-05
python中@staticmethod方法的使用
这篇文章主要介绍了python中@staticmethod方法的使用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2023-09-09
快速进修Python指南之文件操作
这篇文章主要为大家介绍了Java开发者快速进修Python指南之文件操作示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
2023-12-12
Python中逗号的三种作用实例分析
这篇文章主要介绍了Python中逗号的三种作用,实例分析了Python中的逗号在类型转换与打印输出时的使用技巧,需要的朋友可以参考下
2015-06-06
python提取word文件中的所有图片
办公中，偶尔会碰到一种情况，需要提取word文档中的图片，决定写这样一款工具自动提取图片，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2021-05-05