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重要函数eval多种用法解析
这篇文章主要介绍了python重要函数eval多种用法解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-01-01
py中的目录与文件判别代码
python中的判别目录和文件的脚本
2008-07-07
Pytest fixture及conftest相关详解
这篇文章主要介绍了Pytest fixture及conftest相关详解，fixture是在测试函数运行前后，由pytest执行的外壳函数，更多相关内容需要的朋友可以参考一下
2022-09-09
pycharm远程连接vagrant虚拟机中mariadb数据库
这篇文章主要介绍了pycharm远程连接vagrant虚拟机中mariadb数据库,需要的朋友可以参考下
2020-06-06
Python实现遍历数据库并获取key的值
本文给大家分享的是Python实现遍历数据库并获取key的值的方法，主要是使用for循环来实现，有需要的小伙伴可以参考下。
2015-05-05
pytorch中的模型训练(以CIFAR10数据集为例)
这篇文章主要介绍了pytorch中的模型训练(以CIFAR10数据集为例)，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2023-06-06
pandas实现数据合并的示例代码
本文主要介绍了pandas实现数据合并的示例代码，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2022-05-05
opencv python 傅里叶变换的使用
这篇文章主要介绍了opencv python 傅里叶变换的使用，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2018-07-07
python2.7实现复制大量文件及文件夹资料
这篇文章主要为大家详细介绍了python2.7实现复制大量文件及文件夹资料，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2019-08-08
在Python中如何使用yield
在 Python 开发中,yield 关键字的使用其实较为频繁,例如大集合的生成,简化代码结构、协程与并发都会用到它,文中详细介绍了yield的用法,需要的朋友可以参考下
2021-06-06