如何優(yōu)雅的搭建 Python 項目
當(dāng)你熟悉了 Python 之后,就不會再滿足只寫一個腳本就完事,這個時候就需要考慮項目結(jié)構(gòu)的事情了,尤其與別人合作完成一個項目的時候,項目的結(jié)構(gòu)尤其重要。
本文分享如何優(yōu)雅的開啟一個 Python 項目。
簡單來講,分為 5 個步驟:
1、創(chuàng)建虛擬環(huán)境
你可以在項目目錄中執(zhí)行下面的命令,然后就會生成一個 venv 目錄,這就是 Python 的虛擬環(huán)境,后面記得把 venv 添加到 .gitignore 文件中,避免被 Git 管理,從而避免上傳到 GitHub。
python3 -m venv venv #創(chuàng)建
source venv/bin/activate #激活
deactivate #取消激活
在后面的編碼過程中,我們會 pip install 一些依賴,項目依賴全部安裝完成后,記得執(zhí)行 pip freeze> requirements.txt 來保存項目的依賴,以便后續(xù)遷移或者部署的時候,可以很快安裝依賴。
2、建立單獨的單元測試目錄
通常,在項目目錄下建立 tests 文件夾,來存放單元測試文件,假如有一個 Python 文件名是 greetings.py 那單元測試的文件名就是 test_greetings.py,通常大家都用 pytest 來進行單元測試,可以查詢 pytest 文件命名規(guī)范。
3、創(chuàng)建不同的內(nèi)容目錄
這個是靈活的,按個人風(fēng)格來,總體上來說,以英文命名,體現(xiàn)架構(gòu)層次,可以參照 Django 里面的 models,views,utils,app 等。
在一個目錄中放入 __init__.py,表示這個目錄是一個包,是用來導(dǎo)入使用的。
4、設(shè)計文檔字符串及類型提示
文檔字符串及類型提示,都是為了方便他人或自己來閱讀和調(diào)用代碼。



5、使用 Git、GitHub 進行版本管理
如果與其他人一起工作,Git GitHub 對于進行版本管理、代碼審查、避免合并沖突是必不可少的。即使是自己獨立編碼,Git 和 GitHub 也是必備的版本控制工具。
最后
上面一些步驟在 Python 老司機看來比較繁瑣,那么你可以使用 poetry 這個腳手架工具,自動為你創(chuàng)建好目錄結(jié)構(gòu),管理虛擬環(huán)境、依賴、構(gòu)建、運行等快捷服務(wù)。如果覺得有幫助,還請點個在看支持一下,感謝老鐵。
