如果您一直按照我們的指南進行操作,那麼您現在已經使用 Python 設定了 Visual Studio Code 以及專案文件,其中儲存了虛擬環境。當您處理專案時,您也希望在虛擬環境中工作。如果這些對您來說聽起來很陌生,那麼返回並從頭開始可能是個好主意。對於我們其他人來說,這應該是我們開始進行一些實際編碼之前的最後一部分。這次,我們將設置文件系統,這非常簡單,但卻是整個專案的支柱,幫助我們保持一切井井有條且可訪問,無論它有多大。
如前所述,精心設計的資料夾結構將幫助您將所有內容井然有序,從而輕鬆找到您需要的內容。它還可以讓您的專案不斷發展,而不會變得混亂或混亂。
組織好的文件還將促進團隊合作並符合行業標準,確保您的專案易於維護或與其他系統整合。
以下是我們建議新增到專案文件中的資料夾列表,以及您應該已經擁有的虛擬環境資料夾。若要建立資料夾,請右鍵單擊一側並選擇“新資料夾”。雖然這些資料夾現在是空的,但隨著您開發項目,它們會很快填滿。
原始碼/
src/ 資料夾將保存專案的所有來源檔案。這些腳本將執行專案的主要任務,例如文件處理、搜尋或分析資料。
測試/
測試資料夾將保存您建立的用於測試 src/ 資料夾中的腳本的任何腳本。此資料夾中的文件將有助於確保您的專案正常運作並且沒有故障和錯誤。將此資料夾視為調試器。
數據/
資料資料夾是您儲存程式所需的任何資料的位置。例如,如果您有一個腳本需要檢查電子表格中的資訊。您將將該電子表格保留在資料檔案中。您還將儲存腳本的輸出,以便稍後比較或查看它們。
紀錄/
日誌資料夾將包含程式產生的所有日誌,主要是偵錯程式碼所需的錯誤日誌。
文件/
文檔文件將保存與您的程式相關的文檔,包括使用者指南或技術參考。
要求.txt
requirements.txt 檔案不是資料夾,但最好將其包含在目錄設定中,以便使其保持最新。此文件列出了您正在使用的所有 Python 庫,這可以使其他團隊成員更輕鬆地在其電腦上設定相同的環境。如果您喜歡在多台電腦上編碼,它也會很有幫助。
自述文件.md
.md 檔案是使用 Markdown 語言格式化文字的 Markdown 文件檔案。我們可以使用它來建立一個文件,向人們介紹您的程式並提供如何使用它的說明。寫下來看看它隨著時間的推移如何變化可能很有趣,或者你可以暫時不寫它。
無論您是單獨工作還是與團隊協作,此資料夾結構都是任何 Python 專案的堅實基礎。我們將在這個項目中使用它。