根據項目的大小可以分為三種目錄結構:
1. 腳本
普通的單個py文件,通常用於測試或小的代碼量使用。
if __name__ == '__main__': run() #開始程序
2. 單可執行文件
只使用單入口的程序,通常主程序在根目錄中。
3. 多可執行文件
大型的項目,有着多個入口程序(管理員,用戶等)。
目錄書寫規范:
1. 導入模塊時,遵循內置模塊——第三方模塊,由字數少到多的順序依次排列。
import 內置模塊(字數少的) import 內置模塊(字數多的) import 第三方模塊(字數少的) import 第三方模塊(字數多的)
文件創建:
存放程序的文件夾一般都會有特殊的含義,代表其功能。
---------------start.py------------------------- ''' 項目的啟動文件,運行該文件,可以成功啟動項目。 ''' import os import sys BASE_PATH = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) sys.path.append(BASE_PATH) from core.src import run if __name__ == '__main__': run() -------------------settings.py------------------------- ''' 1. 項目中的靜態路徑。(就是在整個程序運行過程中都不會進行改變的配置放到該文件中。) 2. 數據庫的連接設置 ''' -------------------src.py----------------------------- ''' 主運行文件。 ''' def run(): print('this is def-run') ---------------------commom.py------------------------ ''' 公共組件文件,將公共使用的數據放在這里。 ''' ---------------------README------------------------- 1. 軟件定位,軟件的基本功能 2. 運行代碼方法:安裝環境,啟動命令等 3. 簡要的使用說明 4. 代碼目錄結構說明,更詳細點可以說明軟件的基本原理 5. 常見問題說明
注意點:
- 只修改config文件內的配置信息,而不改整體的代碼。
- 路徑導入的問題一定要注意。
- 在多可執行文件的代碼編寫時,一定要注意方法的使用率的問題,應盡可能讓重復代碼只導入一次,而不導入多次的重復使用。