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()函数用于路径拼接文件路径

总结

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

您可能感兴趣的文章:

python3调用windows dos命令的例子
今天小编就为大家分享一篇python3调用windows dos命令的例子，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2019-08-08
Pyhton模块和包相关知识总结
文中详细整理了关于Python模块和包的相关知识点,刚入门Python的小伙伴们可以学习一下,有助于加深Python基础的理解.而且有详细说明及代码示例,需要的朋友可以参考下
2021-05-05
Python实现合并多个Excel文件中的指定sheet
这篇文章主要为大家介绍了一个用于合并多个Excel文件中指定sheet的Python代码,这个功能可以方便地整理和分析数据,文中的示例代码简洁易懂,需要的可以参考下
2023-10-10
详解Python的爬虫框架 Scrapy
这篇文章主要介绍了Python的爬虫框架 Scrapy的相关资料，文中讲解非常细致，代码帮助大家更好的理解和学习，感兴趣的朋友可以了解下
2020-08-08
Python中文件路径常用操作总结
这篇文章主要为大家详细介绍了Python中文件路径常用操作的相关知识,文中的示例代码讲解详细,具有一定的借鉴价值,感兴趣的小伙伴可以学习一下
2023-11-11
Python使用Crypto库实现加密解密的示例详解
这篇文章主要为大家详细介绍了Python如何使用Crypto库实现加密解密的功能，文中的示例代码讲解详细，对我们学习Python有一定的帮助，需要的可以参考一下
2023-01-01
Python 自动补全(vim)
Python自动补全有vim编辑下和python交互模式下，下面分别介绍如何在这2种情况下实现Tab键自动补全
2014-11-11
mac系统下安装pycharm、永久激活、中文汉化详细教程
这篇文章主要介绍了mac系统下安装pycharm、永久激活、中文汉化详细教程,需要的朋友可以参考下
2020-11-11
Python scikit-learn数据预处理常见方法和步骤
数据预处理是数据准备阶段的一个重要环节,主要目的是将原始数据转换成适合机器学习模型使用的格式,数据预处理可以显著提高机器学习模型的性能和准确度,本文给大家介绍了Python数据预处理常见方法和步骤,需要的朋友可以参考下
2024-05-05
Python使用jpype的踩坑记录
Pype是一个能够让 python 代码方便地调用 Java 代码的工具，这篇文章主要来和大家分享一下Python使用jpype会踩的一些坑，希望对大家有所帮助
2023-06-06