怎么才能写出好看的Python代码?这五个工具你得用上

简介: 怎么才能写出好看的Python代码?这五个工具你得用上

简说Python,号主老表,Python终身学习者,数据分析爱好者,从18年开始分享Python知识,原创文章227篇,写过Python、SQL、Excel入门文章,也写过Web开发、数据分析文章,老表还总结整理了一份2022Python学习资料和电子书资源,关注后私信回复:2022 即可领取。

1、简单聊聊

首先得给大家说说我为什么直接从第十三章开始读,简单说就是我对这一章更感兴趣,当然本书其他章节也是非常优秀的,后面我也会抽时间阅读学习。

另外需要和大家说的是,如本书作者在前言中说的,这并不是一本Python入门学习的书,虽然本书中目录涉及到了Python基础知识的方方面面,如:变量与注释、数值与字符串、列表字典集合等,书中主要给大家介绍了这些知识点的一些应用,大多是作者自己十余年开发经验的总结。

2、代码风格相关工具

这里的工具并非什么软件,而是基于Python的标准库/第三方库。

代码风格相关的,作者一共分享了5个库,flake8、isort、black、pre-commit和mypy,都可以直接通过pip install的方式进行安装,如果你想一次安装所有,只需像下面这样即可。

pip install flake8、isort、black、pre-commit mypy

2.1 flake8

flake8 集合了PyFlakes、pycodestyle、McCabe,它们的功能依次是检测代码语法错误和变量名未定义或者使用等、代码格式是否符合PEP8规范、代码中函数的圈复杂度。

image.png

McCabe检测的圈复杂度你可能不知道表示什么,简单说就是代码难不难理解(它是根据函数的控制流程图来计算的,具体介绍大家感兴趣可以浏览器查查)。

2.2 isort

isort 用于按字母顺序对代码中的import进行排序,并自动按导入包的类型进行分隔,一般包类型分为:

  • 标准库包(python自带的)
  • 第三方包(需要pip install安装的)
  • 本地包(自己本地写的)

image.png

@https://github.com/PyCQA/isort

这个我觉得挺有用的,特别是一些代码量较多的项目里,通常会有很多导入,甚至会有重复导入,通过isort我们可以很清楚的看到导入了哪些包和它们之间的关系。

2.3 black

"Black is the uncompromising Python code formatter. " @github.com/psf/black

如官方介绍,black是一个不妥协的Python代码格式化工具,它有自己的格式化风格(当然都是满足PEP8规范的),几乎没有可以自定义的配置,这样的好处是你不用过分的去纠结用什么编码风格(很多时候同样的代码 满足PEP8规范的写法也有很多种方式)。

2.4 pre-commit

这几个包里,我最喜欢的是pre-commit,通过在github仓库项目根目录设置个配置文件.pre-commit-config.yaml就能自动在提交代码(git commit)前先自动执行配置文件中配置的脚本,比如前面说的代码格式规范,如果发现问题就会终止提交,并输出问题。

.pre-commit-config.yaml一般结构:

repos:
-   repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v2.3.0
    hooks:
    -   id: check-yaml
    -   id: end-of-file-fixer
    -   id: trailing-whitespace
-   repo: https://github.com/psf/black
    rev: 21.12b0
    hooks:
    -   id: black

image.png

更多配置介绍可以查看@pre-commit.com/#pre-commit-configyaml---hooks

2.5 mypy

mypy是一个静态类型检查工具,会根据代码中的类型注解对代码进行类型检查并查找常见错误。也是一个非常实用的包。

其实我自己平时写Python代码是很少写类型注解的,不过作者说的“虽然相比于传统Python代码,编写类型注解的代码总是更麻烦一些,需要进行额外的工作,但和类型注解所带来的诸多好处相比是完全值得的”,这个我是非常认同的。

而且类型注解,对于大型项目来说更是重要,完善的类型注解可以让伙伴更好地阅读理解代码,也更方便代码的重构或者修改。

3、单元测试相关

上面的代码风格相关工具部分,不管什么领域、应用场景下,基本都有用,接下来分享的单元测试,可能就更偏向于开发、测试相关领域了,我们下回分享。

这里也欢迎大家留言分享下自己平时用的比较多的Python标准库或者第三方库~分享使自己进步,互相分享使社会进步。

那么下期见,我是爱猫爱技术,更爱思思的老表⁽⁽ଘ( ˙꒳˙ )ଓ⁾⁾

相关文章
|
3月前
|
存储 算法 调度
【复现】【遗传算法】考虑储能和可再生能源消纳责任制的售电公司购售电策略(Python代码实现)
【复现】【遗传算法】考虑储能和可再生能源消纳责任制的售电公司购售电策略(Python代码实现)
188 26
|
3月前
|
测试技术 开发者 Python
Python单元测试入门:3个核心断言方法,帮你快速定位代码bug
本文介绍Python单元测试基础,详解`unittest`框架中的三大核心断言方法:`assertEqual`验证值相等,`assertTrue`和`assertFalse`判断条件真假。通过实例演示其用法,帮助开发者自动化检测代码逻辑,提升测试效率与可靠性。
334 1
|
3月前
|
机器学习/深度学习 算法 调度
基于多动作深度强化学习的柔性车间调度研究(Python代码实现)
基于多动作深度强化学习的柔性车间调度研究(Python代码实现)
179 1
|
2月前
|
测试技术 Python
Python装饰器:为你的代码施展“魔法”
Python装饰器:为你的代码施展“魔法”
240 100
|
2月前
|
开发者 Python
Python列表推导式:一行代码的艺术与力量
Python列表推导式:一行代码的艺术与力量
389 95
|
3月前
|
Python
Python的简洁之道:5个让代码更优雅的技巧
Python的简洁之道:5个让代码更优雅的技巧
241 104
|
3月前
|
开发者 Python
Python神技:用列表推导式让你的代码更优雅
Python神技:用列表推导式让你的代码更优雅
437 99
|
2月前
|
缓存 Python
Python装饰器:为你的代码施展“魔法
Python装饰器:为你的代码施展“魔法
153 88
|
3月前
|
IDE 开发工具 开发者
Python类型注解:提升代码可读性与健壮性
Python类型注解:提升代码可读性与健壮性
270 102
|
2月前
|
监控 机器人 编译器
如何将python代码打包成exe文件---PyInstaller打包之神
PyInstaller可将Python程序打包为独立可执行文件,无需用户安装Python环境。它自动分析代码依赖,整合解释器、库及资源,支持一键生成exe,方便分发。使用pip安装后,通过简单命令即可完成打包,适合各类项目部署。

推荐镜像

更多