vlambda博客
学习文章列表

推荐一整套 Python 开发工具




文 | Brendan Maginnis  译 | EarlGrey 

原文：https://sourcery.ai/blog/python-best-practices/

在开始一个新的Python项目时，很容易不做规划直接进入编码环节。花费少量时间，用最好的工具设置项目，将节省大量时间并带来更快乐的编码体验。

在理想的世界中，所有开发人员使用的依赖库都是相同的，代码将被完美地格式化，禁止常见错误，并且测试将涵盖所有内容。此外，每次提交代码时都会确保符合这些要求。

在本文中，我将介绍如何设置一个这样的理想项目。你可以跟随我的步骤操作，也可以直接开始安装pipx和pipenv，然后生成新项目。

让我们创建一个新的项目目录：

 
   
   
 
    
  
    
    
  
  1. mkdir best_practices
    2. 
  
    
    
  
  2. cd best_practices
    3.

Python命令行工具与pipx

Pipx是一个方便的实用程序，允许快速安装python命令行工具。我们将用它来安装 pipenv 和 cookiecutter 。

 
   
   
 
    
  
    
    
  
  1. python3 -m pip install --user pipx
    2. 
  
    
    
  
  2. python3 -m pipx ensurepath
    3.

使用 pipenv 进行依赖管理

Pipenv自动为您的项目创建和管理virtualenv，以及在安装/卸载软件包时从Pipfile添加/删除软件包。它还生成了非常重要的Pipfile.lock文件，用于生成确定性构建。

知道你和你的同事正在使用相同的库版本，可以极大提升信心。Pipenv 可以实现这个点，因此在过去一年多里得到了大量开发者的青睐

 
   
   
 
    
  
    
    
  
  1. pipx install pipenv
    2.

使用 black 和 isort 进行代码格式化

Black是代码格式化工具：

Black是不妥协的Python代码格式化程序。通过使用它，意味着您同意放弃对手动格式化细节的控制。作为回报，Black 为你提供速度和确定性，并且无需处理 pycodestyle 的繁琐提示。你将有更多的时间，来处理更重要的事情。

无论是什么项目，Black 格式化后的代码看起来都是一样的。习惯之后，你不会再注意到格式的问题，可以专注于内容。

Black产生的代码差异最小，可以加速代码审查。

isort则用来处理 import 的排序：

isort是可以按字母顺序对 import 进行排序，并自动分成多个部分。

让我们使用pipenv安装它们为开发依赖库，这样就不会让部署版本变得更复杂：

 
   
   
 
    
  
    
    
  
  1. pipenv install black isort --dev
    2.

Black 和 isort 的默认选项之间有冲突，因此我们将覆盖 isort 的选项配置，使用 Black 的配置。创建一个 setup.cfg文件并添加此配置：

 
   
   
 
    
  
    
    
  
  1. [isort]
    2. 
  
    
    
  
  2. multi_line_output=3
    3. 
  
    
    
  
  3. include_trailing_comma=True
    4. 
  
    
    
  
  4. force_grid_wrap=0
    5. 
  
    
    
  
  5. use_parentheses=True
    6. 
  
    
    
  
  6. line_length=88
    7.

我们可以这样运行这些工具：

 
   
   
 
    
  
    
    
  
  1. pipenv run black
    2. 
  
    
    
  
  2. pipenv run isort
    3.

用flake8强化风格

Flake8确保我们的代码遵循PEP8的约定。使用pipenv安装：

 
   
   
 
    
  
    
    
  
  1. pipenv install flake8 --dev
    2.

就像isort一样，它需要一些配置才能与 Black 配合使用。将此配置添加到 setup.cfg：

 
   
   
 
    
  
    
    
  
  1. [flake8]
    2. 
  
    
    
  
  2. ignore = E203，E266，E501，W503
    3. 
  
    
    
  
  3. max-line-length = 88
    4. 
  
    
    
  
  4. max-complexity = 18
    5. 
  
    
    
  
  5. select = B，C，E，F，W，T4
    6.

现在我们可以使用 pipenv run flake8运行flake8。

使用 mypy 检查静态类型

Mypy是Python的一个可选静态类型检查器，旨在结合动态（或“鸭子”）类型和静态类型的好处。Mypy将Python的表现力和便利性与强大的类型系统和编译时类型检查相结合。Mypy对标准Python程序进行类型检查，使用 Python VM 运行 mypy 基本没有运行时的开销。

在Python中使用类型需要慢慢习惯，但好处是巨大的。mypy 官网这样写道：

  • 静态类型可以使程序更容易理解和维护

  • 静态类型可以帮助您更早地发现错误，并减少测试和调试

  • 静态类型可以帮助您在代码投入生产之前找到难以发现的错误

 
   
   
 
    
  
    
    
  
  1.  pipenv install mypy --dev
    2.

默认情况下，Mypy将递归检查所有类型注释的导入，这会导致库不包含这些注释时出错。我们需要将mypy配置为仅在我们的代码上运行，并忽略没有类型注释的导入的任何错误。我们假设代码存在于以下配置的 best_practices包中。将如下配置添加到 setup.cfg：

 
   
   
 
    
  
    
    
  
  1. [mypy]
    2. 
  
    
    
  
  2. files=best_practices,test
    3. 
  
    
    
  
  3. ignore_missing_imports=true
    4.

现在我们可以运行mypy：

 
   
   
 
    
  
    
    
  
  1. pipenv run mypy
    2.

mypy 的速查表：https://mypy.readthedocs.io/en/latest/cheatsheetpy3.html

使用pytest和pytest-cov进行测试

使用pytest编写测试非常容易，并且消除编写测试的阻力，意味着我们会编写更多的测试！

 
   
   
 
    
  
    
    
  
  1. pipenv install pytest pytest-cov --dev
    2.

以下是pytest网站的一个简单示例：

 
   
   
 
    
  
    
    
  
  1. # content of test_sample.py
    2. 
  
    
    
  
  2. def inc(x):
    3. 
  
    
    
  
  3.  return x + 1
    4. 
  
    
    
  

    5. 
  
    
    
  

    6. 
  
    
    
  
  6. def test_answer():
    7. 
  
    
    
  
  7.  assert inc(3) == 5
    8.

执行示例：

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

    8. 
  
    
    
  
  8. test_sample.py F [100%]
    9. 
  
    
    
  

    10. 
  
    
    
  
  10. ================================= FAILURES =================================
    11. 
  
    
    
  
  11. _______________________________ test_answer ________________________________
    12. 
  
    
    
  

    13. 
  
    
    
  
  13.  def test_answer():
    14. 
  
    
    
  
  14. > assert inc(3) == 5
    15. 
  
    
    
  
  15. E assert 4 == 5
    16. 
  
    
    
  
  16. E + where 4 = inc(3)
    17. 
  
    
    
  

    18. 
  
    
    
  
  18. test_sample.py:6: AssertionError
    19. 
  
    
    
  
  19. ========================= 1 failed in 0.12 seconds =========================
    20.

所有的测试都应该放在 test目录中，所以将这个配置添加到 setup.cfg：

 
   
   
 
    
  
    
    
  
  1. [tool:pytest]
    2. 
  
    
    
  
  2. testpaths=test
    3.

我们还想检查测试覆盖了多少代码。创建一个新文件 .coveragerc，用来返回应用程序代码的覆盖率统计信息，我们再次假设代码位于 best_practices模块中：

 
   
   
 
    
  
    
    
  
  1. [run]
    2. 
  
    
    
  
  2. source = best_practices
    3. 
  
    
    
  

    4. 
  
    
    
  
  4. [report]
    5. 
  
    
    
  
  5. exclude_lines =
    6. 
  
    
    
  
  6.  # Have to re-enable the standard pragma
    7. 
  
    
    
  
  7.  pragma: no cover
    8. 
  
    
    
  

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

    13. 
  
    
    
  
  13.  # Don't complain if tests don't hit defensive assertion code:
    14. 
  
    
    
  
  14.  raise AssertionError
    15. 
  
    
    
  
  15.  raise NotImplementedError
    16. 
  
    
    
  

    17. 
  
    
    
  
  17.  # Don't complain if non-runnable code isn't run:
    18. 
  
    
    
  
  18.  if 0:
    19. 
  
    
    
  
  19.  if __name__ == .__main__.:
    20.

我们现在可以运行测试并报告覆盖率

 
   
   
 
    
  
    
    
  
  1. pipenv run pytest --cov --cov-fail-under=100
    2.

如果对应用程序代码的测试覆盖率低于100％，则会失败。

pre-commit 的 Git 钩子

Git钩子允许您在任何时候提交或推送时运行脚本。这就可以支持我们在每次提交/推送时，自动运行所有的格式化和测试。pre-commit可以帮助我们轻松配置这些钩子：

在提交代码审查之前，Git钩子脚本可以帮助识别简单问题。每次提交时运行钩子，自动指出代码中的问题，例如缺少分号，尾随空格和调试语句。在代码审查之前指出这些问题，可以让代码审查者专注于代码架构的变化，而不是浪费时间检查格式问题。

在这里，我们配置在提交Python 文件修改时，执行上述所有检查，并且仅在推送时运行pytest覆盖率测试，因为耗时可能较长。创建一个新文件 .pre-commit-config.yaml：

 
   
   
 
    
  
    
    
  
  1. repos:
    2. 
  
    
    
  
  2. - repo: local
    3. 
  
    
    
  
  3.  hooks:
    4. 
  
    
    
  
  4.  - id: isort
    5. 
  
    
    
  
  5.  name: isort
    6. 
  
    
    
  
  6.  stages: [commit]
    7. 
  
    
    
  
  7.  language: system
    8. 
  
    
    
  
  8.  entry: pipenv run isort
    9. 
  
    
    
  
  9.  types: [python]
    10. 
  
    
    
  

    11. 
  
    
    
  
  11.  - id: black
    12. 
  
    
    
  
  12.  name: black
    13. 
  
    
    
  
  13.  stages: [commit]
    14. 
  
    
    
  
  14.  language: system
    15. 
  
    
    
  
  15.  entry: pipenv run black
    16. 
  
    
    
  
  16.  types: [python]
    17. 
  
    
    
  

    18. 
  
    
    
  
  18.  - id: flake8
    19. 
  
    
    
  
  19.  name: flake8
    20. 
  
    
    
  
  20.  stages: [commit]
    21. 
  
    
    
  
  21.  language: system
    22. 
  
    
    
  
  22.  entry: pipenv run flake8
    23. 
  
    
    
  
  23.  types: [python]
    24. 
  
    
    
  
  24.  exclude: setup.py
    25. 
  
    
    
  

    26. 
  
    
    
  
  26.  - id: mypy
    27. 
  
    
    
  
  27.  name: mypy
    28. 
  
    
    
  
  28.  stages: [commit]
    29. 
  
    
    
  
  29.  language: system
    30. 
  
    
    
  
  30.  entry: pipenv run mypy
    31. 
  
    
    
  
  31.  types: [python]
    32. 
  
    
    
  
  32.  pass_filenames: false
    33. 
  
    
    
  

    34. 
  
    
    
  
  34.  - id: pytest
    35. 
  
    
    
  
  35.  name: pytest
    36. 
  
    
    
  
  36.  stages: [commit]
    37. 
  
    
    
  
  37.  language: system
    38. 
  
    
    
  
  38.  entry: pipenv run pytest
    39. 
  
    
    
  
  39.  types: [python]
    40. 
  
    
    
  

    41. 
  
    
    
  
  41.  - id: pytest-cov
    42. 
  
    
    
  
  42.  name: pytest
    43. 
  
    
    
  
  43.  stages: [push]
    44. 
  
    
    
  
  44.  language: system
    45. 
  
    
    
  
  45.  entry: pipenv run pytest --cov --cov-fail-under=100
    46. 
  
    
    
  
  46.  types: [python]
    47. 
  
    
    
  
  47.  pass_filenames: false
    48.

如果你需要跳过这些钩子，你可以运行 git commit--no-verify或 git push--no-verify

使用cookiecutter生成项目

我们已经看到了理想项目都使用了哪些工具，可以将其固化为一个模板，只需要1个命令 即可生成新项目：

 
   
   
 
    
  
    
    
  
  1. pipx run cookiecutter gh:sourceryai/python-best-practices-cookiecutter
    2.

填写项目名称和仓库名称，即可使用模板为你生成项目。

要完成设置，请按照下列步骤操作：

 
   
   
 
    
  
    
    
  
  1. # Enter project directory
    2. 
  
    
    
  
  2. cd <repo_name>
    3. 
  
    
    
  

    4. 
  
    
    
  
  4. # Initialise git repo
    5. 
  
    
    
  
  5. git init
    6. 
  
    
    
  

    7. 
  
    
    
  
  7. # Install dependencies
    8. 
  
    
    
  
  8. pipenv install --dev
    9. 
  
    
    
  

    10. 
  
    
    
  
  10. # Setup pre-commit and pre-push hooks
    11. 
  
    
    
  
  11. pipenv run pre-commit install -t pre-commit
    12. 
  
    
    
  
  12. pipenv run pre-commit install -t pre-push
    13.

模板项目包含一个非常简单的Python文件和测试来试用这些工具。一旦你对代码感到满意，你就可以做第一个 git commit，这时所有的钩子都会运行。



# 文末送书活动 #



活动规则大家请一定要查看，点击这篇推文哦：

这篇推文的福利赠书，改为：《Python 编程快速上手》，送给本篇文章点赞最多、且符合活动要求的精选留言者。

回复下方「关键词」，获取优质资源


回复关键词「 pybook03」，立即获取主页君与小伙伴一起翻译的《Think Python 2e》电子版

回复关键词「书单02」，立即获取主页君整理的 10 本 Python 入门书的电子版

回复关键词「book 数字」，将数字替换成 0 及以上数字，有惊喜好礼哦~


推荐阅读






题图：pexels，CC0 授权。

推荐阅读

[5.05] 暗喻幻想港中35周年限定版1.03+DLC+金手指+王中王存档 [5.05] 暗喻幻想港中35周年限定版1.03+DLC+金手指+王中王存档
Centos7如何编译安装vim8 Centos7如何编译安装vim8

相关文章