Python 歷時這么久以來至今還未有一個事實上標準的項目管理及構建工具，以至于造成 Python 項目的結構與構建方式五花八門。這或許是體現(xiàn)了 Python 的自由意志。

不像 Java 在經(jīng)歷了最初的手工構建，到半自動化的 Ant, 再到 Maven 基本就是事實上的標準了。其間 Maven 還接受了其他的 Gradle(Android 項目主推), SBT(主要是 Scala 項目), Ant+Ivy, Buildr 等的挑戰(zhàn)，但都很難撼動 Maven 的江湖地位，而且其他的差不多遵循了 Maven 的目錄布局

回到 Python，產生過 pip, pipenv, conda 那樣的包管理工具，但對項目的目錄布局沒有任何約定

關于構建很多還是延續(xù)了傳統(tǒng)的 Makefile 的方式，再就是加上 setup.py 和 build.py 用程序代碼來進行安裝與構建。關于項目目錄布局，有做成項目模板的，然后做成工具來應用項目模板

下面大概瀏覽一下四個工具的使用
CookieCutter
PyScaffold
PyBuilder
Poetry

CookieCutter?一個經(jīng)典的 Python 項目目錄結構

最后由 cookiecutter 生成的項目模板是下面的樣子：

這大概是當前比較流行的目錄結構的主體框架，主要元素是：

項目 sample 目錄中重復 sample 目錄中放置 Python 源文件， 目錄中是測試文件，再加一個 目錄放文檔，README.rst, 其他的用于構建的 setup, setup.cfg 和 Makefile 文件。

這其實是一個很經(jīng)典的 Python 項目結構，接下來的構建就用 命令了，輸入 會看到定義在 Makefile 文件中的指令

為使用上面的構建過程，需要安裝相應的包，如 , , , , , 它們都可以通過 來安裝。之后就可以 , , ， 等。其中 可以生成一個很漂亮的 Web 文檔。

PyScaffold?創(chuàng)建一個項目

PyScaffold 顧名思義，它是一個用來創(chuàng)建 Python 項目腳手架的工具，安裝和使用：

這樣創(chuàng)建了一個 Python 項目，目錄結構與前面 cookiecutter 所選的模板差不多，只不過它把源文件放在了 目錄，而非 目錄。

整個項目的構建就要用 這個工具了。 是一個自動化測試和構建工具，它在構建過程中可創(chuàng)建 Python 虛擬環(huán)境，這讓測試和構建能有一個干凈的環(huán)境。

能顯示出定義在 中所有的任務：

要執(zhí)行哪個命令便用 , 等

在我體驗 tox 命令過程中，每一步好像都比較慢，應該是創(chuàng)建虛擬機要花些時間。

PyBuilder

最好再看另一個構建工具 PyBuilder， 它所創(chuàng)建出的目錄結構很接近于 Maven, 下面來瞧瞧

完后看下它的目錄結構：

構建過程仍然是用 命令，可用 查看幫助， 列出所有的任務, PyBuilder 的任務是以插件的方式加入的，插件配置在 文件中。

PyBuilder 也是在構建或測試之前創(chuàng)建虛擬環(huán)境, 從 0.12.9 版開始可通過參數(shù) 跳過創(chuàng)建虛擬環(huán)境這一步。使用了 的話 Python 代碼將會在運行 的當前 Python 環(huán)境中執(zhí)行，所需的依賴將要手工安裝。

項目的依賴也要定義在 文件中

隨后在執(zhí)行 創(chuàng)建虛擬環(huán)境時就會安裝上面的依賴，并在其中運行測試與構建。

Poetry

最后一個 Poetry, 感覺這是一個更為成熟，項目活躍度也更高的 Python 構建，它有著更強大的信賴管理功能，用 就能添加依賴， 顯示出依賴樹?？聪氯绾伟惭b及創(chuàng)建一個項目

它創(chuàng)建的項目比上面都簡單

如果給 帶上 參數(shù)，那么源文件目錄 會放在 目錄下，即 .

會在當前目錄中生成 文件，目錄等的生成需手動完成。

它不關注文檔的生成，代碼規(guī)范的檢查，代碼覆蓋率都沒有。它的項目配置更集中，全部在 文件中， 是什么呢？它是一種配置文件的格式 Tom's Obvious, Minimal Language (https://github.com/toml-lang/toml).

有些類似 NodeJS 的 文件，比如 poetry add, poetry install 命令的行

其他主要的

能執(zhí)行任何系統(tǒng)命令，只是它會在它要的虛擬環(huán)境中執(zhí)行。所以可以想見， 的項目要生成文檔或覆蓋率都必須用 命令來支持 , 或 。

在 sample 目錄(與 pyproject.toml 文件平級)中創(chuàng)建文件 , 內容為

然后在 中寫上

再執(zhí)行

就會輸出 "hello poetry"。

如此通過對以上四個工具的認識，項目結構的復雜度由 cookiecutter-pyproject -> PyScaffold -> PyBuilder -> Poetry 依次降低，使用的難度大略也是相同的順序！

以上就是本次分享的全部內容，想學習更多Python技巧，歡迎持續(xù)關注六星源課堂！