在開始一個新的Python項目時，很容易不做規劃直接進入編碼環節。花費少量時間，用最好的工具設置項目，將節省大量時間並帶來更快樂的編碼體驗。
在理想的世界中，所有開發人員使用的依賴庫都是相同的，代碼將被完美地格式化，禁止常見錯誤，並且測試將涵蓋所有內容。此外，每次提交代碼時都會確保符合這些要求。
這是小編準備的python基礎學習資料,關注，轉發，私信小編“01”即可免費領取！
在本文中，我將介紹如何設置一個這樣的理想項目。你可以跟隨我的步驟操作，也可以直接開始安裝pipx和pipenv，然後生成新項目。
讓我們創建一個新的項目目錄：
Python命令行工具與pipx
Pipx是一個方便的實用程序，允許快速安裝python命令行工具。我們將用它來安裝 pipenv 和 cookiecutter 。
使用 pipenv 進行依賴管理
Pipenv自動為您的項目創建和管理virtualenv，以及在安裝/卸載軟件包時從Pipfile添加/刪除軟件包。它還生成了非常重要的Pipfile.lock文件，用於生成確定性構建。
知道你和你的同事正在使用相同的庫版本，可以極大提升信心。Pipenv 可以實現這個點，因此在過去一年多里得到了大量開發者的青睞
使用 black 和 isort 進行代碼格式化
Black是代碼格式化工具：
Black是不妥協的Python代碼格式化程序。通過使用它，意味著您同意放棄對手動格式化細節的控制。作為回報，Black 為你提供速度和確定性，並且無需處理 pycodestyle 的繁瑣提示。你將有更多的時間，來處理更重要的事情。
無論是什麼項目，Black 格式化後的代碼看起來都是一樣的。習慣之後，你不會再注意到格式的問題，可以專注於內容。
Black產生的代碼差異最小，可以加速代碼審查。
isort則用來處理 import 的排序：
isort是可以按字母順序對 import 進行排序，並自動分成多個部分。
讓我們使用pipenv安裝它們為開發依賴庫，這樣就不會讓部署版本變得更復雜：
Black 和 isort 的默認選項之間有衝突，因此我們將覆蓋 isort 的選項配置，使用 Black 的配置。創建一個 setup.cfg 文件並添加此配置：
我們可以這樣運行這些工具：
用flake8強化風格
Flake8確保我們的代碼遵循PEP8的約定。使用pipenv安裝：
就像isort一樣，它需要一些配置才能與 Black 配合使用。將此配置添加到 setup.cfg ：
現在我們可以使用 pipenv run flake8 運行flake8。
使用 mypy 檢查靜態類型
Mypy是Python的一個可選靜態類型檢查器，旨在結合動態（或“鴨子”）類型和靜態類型的好處。Mypy將Python的表現力和便利性與強大的類型系統和編譯時類型檢查相結合。Mypy對標準Python程序進行類型檢查，使用 Python VM 運行 mypy 基本沒有運行時的開銷。
在Python中使用類型需要慢慢習慣，但好處是巨大的。mypy 官網這樣寫道：
- 靜態類型可以使程序更容易理解和維護
- 靜態類型可以幫助您更早地發現錯誤，並減少測試和調試
- 靜態類型可以幫助您在代碼投入生產之前找到難以發現的錯誤
默認情況下，Mypy將遞歸檢查所有類型註釋的導入，這會導致庫不包含這些註釋時出錯。我們需要將mypy配置為僅在我們的代碼上運行，並忽略沒有類型註釋的導入的任何錯誤。我們假設代碼存在於以下配置的 best_practices 包中。將如下配置添加到 setup.cfg ：
現在我們可以運行mypy：
mypy 的速查表：https://mypy.readthedocs.io/en/latest/cheatsheetpy3.html
使用pytest和pytest-cov進行測試
使用pytest編寫測試非常容易，並且消除編寫測試的阻力，意味著我們會編寫更多的測試！
以下是pytest網站的一個簡單示例：
執行示例：
所有的測試都應該放在 test 目錄中，所以將這個配置添加到 setup.cfg ：
我們還想檢查測試覆蓋了多少代碼。創建一個新文件 .coveragerc ，用來返回應用程序代碼的覆蓋率統計信息，我們再次假設代碼位於 best_practices 模塊中：
我們現在可以運行測試並報告覆蓋率
如果對應用程序代碼的測試覆蓋率低於100％，則會失敗。
pre-commit 的 Git 鉤子
Git鉤子允許您在任何時候提交或推送時運行腳本。這就可以支持我們在每次提交/推送時，自動運行所有的格式化和測試。pre-commit可以幫助我們輕鬆配置這些鉤子：
在提交代碼審查之前，Git鉤子腳本可以幫助識別簡單問題。每次提交時運行鉤子，自動指出代碼中的問題，例如缺少分號，尾隨空格和調試語句。在代碼審查之前指出這些問題，可以讓代碼審查者專注於代碼架構的變化，而不是浪費時間檢查格式問題。
在這裡，我們配置在提交Python 文件修改時，執行上述所有檢查，並且僅在推送時運行pytest覆蓋率測試，因為耗時可能較長。創建一個新文件 .pre-commit-config.yaml ：
如果你需要跳過這些鉤子，你可以運行 git commit--no-verify 或 git push--no-verify
使用cookiecutter生成項目
我們已經看到了理想項目都使用了哪些工具，可以將其固化為一個模板，只需要1個命令 即可生成新項目：
填寫項目名稱和倉庫名稱，即可使用模板為你生成項目。
要完成設置，請按照下列步驟操作：
模板項目包含一個非常簡單的Python文件和測試來試用這些工具。一旦你對代碼感到滿意，你就可以做第一個 git commit ，這時所有的鉤子都會運行。
閱讀更多 程序員編程分享 的文章
