軟體開發目錄規範

2022-09-18 18:12:14 字數 1139 閱讀 3494

軟體的目錄規範並沒有什麼硬性要求,

但是為了清晰可讀,為了提高程式的可讀性與可維護性,應該給軟體設計良好的目錄結構

一、bin檔案/run.py或者start.py

程式的啟動檔案,如果執行檔案較少,可以直接放在專案的根目錄下,

因為在執行時會預設將執行檔案所在的資料夾作為sys.path的第乙個路徑,這樣就省去了處理環境變數的步驟

二、core檔案/src.py

core檔案,存放邏輯相關**

三、api檔案/inte***ce

api檔案,存放介面檔案,介面主要用於為業務邏輯提供資料操作

四、db檔案/db_handle.py

db檔案,存放運算元據庫相關檔案,主要用於與資料庫互動

五、lib檔案/common.py

library庫檔案,存放程式中常用的自定義模組

一般寫公共的檔案

六、conf檔案/settings.py

config檔案,存放配置檔案

七、log檔案

日誌方便排查錯誤

八、requestment.txt

儲存第三方模組的模組名

九、redme

對專案的解釋,類似於說明書

補充:在mac系統和linux系統中使用

ls: 檢視當前資料夾下的所有的資料夾和檔案

在windows系統中

dir:檢視當前資料夾下的所有的資料夾和檔案

1、在執行檔案中不能寫相對路徑

2、在自己電腦上寫的路徑,放在別人電腦上不能正確執行

3、pycharm比python直譯器的路徑多了乙個根目錄

所以需要找到一種合適的配置路徑的方式,使得檔案匯入不報錯

__file__的返回值是:當前檔案的絕對路徑+檔名

os模組中 os.path.abspath(__file__)的返回值是:當前檔案的絕對路徑+檔名

這裡__file__等價於os.path.abspath(__file__),後者更規範

os模組中 os.path.dirname(__file__)表示把當前路徑向上提一層

os.path.dirname(os.path.dirname(__file__))表示再把當前路徑向上提一層

直到提公升到根目錄處,把所得路徑賦值給base_path

python軟體開發目錄 軟體開發目錄規範

為了提高程式的可讀性與可維護性,我們應該為軟體設計良好的目錄結構,這與規範的編碼風格同等重要。軟體的目錄規範並無硬性標準,只要清晰可讀即可,假設你的軟體名為foo,筆者推薦目錄結構如下 foo core 存放業務邏輯相關 core.py api 存放介面檔案,介面主要用於為業務邏輯提供資料操作。ap...

軟體開發目錄規範

為了提高程式的可讀性與可維護性,我們應該為軟體設計良好的目錄結構,這與規範的編碼風格同等重要,簡而言之就是把軟體 分檔案目錄。假設你要寫乙個atm軟體,你可以按照下面的目錄結構管理你的軟體 atm core src.py 業務核心邏輯 api api.py 介面檔案 db db handle.py ...

軟體開發目錄規範

為了提高程式的可讀性與可維護性,我們應該為軟體設計良好的目錄結構,這與規範的編碼風格同等重要。軟體的目錄規範並無硬性標準,只要清晰可讀即可,假設你的軟體名為foo,筆者推薦目錄結構如下 foo core 存放業務邏輯相關 core.py api 存放介面檔案,介面主要用於為業務邏輯提供資料操作。ap...