小編給大家分享一下建立Python項(xiàng)目的方法，希望大家閱讀完這篇文章后大所收獲，下面讓我們一起去探討吧！

我們一直強(qiáng)調(diào)網(wǎng)站設(shè)計(jì)制作、成都網(wǎng)站建設(shè)對于企業(yè)的重要性,如果您也覺得重要,那么就需要我們慎重對待,選擇一個(gè)安全靠譜的網(wǎng)站建設(shè)公司,企業(yè)網(wǎng)站我們建議是要么不做，要么就做好,讓網(wǎng)站能真正成為企業(yè)發(fā)展過程中的有力推手。專業(yè)網(wǎng)絡(luò)公司不一定是大公司,創(chuàng)新互聯(lián)建站作為專業(yè)的網(wǎng)絡(luò)公司選擇我們就是放心。

                                                           python視頻教程欄目為大家介紹如何建立一個(gè)完美的Python項(xiàng)目。

當(dāng)開始一個(gè)新的 Python 項(xiàng)目時(shí)，大家很容易一頭扎進(jìn)去就開始編碼。其實(shí)花一點(diǎn)時(shí)間選擇優(yōu)秀的庫，將為以后的開發(fā)節(jié)省大量時(shí)間，并帶來更快樂的編碼體驗(yàn)。

在理想世界中，所有開發(fā)人員的關(guān)系是相互依賴和關(guān)聯(lián)的（協(xié)作開發(fā)），代碼要有完美的格式、沒有低級(jí)的錯(cuò)誤、并且測試覆蓋了所有代碼。另外，所有這些將在每次提交時(shí)都可以得到保證。（代碼風(fēng)格統(tǒng)一、類型檢測、測試覆蓋率高、自動(dòng)檢測）

在本文中，我將介紹如何建立一個(gè)可以做到這些點(diǎn)的項(xiàng)目。您可以按照步驟操作，也可以直接跳到 使用 cookiecutter 生成項(xiàng)目部分（老手）。 首先，讓我們創(chuàng)建一個(gè)新的項(xiàng)目目錄：

mkdir best_practices
cd best_practices復(fù)制代碼

pipx 安裝 Python 三方庫的命令行工具

Pipx 是一個(gè)可用于快速安裝 Python 三方庫的命令行工具。我們將使用它來安裝 pipenv 和 cookiecutter。通過下面的命令安裝 pipx：

python3 -m pip install --user pipx
python3 -m pipx ensurepath復(fù)制代碼

使用 pipenv 進(jìn)行依賴管理

Pipenv 為您的項(xiàng)目自動(dòng)創(chuàng)建和管理 virtualenv（虛擬環(huán)境），并在安裝/卸載軟件包時(shí)從 Pipfile 添加/刪除軟件包。它還會(huì)生成非常重要的 Pipfile.lock 用于保證依賴的可靠性。

當(dāng)你知道，你和你的隊(duì)友正在使用相同的庫版本時(shí)，這將會(huì)極大地提高編程的信心和樂趣。Pipenv 很好地解決了使用相同的庫，版本不同的這一問題，Pipenv 在過去的一段時(shí)間里獲得了廣泛的關(guān)注和認(rèn)可，你可以放心使用。安裝命令如下：

pipx install pipenv復(fù)制代碼

使用 black 和 isort 進(jìn)行代碼格式化

black 可以格式化我們的代碼：

Black 是毫不妥協(xié)的 Python 代碼格式化庫。通過使用它，你將放棄手動(dòng)調(diào)整代碼格式的細(xì)節(jié)。作為回報(bào)，Black 可以帶來速度、確定性和避免調(diào)整 Python 代碼風(fēng)格的煩惱，從而有更多的精力和時(shí)間放在更重要的事情上。

無論你正在閱讀什么樣的項(xiàng)目，用 black 格式化過的代碼看起來都差不多。一段時(shí)間后格式不再是問題，這樣你就可以更專注于內(nèi)容。

black 通過減少代碼的差異性，使代碼檢查更快。

而 isort 是對我們的 imports 部分進(jìn)行排序：

isort 為您導(dǎo)入的 Python 包部分（imports）進(jìn)行排序，因此你不必再對 imports 進(jìn)行手動(dòng)排序。它可以按字母順序?qū)?dǎo)入進(jìn)行排序，并自動(dòng)將其拆分成多個(gè)部分。

使用 pipenv 安裝它，以便它們不會(huì)使部署混亂（可以指定只在開發(fā)環(huán)境安裝）：

pipenv install black isort --dev復(fù)制代碼

Black 和 isort 并不兼容的默認(rèn)選項(xiàng)，因此我們將讓 isort 遵循 black 的原則。創(chuàng)建一個(gè) setup.cfg 文件并添加以下配置：

[isort]
multi_line_output=3
include_trailing_comma=True
force_grid_wrap=0
use_parentheses=True
line_length=88復(fù)制代碼

我們可以使用以下命令運(yùn)行這些工具：

pipenv run black
pipenv run isort復(fù)制代碼

使用 flake8 保證代碼風(fēng)格

Flake8 確保代碼遵循 PEP8 中定義的標(biāo)準(zhǔn) Python 代碼規(guī)范。使用 pipenv 安裝：

pipenv install flake8 --dev復(fù)制代碼

就像 isort 一樣，它需要一些配置才能很好地與 black 配合使用。將這些配置添加到 setup.cfg ：

[flake8]
ignore = E203, E266, E501, W503
max-line-length = 88
max-complexity = 18
select = B,C,E,F,W,T4復(fù)制代碼

現(xiàn)在我們可以運(yùn)行 flake8 了，命令：pipenv run flake8 。

使用 mypy 進(jìn)行靜態(tài)類型檢查

Mypy 是 Python 的非強(qiáng)制的靜態(tài)類型檢查器，旨在結(jié)合動(dòng)態(tài)（或 “鴨子”）類型和靜態(tài)類型的優(yōu)點(diǎn)。Mypy 將 Python 的表達(dá)能力和便利性與功能強(qiáng)大的類型系統(tǒng)的編譯時(shí)類型檢查結(jié)合在一起，使用任何 Python VM 運(yùn)行它們，基本上沒有運(yùn)行時(shí)開銷。

在 Python 中使用類型需要一點(diǎn)時(shí)間來適應(yīng)，但是好處卻是巨大的。如下：

• 靜態(tài)類型可以使程序更易于理解和維護(hù)
• 靜態(tài)類型可以幫助您更早地發(fā)現(xiàn)錯(cuò)誤，并減少測試和調(diào)試的時(shí)間
• 靜態(tài)類型可以幫助您在代碼投入生產(chǎn)之前發(fā)現(xiàn)難以發(fā)現(xiàn)的錯(cuò)誤

pipenv install mypy --dev復(fù)制代碼

默認(rèn)情況下，Mypy 將遞歸檢查所有導(dǎo)入包的類型注釋，當(dāng)庫不包含這些注釋時(shí)，就會(huì)報(bào)錯(cuò)。我們需要將 mypy 配置為僅在我們的代碼上運(yùn)行，并忽略沒有類型注釋的導(dǎo)入錯(cuò)誤。我們假設(shè)我們的代碼位于以下配置的 best_practices 包中。將此添加到 setup.cfg ：

[mypy]files=best_practices,testignore_missing_imports=true復(fù)制代碼

現(xiàn)在我們可以運(yùn)行 mypy 了：

pipenv run mypy復(fù)制代碼

這是一個(gè)有用的 備忘單 。

用 pytest 和 pytest-cov 進(jìn)行測試

使用 pytest 編寫測試非常容易，消除編寫測試的阻力意味著可以快速的編寫更多的測試！

pipenv install pytest pytest-cov --dev復(fù)制代碼

這是 pytest 網(wǎng)站上的一個(gè)簡單示例：

# content of test_sample.pydef inc(x):
    return x + 1def test_answer():
    assert inc(3) == 5復(fù)制代碼

要執(zhí)行它：

$ pipenv run pytest=========================== test session starts ============================
platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
cachedir: $PYTHON_PREFIX/.pytest_cache
rootdir: $REGENDOC_TMPDIR
collected 1 item

test_sample.py F                                                     [100%]

================================= FAILURES =================================
_______________________________ test_answer ________________________________

    def test_answer():>       assert inc(3) == 5E       assert 4 == 5
E        +  where 4 = inc(3)

test_sample.py:6: AssertionError
========================= 1 failed in 0.12 seconds =========================復(fù)制代碼

我們所有的測試代碼都放在 test 目錄中，因此請將此目錄添加到 setup.cfg ：

[tool:pytest]
testpaths=test復(fù)制代碼

如果還想查看測試覆蓋率。創(chuàng)建一個(gè)新文件 .coveragerc，指定只返回我們的項(xiàng)目代碼的覆蓋率統(tǒng)計(jì)信息。比如示例的 best_practices 項(xiàng)目，設(shè)置如下：

[run]
source = best_practices

[report]
exclude_lines =
    # Have to re-enable the standard pragma
    pragma: no cover

    # Don't complain about missing debug-only code:
    def __repr__
    if self\.debug

    # Don't complain if tests don't hit defensive assertion code:
    raise AssertionError
    raise NotImplementedError

    # Don't complain if non-runnable code isn't run:
    if 0:
    if __name__ == .__main__.:復(fù)制代碼

現(xiàn)在，我們就可以運(yùn)行測試并查看覆蓋率了。

pipenv run pytest --cov --cov-fail-under=100復(fù)制代碼

--cov-fail-under=100 是設(shè)定項(xiàng)目的測試覆蓋率如果小于 100％ 那將認(rèn)定為失敗。

pre-commit 的 Git hooks

Git hooks 可讓您在想要提交或推送時(shí)隨時(shí)運(yùn)行腳本。這使我們能夠在每次提交/推送時(shí)，自動(dòng)運(yùn)行所有檢測和測試。pre-commit 可輕松配置這些 hooks。

Git hook 腳本對于在提交代碼審查之前，識(shí)別簡單問題很有用。我們在每次提交時(shí)都將運(yùn)行 hooks，以自動(dòng)指出代碼中的問題，例如缺少分號(hào)、尾隨空白和調(diào)試語句。通過在 code review 之前指出這些問題，代碼審查者可以專注于變更的代碼內(nèi)容，而不會(huì)浪費(fèi)時(shí)間處理這些瑣碎的樣式問題。

在這里，我們將上述所有工具配置為在提交 Python 代碼改動(dòng)時(shí)執(zhí)行（git commit），然后僅在推送時(shí)運(yùn)行 pytest coverage（因?yàn)闇y試要在最后一步）。創(chuàng)建一個(gè)新文件 .pre-commit-config.yaml，配置如下：

repos:  - repo: local    hooks:      - id: isort        name: isort        stages: [commit]        language: system        entry: pipenv run isort        types: [python]      - id: black        name: black        stages: [commit]        language: system        entry: pipenv run black        types: [python]      - id: flake8        name: flake8        stages: [commit]        language: system        entry: pipenv run flake8        types: [python]        exclude: setup.py      - id: mypy        name: mypy        stages: [commit]        language: system        entry: pipenv run mypy        types: [python]        pass_filenames: false      - id: pytest        name: pytest        stages: [commit]        language: system        entry: pipenv run pytest        types: [python]      - id: pytest-cov        name: pytest        stages: [push]        language: system        entry: pipenv run pytest --cov --cov-fail-under=100        types: [python]        pass_filenames: false復(fù)制代碼

如果需要跳過這些 hooks，可以運(yùn)行 git commit --no-verify 或 git push --no-verify

使用 cookiecutter 生成項(xiàng)目

現(xiàn)在，我們已經(jīng)知道了理想項(xiàng)目中包含了什么，我們可以將其轉(zhuǎn)換為 模板 從而可以使用單個(gè)命令生成一個(gè)包含這些庫和配置的新項(xiàng)目：

pipx run cookiecutter gh:sourcery-ai/python-best-practices-cookiecutter復(fù)制代碼

填寫項(xiàng)目名稱和倉庫名稱，將為您生成新的項(xiàng)目。

要完成設(shè)置，請執(zhí)行下列步驟：

# Enter project directorycd <repo_name># Initialise git repogit init# Install dependenciespipenv install --dev# Setup pre-commit and pre-push hookspipenv run pre-commit install -t pre-commit
pipenv run pre-commit install -t pre-push復(fù)制代碼

模板項(xiàng)目包含一個(gè)非常簡單的 Python 文件和測試，可以試用上面這些工具。在編寫完代碼覺得沒問題后，就可以執(zhí)行第一次 git commit，所有的 hooks 都將運(yùn)行。

集成到編輯器

雖然在提交時(shí)知道項(xiàng)目的代碼始終保持最高水準(zhǔn)是件令人興奮的事情。但如果在代碼已全部修改完成之后（提交時(shí)），再發(fā)現(xiàn)有問題還是會(huì)讓人很不爽。所以，實(shí)時(shí)暴露出問題要好得多。

在保存文件時(shí)，花一些時(shí)間確保代碼編輯器運(yùn)行這些命令。有及時(shí)的反饋，這意味著你可以在代碼還有印象的時(shí)候能迅速解決引入的任何小問題。

我個(gè)人使用一些出色的 Vim 插件來完成此任務(wù)：

• ale 實(shí)時(shí)運(yùn)行 flake8 并在保存文件時(shí)運(yùn)行 black、isort 和 mypy
• 與 projectionist 集成的 vim-test 在文件保存上運(yùn)行 pytest

歡迎熱愛技術(shù)和開源的小伙伴加入 HG 推出的譯文亦舞系列的翻譯中來，可以留言告訴我們。

看完了這篇文章，相信你對建立Python項(xiàng)目的方法有了一定的了解，想了解更多相關(guān)知識(shí)，歡迎關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道，感謝各位的閱讀！

文章標(biāo)題：建立Python項(xiàng)目的方法
文章來源：http://aaarwkj.com/article0/pjdhio.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián)，為您提供網(wǎng)站內(nèi)鏈、外貿(mào)建站、Google、全網(wǎng)營銷推廣、網(wǎng)站設(shè)計(jì)、網(wǎng)站營銷

廣告

聲明：本網(wǎng)站發(fā)布的內(nèi)容（圖片、視頻和文字）以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主，如果涉及侵權(quán)請盡快告知，我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場，如需處理請聯(lián)系客服。電話：028-86922220；郵箱：631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載，或轉(zhuǎn)載時(shí)需注明來源： 創(chuàng)新互聯(lián)