Python开发必备:如何建立一个完美的项目工程环境

在程序开发时候一套好的开发环境和工具栈 , 可以帮我们极大的提高开发的效率 , 避免把大量时间浪费在周边琐事上 。本文以Python为例 , 教大家如何快速打造完美的Python项目开发环境:内容涵盖了模块依赖管理、代码风格管理、调试测试管理和Git版本管理 , 使用git hook做项目规范检查等 。
pipx

Python开发必备:如何建立一个完美的项目工程环境

文章插图
 
Pipx是一款跨平台的Python环境隔离管理工具 , 可以在支持在 linux、mac OS 和 windows 上运行 。Pipx默认在是个人用户下建立虚拟Python环境 , 并以此建立实现完全隔离的Python运行环境 。安装pipx需要Pthon 3.6及以上版本:
python3 -m pip install --user pipxpython3 -m pipx ensurepath升级Pipx使用:
python3 -m pip install -U pipx包依赖管理pipenv
Python开发必备:如何建立一个完美的项目工程环境

文章插图
 
Pipenv会自动为你的项目创建和管理虚拟环境 , 以pipfile文件方式方式管理项目的依赖包 , 支持包的安装和卸载 。和requirements.txt不同 , pipfile是TOML格式 , 支持开发环境与正式环境 , 还可以使用Pipfile.lock锁定环境版本 。pipxenv的安装可以使用pipx:
【Python开发必备:如何建立一个完美的项目工程环境】pipx install pipenv有些发行版也是可以直接通过其包管理器安装的:
比如MacOS可以下可以使用:
brew install pipenv一个pipfile的示例如下:
Python开发必备:如何建立一个完美的项目工程环境

文章插图
 
Pipfile.lock的示例部分如下:
Python开发必备:如何建立一个完美的项目工程环境

文章插图
 
代码风格代码格式化black
Python开发必备:如何建立一个完美的项目工程环境

文章插图
 
代码格式的统一不光可以给我们一个惬意的代码格式 , 而且可以避免由于开发人员之间的代码风格差异导致的沟通和协作问题 。
Black就是用来格式化Python代码的程序 。它可以自动帮我们对代码格式进行调整和统一 , 提高代码效率和可读性 。而且通过Black减小代码风格的差异 , 可以极大提高团队进行代码审查的效率 。
一个Black格式化示例如下:
原始代码:
Python开发必备:如何建立一个完美的项目工程环境

文章插图
 
def very_important_function(template: str, *variables, file: os.PathLike, engine: str, header: bool = True, debug: bool = False):"""Applies `variables` to the `template` and writes to `file`."""with open(file, 'w') as f:...格式化后的代码:
Python开发必备:如何建立一个完美的项目工程环境

文章插图
 
def very_important_function(template: str,*variables,file: os.PathLike,engine: str,header: bool = True,debug: bool = False,):"""Applies `variables` to the `template` and writes to `file`."""with open(file, "w") as f:...isort美化import部分代码
Python开发必备:如何建立一个完美的项目工程环境

文章插图
 
Python开发中经常需要import第三方的模块 , 往往这部分代码混乱不堪 , 使用isort可以则可以美化这部分的代码 。isort可以按字母表顺序对import进行排序 , 自动分成多个部分 。
我们可以使用pipenv安装black 和isort:
pipenv install black isort -devisort的效果示例 , 可以看下面的动图:
Python开发必备:如何建立一个完美的项目工程环境

文章插图
 
Black和isort同时使用时 , 两者默认配置不兼容 , 我们需要覆盖isort配置 , 优先以Black的格式化为准 。可以通过setup.cfg文件并添如下配置来完成该任务 。
[isort]multi_line_output=3include_trailing_comma=Trueforce_grid_wrap=0use_parentheses=Trueline_length=88flake8代码风格检测Flake8可以用来确保代码遵循PEP8中定义的标准Python编程约定 , 是Python官方辅助代码风格检测工具 , lake8检查规则灵活 , 支持集成额外插件(比如vim、sublime、PyCharm、vsc等都有其相关插件) , 扩展性强 。
其安装也可以使用pipenv:
pipenv install flake8 –dev
flake8的使用示例如下:
Python开发必备:如何建立一个完美的项目工程环境


推荐阅读