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/: 存放項目的一些可執(zhí)行文件，當然你可以起名script/之類的也行。
foo/: 存放項目的所有源代碼。

(1) 源代碼中的所有模塊、包都應該放在此目錄。不要置于頂層目錄。

(2) 其子目錄tests/存放單元測試代碼；

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

docs/: 存放一些文檔。
setup.py: 安裝、部署、打包的腳本。
requirements.txt: 存放軟件依賴的外部Python包列表。
README: 項目說明文件。

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

比如LICENSE.txt,ChangeLog.txt文件等，我沒有列在這里，因為這些東西主要是項目開源的時候需要用到。

二、如何解決多次目錄下數(shù)據的導入？

1.比如main.py

導入docs文件中的conf.py中的函數(shù)

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()函數(shù)用于路徑拼接文件路徑