header python 环境信息_Python开发必备:如何建立一个完美的项目工程环境
在程序开发时候一套好的开发环境和工具栈,可以帮我们极大的提高开发的效率,避免把大量时间浪费在周边琐事上。本文以Python为例,教大家如何快速打造完美的Python项目开发环境:内容涵盖了模块依赖管理、代码风格管理、调试测试管理和Git版本管理,使用git hook做项目规范检查等。
pipx
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
Pipenv会自动为你的项目创建和管理虚拟环境,以pipfile文件方式方式管理项目的依赖包,支持包的安装和卸载。和requirements.txt不同,pipfile是TOML格式,支持开发环境与正式环境,还可以使用Pipfile.lock锁定环境版本。pipxenv的安装可以使用pipx:
pipx install pipenv
有些发行版也是可以直接通过其包管理器安装的:
比如MacOS可以下可以使用:
brew install pipenv
一个pipfile的示例如下:
Pipfile.lock的示例部分如下:
代码风格
代码格式化black
代码格式的统一不光可以给我们一个惬意的代码格式,而且可以避免由于开发人员之间的代码风格差异导致的沟通和协作问题。
Black就是用来格式化Python代码的程序。它可以自动帮我们对代码格式进行调整和统一,提高代码效率和可读性。而且通过Black减小代码风格的差异,可以极大提高团队进行代码审查的效率。
一个Black格式化示例如下:
原始代码:
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:...
格式化后的代码:
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开发中经常需要import第三方的模块,往往这部分代码混乱不堪,使用isort可以则可以美化这部分的代码。 isort可以按字母表顺序对import进行排序,自动分成多个部分。
我们可以使用pipenv安装black 和isort:
pipenv install black isort -dev
isort的效果示例,可以看下面的动图:
Black和isort同时使用时,两者默认配置不兼容,我们需要覆盖isort配置,优先以Black的格式化为准。可以通过setup.cfg文件并添如下配置来完成该任务。
[isort]multi_line_output=3include_trailing_comma=Trueforce_grid_wrap=0use_parentheses=Trueline_length=88
flake8代码风格检测
Flake8可以用来确保代码遵循PEP8中定义的标准Python编程约定,是Python官方辅助代码风格检测工具,lake8检查规则灵活,支持集成额外插件(比如vim、sublime、PyCharm、vsc等都有其相关插件),扩展性强。
其安装也可以使用pipenv:
pipenv install flake8 –dev
flake8的使用示例如下:
flake8 example.py的检查结果:
flake8默认会忽略一些约定(E,F),如果我们检查所有约定:
flake8 --select E,F example.py,结果:
和isort一样,为了配合兼容Black,需要在setup.cfg中额外配置:
[flake8]ignore = E203, E266, E501, W503max-line-length = 88max-complexity = 18select = B,C,E,F,W,T4
mypy静态类型
Mypy是Python的可选静态类型检查器,可以用结合动态(或"鸭子")类型和静态类型优点其他代码的性能。通过Mypy将Python的动态类型便捷性和表现力的优势与静态类型强系统和编译时类型检查相结合,并且生成原生代码,支持通过Python VM运行,可以没有运行时开销的高性能运行。在Python中使用静态类型好处有:
可以使程序更易于理解和维护;
可以帮助编译时调试和发现错误,减少测试和调试。
可以在代码部署到生产环境之前就可以找到难以捕捉的错误。
可以使用pipenv直接安装Mypy:
pipenv install mypy –dev
mypy动态类型和静态类型一个示例如下:
项目配置
默认情况下,Mypy会递归检查所有类型注释的导入,这会导致库不包含这些注释时出错。需要修改mypy配置仅检查当前代码运行,并忽略没有类型注释的import模块。这也可以在setup.cfg中设置:
[mypy]files=项目,testignore_missing_imports=true
代码测试
程序开发中,除了写代码外,另外一个重要的部分是单元测试。Python测试方面我们要介绍的工具有pytest。
可以使用pipenv添加测试工具包及扩展:
pipenv install pytest pytest-cov --dev
Pytest框架可以让编写小测试变得容易,而且支持以扩展的方式提供更加复杂的功能。下面是pytest网站的一个简单示例:
# content of test_sample.pydef inc(x):return x + 1def test_answer():assert inc(3) == 5
通过以下命令测试
pipenv run pytest
结果如下:
pytest-cov是pytest的单元测试行覆盖率的插件。pytets-cov的测试结果示例如下:
pytest还有很多的扩展插件:
pytest-cov: 单元测试覆盖率报告
pytest-django: 对Django框架的单元测框架
pytest-asyncio:对asyncio的支持
pytest-twisted: 对twisted框架的单元测框架
pytest-instafail: 发送错误时报告错误信息
pytest-bdd 测试驱动开发工具
pytest-konira 测试驱动开发工具
pytest-timeout: 支持超时功能
pytest-pep8: 支持PEP8检查
pytest-flakes: 结合pyflakes进行代码检查
更多插件可以查看github pytest-dev组织下的项目。
项目配置
项目中,所有的测试都应该放在test目录中,我需要给setup.cfg添加配置:
[tool:pytest]testpaths=test
单元覆盖率的项目配置需要创建一个新文件.coveragerc返回应用程序代码的覆盖率统计信息,配置示例如下:
[run]source = 项目[report]exclude_lines =pragma: no coverdef __repr__if self.debugraise AssertionErrorraise NotImplementedErrorif 0:if __name__ == .__main__.:
然后再工程中运行一下命令,测试项目的覆盖率
pipenv run pytest --cov --cov-fail-under =100
如果程序代码的测试覆盖率低于100%,就会报错。
Git pre-commit hook规范检查
Git hook可以让我们在提交或推送时执行检查脚本,脚本可以配置对项目镜像测试或者规范性检查。运行脚本。我们可以配置pre-commit hook允许轻松配置这些钩子,下面.pre-commit-config.yaml配置示例可以帮我们自动做代码规范化,包括isort检查、black检查、flake8检查、mypy静态类型检查、pytest测试、pytest-cov测试覆盖率检查:
repos:- repo: localhooks:- id: isortname: isortstages: [commit]language: systementry: pipenv run isorttypes: [python]- id: blackname: blackstages: [commit]language: systementry: pipenv run blacktypes: [python]- id: flake8name: flake8stages: [commit]language: systementry: pipenv run flake8types: [python]exclude: setup.py- id: mypyname: mypystages: [commit]language: systementry: pipenv run mypytypes: [python]pass_filenames: false- id: pytestname: pyteststages: [commit]language: systementry: pipenv run pytesttypes: [python]- id: pytest-covname: pyteststages: [push]language: systementry: pipenv run pytest --cov --cov-fail-under=100types: [python]
如果你需要跳过这些钩子,你可以运行git commit --no-verify或git push --no-verify
cookiecutter自动创建项目
上面我们提到Python项目应该具备的工具集和配置,可以将其作为模版。cookiecutter的模版定义范例如下:
cookiecutter.json{"full_name": "Chongchong
header python 环境信息_Python开发必备:如何建立一个完美的项目工程环境相关推荐
- header python 环境信息_python获取网页header头部信息(python小白学习笔记二)
方法一:代码查看 通过python获取网页的链接url,返回码,以及相关的信息 #对反爬虫网页,可以设置一些headers信息,模拟成浏览器取访问网站 import urllib.request ur ...
- 支持python开发的环境有哪些变化_Python开发实践:打造完美的项目工程环境
在程序开发时候一套好的开发环境和工具栈,可以帮我们极大的提高开发的效率,避免把大量时间浪费在周边琐事上.本文以Python为例,教大家如何快速打造完美的Python项目开发环境:内容涵盖了模块依赖管理 ...
- python困难_Python开发总感觉困难重重,可能是你没用上这些开发工具
Python工具多.功能搞不清.看见就头大?不存在的!千锋广州Python小编都帮你整理好了,快来上这波Python工具功能的车! Tkinter Python默认的图形界面接口.Tkinter是一个 ...
- 可以单独打开anaconda中的python莫?_Python入门必备,大数据,人工智能编程必备软件-Anaconda...
如果说通用的编程神器是微软的VS Code,那么Python编程必备神器是Anaconda 适用人群:Python编程入门新手,大数据分析工作者,人工智能工作者,创投,金融分析师等 适用平台:Wind ...
- python怎样创建项目_如何建立一个完美的 Python 项目
当开始一个新的 Python 项目时,大家很容易一头扎进去就开始编码.其实花一点时间选择优秀的库,将为以后的开发节省大量时间,并带来更快乐的编码体验. 在理想世界中,所有开发人员的关系是相互依赖和关联 ...
- eclipse如何导入一个项目_如何建立一个完美的 Python 项目
当开始一个新的 Python 项目时,大家很容易一头扎进去就开始编码.其实花一点时间选择优秀的库,整合进项目将为以后的开发节省大量时间,并带来更快乐的编码体验. 在理想世界中,所有开发人员的关系是相互 ...
- 教你们如何快速建立一个完美的python项目
当开始一个新的 Python 项目时,大家很容易一头扎进去就开始编码.其实花一点时间选择优秀的库,将为以后的开发节省大量时间,并带来更快乐的编码体验. 在理想世界中,所有开发人员的关系是相互依赖和关联 ...
- JNI开发笔记(四)--实现一个简单的JNI工程并生成so库
实现一个简单的JNI工程并生成so库 引 前言 1. 编写C/h文件并添加到工程 2. 修改CmakeLists.txt文件 3. 编写native-lib.cpp文件 4. 在MainActivit ...
- 简单10步,建立一个完美的商业网站
无论你是正在开始一桩洗车事业,还是运营一部快餐车,又或者是建立了一个新的会计事务所,有一件事永远是正确的:你的事业需要以网络在线方式存在.不仅如此,你的网站还必须足够专业化并展示出正确的形象. 在复杂 ...
最新文章
- Centos7.2搭建Openstack的Swift组件,查看状态:No such file or directory
- 2020-12-1(带你理解32位二进制搜索范围是4GB)
- 面试题18: 删除链表节点:删除链表中重复的节点
- 【最详细】数据结构(C语言版 第2版)第二章课后习题答案 严蔚敏 等 编著
- pytorch FC_regression
- python 报价_python基础教程_查询价格
- 2021年南菁高中高考成绩查询,2021年无锡高考各高中成绩及本科升学率数据排名及分析...
- 拜佛有几点需要注意的事情
- C# 模拟Form提交
- 修改OpenJDK字体渲染,无可见改进
- 高赞 GitHub 项目盘点:给力的 Spring 教程
- BSOD issue - collect complete memory dump
- MATLAB图形绘制--添加图例
- kali 安装volatility_linux网络命令 【Volatility】取证实战
- 服务器2003共享文件夹设置密码,win2003 server r2 设置不需要密码验证的共享文件访问权限(即匿名访问)...
- 【数据通信】具有路由 WSN 模拟器的随机方式移动(Matlab代码实现)
- Xcelsius启动出现Problem Accessing Excel: Exiting问题的解决
- css中的before与after
- 【Java核心】详解Java中断机制
- Python+OpenCV图像处理(一篇全)
热门文章
- scanf 接收 空格 输入_【C/C++】【输入】关于scanf:输入空格,多次使用
- 聊聊ajax,聊聊Ajax()中data()基本知识以及实例分析
- android设计ip输入框,Android下自定义IP控件
- strlen()函数 与 “\0“ 的关系 与 利用;strcmp()
- c 语言26个小写字母,26个字母表大小写
- Python中yield返回生成器的详细方法
- 如何写一个Python万能装饰器,既可以装饰有参数的方法,也可以装饰无参数方法,或者有无返回值都可以装饰
- python中的作用域以及内置函数globals()-全局变量、locals()-局部变量
- python 测试multiprocessing多进程
- tensorflow tf.encode_base64()(将字符串编码为网络安全的base64格式)