Python 歷時(shí)這麼久以來(lái)至今還未有一個(gè)事實(shí)上標(biāo)準(zhǔn)的專案管理及建構(gòu)工具，以至於造成 Python 專案的結(jié)構(gòu)與建構(gòu)方式五花八門(mén)。這或許是體現(xiàn)了 Python 的自由意志。

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

回到 Python，產(chǎn)生過(guò) pip, pipenv, conda 那樣的套件管理工具，但對(duì)專案的目錄佈局沒(méi)有任何約定。

關(guān)於建構(gòu)很多還是延續(xù)了傳統(tǒng)的 Makefile 的方式，再就是加上 setup.py 和 build.py 用程式碼來(lái)進(jìn)行安裝與建置。關(guān)於專案目錄佈局，有做成專案範(fàn)本的，然後做成工具應(yīng)用專案範(fàn)本。

下面大概瀏覽一下四個(gè)工具的使用

1. ?CookieCutter
   
2. ?PyScaffold
   
3. # PyBuilder
   
4. ?Poetry
   

CookieCutter 一個(gè)經(jīng)典的Python 專案目錄結(jié)構(gòu)

##CookieCutter 一個(gè)經(jīng)典的Python 專案目錄結(jié)構(gòu)

$ pip install cookiecutter
$ cookiecutter gh:audreyr/cookiecutter-pypackage
# 以 github 上的 audreyr/cookiecutter-pypackage 為模板，再回答一堆的問(wèn)題生成一個(gè) Python 項(xiàng)目
......
project_name [Python Boilerplate]: sample
......

最後由cookiecutter 產(chǎn)生的專案範(fàn)本是下面的樣子：

$ tree sample
sample
├── AUTHORS.rst
├── CONTRIBUTING.rst
├── HISTORY.rst
├── LICENSE
├── MANIFEST.in
├── Makefile
├── README.rst
├── docs
│ ├── Makefile
│ ├── authors.rst
│ ├── conf.py
│ ├── contributing.rst
│ ├── history.rst
│ ├── index.rst
│ ├── installation.rst
│ ├── make.bat
│ ├── readme.rst
│ └── usage.rst
├── requirements_dev.txt
├── sample
│ ├── __init__.py
│ ├── cli.py
│ └── sample.py
├── setup.cfg
├── setup.py
├── tests
│ ├── __init__.py
│ └── test_sample.py
└── tox.ini
3 directories, 26 files

這大概是當(dāng)前比較流行的目錄結(jié)構(gòu)的主體框架，主要元素是：

$ tree sample
sample
├── Makefile
├── README.rst
├── docs
│ └── index.rst
├── requirements.txt
├── sample
│ ├── __init__.py
│ └── sample.py
├── setup.cfg
├── setup.py
└── tests
 ├── __init__.py
 └── test_sample.py

項(xiàng)目sample 目錄中重複sample 目錄中放置Python 源文件，tests 目錄中是測(cè)試文件，再加一個(gè)docs 目錄放文檔，README.rst, 其他的用於構(gòu)建的setup, setup.cfg 和Makefile 文件。

這其實(shí)是一個(gè)很經(jīng)典的 Python 專案結(jié)構(gòu)，接下來(lái)的建置就用 make 指令了，輸入 make 會(huì)看到定義在 Makefile 檔案中的指令。

$ make
cleanremove all build, test, coverage and Python artifacts
clean-buildremove build artifacts
clean-pycremove Python file artifacts
clean-test remove test and coverage artifacts
lint check style
test run tests quickly with the default Python
test-all run tests on every Python version with tox
coverage check code coverage quickly with the default Python
docs generate Sphinx HTML documentation, including API docs
servedocscompile the docs watching for changes
releasepackage and upload a release
dist builds source and wheel package
installinstall the package to the active Python's site-packages

為使用上面的建置過(guò)程，需要安裝對(duì)應(yīng)的包，如 tox, wheel, coverage, sphinx, flake8, 它們都可以透過(guò) ?pip 來(lái)安裝。之後就可以 make test, make coverage, make docs，make dist 等。其中 make docs 可以產(chǎn)生一個(gè)很漂亮的 Web 文件。

PyScaffold 創(chuàng)建一個(gè)專案

PyScaffold 顧名思義，它是一個(gè)用來(lái)創(chuàng)建Python 專案腳手架的工具，安裝和使用：

$ pip install pyscaffold
$ putup sample

這樣創(chuàng)建了一個(gè)Python 項(xiàng)目，目錄結(jié)構(gòu)與前面?cookiecutter 所選的模板差不多，只不過(guò)它把源文件放在了src 目錄，而非sample 目錄。

$ tree sample
sample
├── AUTHORS.rst
├── CHANGELOG.rst
├── CONTRIBUTING.rst
├── LICENSE.txt
├── README.rst
├── docs
│ ├── Makefile
│ ├── _static
│ ├── authors.rst
│ ├── changelog.rst
│ ├── conf.py
│ ├── contributing.rst
│ ├── index.rst
│ ├── license.rst
│ ├── readme.rst
│ └── requirements.txt
├── pyproject.toml
├── setup.cfg
├── setup.py
├── src
│ └── sample
│ ├── __init__.py
│ └── skeleton.py
├── tests
│ ├── conftest.py
│ └── test_skeleton.py
└── tox.ini

整個(gè)專案的建置就要用 tox 這個(gè)工具了。 tox 是一個(gè)自動(dòng)化測(cè)試和建置工具，它在建置過(guò)程中可建立 Python 虛擬環(huán)境，這讓測(cè)試和建置能有一個(gè)乾淨(jìng)的環(huán)境。

tox -av 能顯示定義在tox.ini 中所有的任務(wù)：

$ tox -av
default environments:
default -> Invoke pytest to run automated tests
additional environments:
build -> Build the package in isolation according to PEP517, see https://github.com/pypa/build
clean -> Remove old distribution files and temporary build artifacts (./build and ./dist)
docs-> Invoke sphinx-build to build the docs
doctests-> Invoke sphinx-build to run doctests
linkcheck -> Check for broken links in the documentation
publish -> Publish the package you have been developing to a package index server. By default, it uses testpypi. If you really want to publish your package to be publicly accessible in PyPI, use the `-- --repository pypi` option.

要執(zhí)行哪個(gè)指令便用tox -e build, tox -e docs 等

在我體驗(yàn)tox 指令過(guò)程中，每一步好像都比較慢，應(yīng)該是建立虛擬機(jī)器要花些時(shí)間。

PyBuilder

最好再看另一個(gè)建置工具PyBuilder， 它所建立的目錄結(jié)構(gòu)很接近Maven, 下面來(lái)瞧瞧

$ pip install pybuilder
$ mkdir sample && cd sample# 項(xiàng)目目錄需手工創(chuàng)建
$ pyb --start-project# 回答一些問(wèn)題后創(chuàng)建所需的目錄和文件

完後看下它的目錄結(jié)構(gòu)：

$ tree sample
.
├── build.py
├── docs
├── pyproject.toml
├── setup.py
└── src
 ├── main
 │ ├── python
 │ └── scripts
 └── unittest
 └── python

構(gòu)建過(guò)程仍然是用pyb 命令，可用pyb -h 查看幫助，pyb -t 列出所有的任務(wù), PyBuilder 的任務(wù)是以插件的方式加入的，插件配置在?build.py 檔案中。

$ pyb -t sample
Tasks found for project "sample":
 analyze -Execute analysis plugins.
 depends on tasks: prepare run_unit_tests
 clean - Cleans the generated output.
 compile_sources - Compiles source files that need compilation.
 depends on tasks: prepare
coverage - <no description available>
 depends on tasks: verify
 install - Installs the published project.
 depends on tasks: package publish(optional)
 package - Packages the application. Package a python application.
 depends on tasks: compile_sources run_unit_tests(optional)
 prepare - Prepares the project for building. Creates target VEnvs
 print_module_path - Print the module path.
print_scripts_path - Print the script path.
 publish - Publishes the project.
 depends on tasks: package verify(optional) coverage(optional)
 run_integration_tests - Runs integration tests on the packaged application.
 depends on tasks: package
run_unit_tests - Runs all unit tests. Runs unit tests based on Python's unittest module
 depends on tasks: compile_sources
upload - Upload a project to PyPi.
verify - Verifies the project and possibly integration tests.
 depends on tasks: run_integration_tests(optional)
$ pyb run_unit_tests sample

PyBuilder 也是在建置或測(cè)試之前建立虛擬環(huán)境, 從 0.12.9 版開(kāi)始可透過(guò)參數(shù) --no-venvs 跳過(guò)建立虛擬環(huán)境這一步驟。使用了 --no-venvs 的話 Python 程式碼將會(huì)在執(zhí)行 ?pyb 的目前 Python 環(huán)境中執(zhí)行，所需的依賴將要手動(dòng)安裝。

專案的依賴也定義在 build.py 檔案中。

@init
def set_properties(project):
 project.depends_on('boto3', '>=1.18.52')
 project.build_depends_on('mock')

隨後在執(zhí)行 pyb 建立虛擬環(huán)境時(shí)就會(huì)安裝上面的依賴，並在其中執(zhí)行測(cè)試與建置。

Poetry

最後一個(gè)Poetry, 感覺(jué)這是一個(gè)更成熟，專案活躍度也更高的Python 構(gòu)建，它有著更強(qiáng)大的信賴管理功能，用poetry add boto3 就能加入依賴，poetry show --tree 顯示出依賴樹(shù)。看如何安裝及建立一個(gè)專案

$ pip install poetry
$ poetry new sample

它所建立的專案比上面都簡(jiǎn)單

$ tree sample
sample
├── README.rst
├── pyproject.toml
├── sample
│ └── __init__.py
└── tests
 ├── __init__.py
 └── test_sample.py

如果給poetry new 帶上--src 參數(shù)，那麼原始檔目錄sample 就會(huì)放在src目錄下，即sample/src/sample.

poetry init 會(huì)在目前目錄中產(chǎn)生pyproject.toml 文件，目錄等的產(chǎn)生需手動(dòng)完成。

它不關(guān)注文件的生成，程式碼規(guī)格的檢查，程式碼覆蓋率都沒(méi)有。它的專案配置更集中，全部在 pyproject.toml 檔案中，toml 是什麼呢？它是一種設(shè)定檔的格式Tom's Obvious, Minimal Language (https://github.com/toml-lang/toml).

###pyproject.toml 有些類似NodeJS 的package.json 文件，例如poetry add, poetry install 指令的行#######

# 往 pyproject.toml 中添加對(duì)boto3 的依賴并安裝(add 還能從本地或 git 來(lái)安裝依賴 ),
poetry add boto3
# 將依照 pyproject.toml 文件中定義安裝相應(yīng)的依賴到當(dāng)前的 Python 虛擬環(huán)境中
# 比如在 <test-venv>/lib/python3.9/site-packages 目錄中，安裝好模塊后也可讓測(cè)試用例使用
poetry install

其他主要的

1.poetry build# 構(gòu)建可安裝的 *.whl 和 tar.gz 文件
2.poetry shell# 會(huì)根據(jù)定義在 pyproject.toml 文件中的依賴創(chuàng)建并使用虛擬環(huán)境
3.poetry run pytest# 運(yùn)行使用 pytest 的測(cè)試用例，如 tests/test_sample.py
4.poetry run python -m unittest tests/sample_tests.py# 運(yùn)行 unittest 測(cè)試用例
5.poetry export --without-hashes --output requirements.txt# 導(dǎo)出 requirements.txt 文件, --dev導(dǎo)出含 dev 的依賴，或者用 poetry export --without-hashes > requirements.txt

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

在 sample 目錄(與 pyproject.toml 文件平級(jí))中創(chuàng)建文件 my_module.py, 內(nèi)容為

def main():
 print('hello poetry')

然后在 pyproject.toml 中寫(xiě)上。

[tool.poetry.scripts]
my-script="sample.my_module:main"

再執(zhí)行

$ poetry run my-script

就會(huì)輸出 "hello poetry"。

通過(guò)對(duì)以上四個(gè)工具的認(rèn)識(shí)，項(xiàng)目結(jié)構(gòu)的復(fù)雜度由 cookiecutter-pyproject -> PyScaffold -> PyBuilder -> Poetry 依次降低，使用的難度大略也是相同的順序

以上是四個(gè)Python專案管理與建構(gòu)工具，建議收藏！的詳細(xì)內(nèi)容。更多資訊請(qǐng)關(guān)注PHP中文網(wǎng)其他相關(guān)文章！