千鋒教育-做有情懷、有良心、有品質的職業教育機構

                    手機站
                    千鋒教育

                    千鋒學習站 | 隨時隨地免費學

                    千鋒教育

                    掃一掃進入千鋒手機站

                    領取全套視頻
                    千鋒教育

                    關注千鋒學習站小程序
                    隨時隨地免費學習課程

                    【熱點話題】 零基礎學IT IT學習教程 IT學習筆記 IT技術干貨 IT培訓機構 IT應聘面試 IT職場就業 Java培訓機構哪些好
                    當前位置:首頁  >  關于學院  >  技術干貨  > 4個Python項目管理與構建工具,建議收藏

                    4個Python項目管理與構建工具,建議收藏

                    來源:千鋒教育
                    發布人:syq
                    時間: 2022-09-16 11:02:38 1663297358

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

                    Python項目管理與構建工具

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

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

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

                      下面大概瀏覽一下四個工具的使用

                      CookieCutter

                      PyScaffold

                      PyBuilder

                      Poetry

                      CookieCutter 一個經典的 Python 項目目錄結構

                    1

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

                    2

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

                    3

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

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

                    4

                      為使用上面的構建過程,需要安裝相應的包,如 tox, wheel, coverage, sphinx, flake8, 它們都可以通過 pip 來安裝。之后就可以 make test, make coverage, make docs,make dist 等。其中 make docs 可以生成一個很漂亮的 Web 文檔。

                      PyScaffold 創建一個項目

                      PyScaffold 顧名思義,它是一個用來創建 Python 項目腳手架的工具,安裝和使用:

                    5

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

                    6

                      整個項目的構建就要用 tox 這個工具了。tox 是一個自動化測試和構建工具,它在構建過程中可創建 Python 虛擬環境,這讓測試和構建能有一個干凈的環境。

                      tox -av 能顯示出定義在 tox.ini 中所有的任務:

                    7

                      要執行哪個命令便用 tox -e build, tox -e docs 等

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

                      PyBuilder

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

                    8

                      完后看下它的目錄結構:

                    9

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

                    10

                      PyBuilder 也是在構建或測試之前創建虛擬環境, 從 0.12.9 版開始可通過參數 --no-venvs 跳過創建虛擬環境這一步。使用了 --no-venvs 的話 Python 代碼將會在運行 pyb 的當前 Python 環境中執行,所需的依賴將要手工安裝。

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

                    11

                      隨后在執行 pyb 創建虛擬環境時就會安裝上面的依賴,并在其中運行測試與構建。

                      Poetry

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

                    12

                      它創建的項目比上面都簡單

                    13

                      如果給 poetry new 帶上 --src 參數,那么源文件目錄 sample 會放在 src 目錄下,即 sample/src/sample.

                      poetry init 會在當前目錄中生成 pyproject.toml 文件,目錄等的生成需手動完成。

                      它不關注文檔的生成,代碼規范的檢查,代碼覆蓋率都沒有。它的項目配置更集中,全部在 pyproject.toml 文件中,toml 是什么呢?它是一種配置文件的格式 Tom's Obvious, Minimal Language

                      pyproject.toml 有些類似 NodeJS 的 package.json 文件,比如 poetry add, poetry install 命令的行

                    14

                      其他主要的

                    15

                      poetry run 能執行任何系統命令,只是它會在它要的虛擬環境中執行。所以可以想見,poetry 的項目要生成文檔或覆蓋率都必須用 poetry run ... 命令來支持 sphinx, coverage 或 flake8。

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

                    16

                      然后在 pyproject.toml 中寫上

                    17

                      再執行

                    18

                      就會輸出 "hello poetry"。 通過對以上四個工具的認識,項目結構的復雜度由 cookiecutter-pyproject -> PyScaffold -> PyBuilder -> Poetry 依次降低,使用的難度大略也是相同的順序。

                    聲明:本站稿件版權均屬千鋒教育所有,未經許可不得擅自轉載。

                    10年以上業內強師集結,手把手帶你蛻變精英

                    請您保持通訊暢通,專屬學習老師24小時內將與您1V1溝通

                    免費領取

                    今日已有369人領取成功

                    劉同學 138****2860 剛剛成功領取
                    王同學 131****2015 剛剛成功領取
                    張同學 133****4652 剛剛成功領取
                    李同學 135****8607 剛剛成功領取
                    楊同學 132****5667 剛剛成功領取
                    岳同學 134****6652 剛剛成功領取
                    梁同學 157****2950 剛剛成功領取
                    劉同學 189****1015 剛剛成功領取
                    張同學 155****4678 剛剛成功領取
                    鄒同學 139****2907 剛剛成功領取
                    董同學 138****2867 剛剛成功領取
                    周同學 136****3602 剛剛成功領取

                    推薦閱讀

                    最新文章

                    開班信息
                    北京校區
                    • 北京校區
                    • 大連校區
                    • 廣州校區
                    • 成都校區
                    • 杭州校區
                    • 長沙校區
                    • 合肥校區
                    • 南京校區
                    • 上海校區
                    • 深圳校區
                    • 武漢校區
                    • 鄭州校區
                    • 西安校區
                    • 青島校區
                    • 重慶校區
                    • 太原校區
                    • 沈陽校區

                    成·人免费午夜在线观看