Python开发必备:如何建立一个优秀的项目工程环境!

Python是个什么鬼?为什么建筑大牛都在学它?! “曾梦想仗剑走天涯,哪知一入设计不能自拔。” 入行以后,各个都是甲方: 排水、暖通、电气、校对、总工、甲方、老板、施工、审图办......都是主子。 日复一日,升职加薪没熬来,但是颈椎病、腰间盘突出 、黑眼圈 ......一应俱全。 苦则苦矣,既然大环境改变不了,不如改变一下自己。 用更合理的方式做设计,最起码能保命????。 今天我想和大家分享一下自己的经历,告诉大家怎么用更轻松有效的方式做设计。 上周六晚上九点,叮的一声,我收到一条来自甲方爸爸的消息: “效果图的功能布置要改!” 刺激! 我一下 阅读详情

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

Python资源共享群:626017123

 

 

 

pipx

 

Pipx是一款跨平台的Python环境隔离管理工具,可以在支持在 Linux、Mac OS 和 Windows 上运行。Pipx默认在是个人用户下建立虚拟Python环境,并以此建立实现完全隔离的Python运行环境。安装pipx需要Pthon 3.6及以上版本:


 

 

python3 -m pip install --user pipx python3 -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=3 include_trailing_comma=True force_grid_wrap=0 use_parentheses=True line_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, W503 max-line-length = 88 max-complexity = 18 select = 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=项目,test ignore_missing_imports=true

 

代码测试

程序开发中,除了写代码外,另外一个重要的部分是单元测试。Python测试方面我们要介绍的工具有pytest。

 

 

 

可以使用pipenv添加测试工具包及扩展:


 

 

pipenv install pytest pytest-cov --dev

Pytest框架可以让编写小测试变得容易,而且支持以扩展的方式提供更加复杂的功能。下面是pytest网站的一个简单示例:


 

 

# content of test_sample.py def inc(x): return x + 1 def 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 cover def __repr__ if self\.debug raise AssertionError raise NotImplementedError if 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: 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]

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

 

cookiecutter自动创建项目

 

 

图片上传失败

​重试

 

上面我们提到Python项目应该具备的工具集和配置,可以将其作为模版。cookiecutter的模版定义范例如下:


 

 

cookiecutter.json { "full_name": "Chongchong", "email": "chongchong@ijz.me", "project_name": "Python-Practice", "repo_name": ""Python-Practice ", "project_short_description": "The Simple Python Development Practice Example.", "release_date": "2019-09-02", "year": "2019", "version": "0.0.1" }

然后使用cookiecutter自动生成整改工程:


 

 

pipx run cookiecutter Python-Practice cd Python-Practice git init

安装依赖项


 

 

pipenv install --dev

运行 pre-commit和pre-push hook:


 

 

pipenv run pre-commit install -t pre-commit pipenv run pre-commit install -t pre-push

 

总结

本文我们介绍了在Python项目开发时候必须要具备的一些开发测试检查工具。通过这些可以自动生成Python项目,代码风格检查、代码测试等操作,可以帮助我们打造一个高效完美的Python开发环境。

Python开发者必备宝典!颠覆你的开发模式,效率暴增1000% GitHub项目"awesome-python-cn"是一个专为中文Python开发者打造的高质量资源聚合清单。该项目由伯乐在线维护,获得23k+星标,内容涵盖Web开发、数据科学、爬虫、GUI开发等数十个分类,精选Django、Flask、Pandas、PyTorch等主流工具的中文资源。项目持续更新,提供系统性学习路径,帮助开发者快速找到经过社区验证的优质工具和教程,解决信息过载、资源筛选困难等痛点,是提升Python开发效率的"一站式"导航利器。 阅读详情

相关推荐

优秀Python编程环境有什么要求?

编程语言在进行编程时,都需要借助一定的集成开发环境和代码编辑器,Python编程亦如此,以下是在Python初学者在选择Python编辑器时,可以从以下几个方面着手:1. 保存和重载代码文件如果一款集成开发环境或者编辑器不允许你保存现有工作,并在之后重新打开时不能保持你离开时的相同状态,那么它就不是什么集成开发环境。2. 在环境内运行代码类似的是,如果你必须退出编辑器来运行Python代码,那么它...

lmseo5hy的博客 890

Python运行环境搭建方法

在某个空文件夹下,新建python文件,可以通过以下的方式新建环境或者选用已经存在的环境,该环境保存在。在Anaconda Powershell Prompt终端中通过。命令创建新的环境,并配置python版本号。:通过PyCharm新建环境。:通过Conda新建环境。

m0_66238629的博客 914

基于单片机负载控制的无人机电气设备监测系统设计

为深入分析无人机电气设备的电子负载性能,实现对传输电子量的合理性监管与控制,设计基于单片机负载控制的无人机电气设备监测系统;利用电气信号发生电路,构建负载网络控制器与以太网模块运行所需的电气设备负载环境,借助PCB监控板建立PLC扩展负载模块与核心监控主机之间的物理连接关系,实现无人机电气设备监测系统的硬件执行环境搭建;在此基础上,通过STM32型单片机移植协议,确定无人机电气设备通信主机的现有组态形式,联合已设定的监控任务有线级条件,实现监测系统的软件执行环境搭建,完成基于单片机负载控制的无人机电气设备监

weixin_45905610的博客 1300

Python———运行环境搭建

Python环境配置运行环境搭建

qq_63976098的博客 1024

从按下开机键到进入系统:深入主板“后台”,揭秘Super I/O芯片的上电时序与BIOS交互

本文深入探讨了Super I/O芯片(SIO)在电脑启动过程中的关键作用,详细解析了其架构设计、上电时序与BIOS交互机制。通过分析SIO的多功能集成控制器特性,包括低速I/O管理、硬件监控和电源管理,揭示了从按下电源按钮到系统初始化的精密硬件协作过程。文章还提供了常见问题的调试方法,为硬件工程师和嵌入式开发者提供了实用参考。

weixin_27014595的博客 134

Obsidian免费同步全攻略:手把手教你用OneDrive+Remotely Save插件跨设备同步笔记

本文提供了一份详细的Obsidian免费同步方案指南,核心是利用OneDrive云存储与Remotely Save插件实现跨设备笔记同步。文章手把手教学,涵盖插件安装、OneDrive授权配置、桌面端与移动端的同步设置,并解答了常见问题,帮助用户在不依赖官方付费服务的情况下,构建稳定、自主的免费同步工作流。

bash7scripter的博客 852

python建筑案例_有哪些关于 Python 在建筑中的应用和教程?

看到楼上好多回答 ,说明大家都挺感兴趣。 python在编程语言中算比较年轻的, 但是由于跨平台能力非常强。 寄生于各个宿主里面。 以前一般用javascript(rhino)t的地方或者MEL(maya里面用的)或者VB (catia里面)等等 都开始注入了python,更别提计算机领域里面各种其他的应用甚至互联网开发也都用起了python。因此学习与掌握python对编程是非常有帮助的,而且确...

weixin_39595487的博客 919

3、流程引擎下载安装与部署

camunda有多种使用方式,此处先使用独立平台的方式部署引擎,这种用法适合分布式,微服务化,多语言异构系统的使用方式。

leyoliu的博客 5524

python与建筑_有哪些关于 Python 在建筑中的应用和教程?

当绝大部分建筑师都认为Python的应用仅仅是在参数化设计的时候,将Python和数据挖掘技术应用在建筑的其他方面就显得更加有意义。用Python做数据分析,首先要有数据库首先看一下相关的数据集,根据“building facade dataset”的关键词搜索,可以找到名为“CMP Facade Database”的建筑立面数据集。去年的这个时候我还花了大概有2个月的时间来学OpenCV和深度学...

weixin_39664585的博客 948

支付宝h5参数如何实现跳转?(包含相关Demo代码)

🏆本文收录于专栏,主要记录项目实战过程中所遇到的Bug或因后果及提供真实有效的解决方案,希望能够助你一臂之力,帮你早日登顶实现财富自由🚀;同时,欢迎大家!持续更新中,up!up!up!!

**My Coding Family** 3262

基于唤醒音频的目标说话人语音识别系统设计报告

摘要 本报告设计了一套基于唤醒音频的目标说话人语音识别系统,通过五级流水线架构(唤醒检测→声纹注册→语音分离→目标ASR→拒识决策)解决复杂声学场景下的目标说话人识别问题。系统整合ECAPA-TDNN声纹模型、Conv-TasNet语音分离网络和Whisper ASR引擎,在L20 GPU上实现高效端到端推理,支持-5dB~5dB SNR范围和0~100%重叠率的双人语音场景处理。系统在目标说话人CER、拒识率和推理效率等关键指标上均达到设计目标,为智能语音交互提供了有效的身份感知解决方案。

huanghm88的专栏 76

python 开发流程_Python开发必备:如何建立一个优秀的项目工程环境!

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

weixin_42564147的博客 280

ESP8266-Arduino编程实例-TEA5767收音机模块驱动

TEA5767HN 是一款用于低压应用的单芯片电子调谐 FM 立体声收音机,具有完全集成的中频 (IF) 选择性和解调功能,频率范围从76—108MHZ自动数字调谐。 该收音机完全无需调整,高灵敏度,高稳定性,低噪音,收音模块。只需要最少的小型低成本外部组件。 收音机可以调到欧洲、美国和日本的 FM 波段。...

视觉与物联智能 1981

header python 环境信息_Python开发必备:如何建立一个优秀的项目工程环境!

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

weixin_39626180的博客 100

9篇1章1节:中国居民健康与营养调查(CHNS)数据库的官网解析和数据下载(2026年版)

在探讨中国社会经济转型与人口健康变迁的学术领域中,中国健康与营养调查(CHNS) 是一个无法绕过的权威数据库。本文将带你深入了解CHNS的项目背景、庞大的数据体系,以及如何通过这两个核心网站获取关键的家庭、个人及社区层面的研究数据。

MD Code 1707

迈瑞BS系列全自动生化分析仪LIS协议接口手册(内含HL7和ASTM)

迈瑞BS系列全自动生化分析仪LIS协议接口手册,内含HL7和ASTM)

python小程序代码_Python开发必备:如何建立一个优秀的项目工程环境!

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

weixin_39646725的博客 87

jre9下载 jdk9

(Java SE Runtime Environment 9.0) 9.0u175 官方最新版 【x86|x64】

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

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

FHGFHFYUUGY的博客 1189

老版QQ原生表情gif动态

这是老版的QQ表情,不过全是动态的的,Windows照片查看器是不会动的,可以右击用浏览器打开查看,再说一遍是老版的,只是分享给宁愿用老版也要动态的人。

TMS_WebGMaps_1.9.8.0_Full_Source

TMS_WebGMaps_1.9.8.0_Full_Source 全源码 delphi cbuilder

python的开发环境包括_Python开发必备:如何建立一个优秀的项目工程环境

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

weixin_39737240的博客 156

如何成为一个优秀的Python工程师?

众所周知,Python因其优雅而简洁的语言优势而备受程序员的青睐和追捧。随着人工智能、大数据技术的落地,Python工程师也成为了目前薪资待遇高,发展前景好的热门岗位。虽然,Python入门简单,对初学者友好,但是成为一个优秀的Python工程师并非易事,下面我们来谈谈如何成为Python工程师。

Python栈 375

如何快速成为一名优秀的python工程师?

随着人工智能的发展与应用,Python编程语言受到世界各界人士的关注,Python工程师也成为一个热门职业,就业薪资高,发展前景广阔。 Python是一门简单的编程语言,学习相对更加轻松容易,初学者很容易入门,但想要学好,成为一名优秀的Python工程师就不是那么容易的事情了,需要受到很多因素的影响,以下是成为一名优秀的Python工程师需要满足的条件: 一、坚持和自信 做任何一件事,贵在坚持,要坚信自己能够学好,是Python学习过程比不可少的心态,当遇到学习上的难点时,才能更有耐心的解决与积累,完整的进

xuezhangmen的博客 335

推荐一个程序员必备网站之一:Dev Hints ,非常实用!

今天,笔者给大家分享一个能提升开发效率的网站:Dev Hints。做为一个技术人员,要记很多东西,但是又不是全部都记得住。特别是有些知识很久不用了,就忘记的差不多了,只有经常用到的才会记...

全栈修炼 3万+

大数据开发工程师必备技能有哪些?

大数据开发工程师必备技能有哪些?随着全行业数字化转型和新基建时代的到来,对技术人才提出了更高的要求。不管是面试还是实际工作过程中,数据工程师要时时刻刻面对这些层出不穷的技术演进。随着数据的爆发式增长以及指标维度多元化,T+1 的数据报表早已无法满足需求。在保证高时效性的同时,让数据发挥更大的价值是筛选“王牌”大数据开发工程师的重要门槛。现在对大数据开发工程师的能力要求越来越高:1、OLAP型大数据开发能力对数字化转型的公司来说,公司的业务可以分为两类:一类是OLTP型的业务,一类是OLAP型的业务。

weixin_51689029的博客 3112

Python的10大集成开发环境和代码编辑器(指南)_python开发环境软件

Sublime Text是一款非常流行的代码编辑器,其开发者是一名谷歌的工程师,其梦想是使之成为更好的文本编辑器。为了充分利用Sublime Text设置,你可以阅读我们的Python+Sublime Text设置指南,或者观看我们更深层次的视频教学,这会帮助你在Sublime Text 3中建立一个高效的Python开发环境。安装额外的Python扩展可能会比较棘手,Sublime Text中所有的包都是用Python写成的,并且安装社区扩展往往需要直接在Sublime Text中执行Python脚本。

2401_89285717的博客 1297

优秀软件开发大佬的技能树!

开发人员是软件项目的核心力量,他们负责将设计转化为可运行的代码,实现业务逻辑,确保系统的稳定、高效运行。

日拱一卒,玉汝于成 2249

Python的虚拟开发环境

为什么要创建虚拟环境,明明我已经有一个Python的配置了直接使用不好吗?”这句话在我首次接触时候闪现出来的。是啊!明明存在在了还要,当然是它的功能优秀值得尝试。这是最致命的问题。是一个旧网站,依赖Flask 1.0。是一个新应用,需要用最新的Flask 3.0。如果都在全局环境里,你的 Flask。当你为了项目B升级到 Flask 3.0 时,项目A 可能会因为代码不兼容而直接崩溃报错。反之亦然。虚拟环境能让你为项目A和B分别创建环境,各自安装所需的版本,互不干扰,完美解决了“版本地狱”的问题。

sun_he_he的博客 173

在vscode中配置python环境!(附安装包)

VSCode是一个优秀的编辑工具,适合代码阅读,代码编辑,甚至配置好之后,可以编译与调试代码。为了方便编辑,运行python程序,本文就聊聊如何将VSCode搭建为一个python的IDE吧,具备运行与调试python程序的能力。

m0_75067629的博客 3691
上一篇: 一文搞懂各大APP!网站python网络爬虫!
下一篇: 五种Pandas循环方法效率对比!
普通网友
博客等级 码龄7年 438粉丝 263原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值