怎么才能写出好看的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标准库或者第三方库~分享使自己进步,互相分享使社会进步。

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

相关文章
|
14天前
|
开发框架 数据建模 中间件
Python中的装饰器:简化代码,增强功能
在Python的世界里,装饰器是那些静悄悄的幕后英雄。它们不张扬,却能默默地为函数或类增添强大的功能。本文将带你了解装饰器的魅力所在,从基础概念到实际应用,我们一步步揭开装饰器的神秘面纱。准备好了吗?让我们开始这段简洁而富有启发性的旅程吧!
25 6
|
27天前
|
存储 缓存 测试技术
Python中的装饰器:功能增强与代码复用的利器
在Python编程中,装饰器是一种强大而灵活的工具,它允许开发者以简洁优雅的方式增强函数或方法的功能。本文将深入探讨装饰器的定义、工作原理、应用场景以及如何自定义装饰器。通过实例演示,我们将展示装饰器如何在不修改原有代码的基础上添加新的行为,从而提高代码的可读性、可维护性和复用性。此外,我们还将讨论装饰器在实际应用中的一些最佳实践和潜在陷阱。
|
27天前
|
人工智能 数据挖掘 Python
Python编程基础:从零开始的代码旅程
【10月更文挑战第41天】在这篇文章中,我们将一起探索Python编程的世界。无论你是编程新手还是希望复习基础知识,本文都将是你的理想之选。我们将从最基础的语法讲起,逐步深入到更复杂的主题。文章将通过实例和练习,让你在实践中学习和理解Python编程。让我们一起开启这段代码之旅吧!
|
7天前
|
数据可视化 Python
以下是一些常用的图表类型及其Python代码示例,使用Matplotlib和Seaborn库。
通过这些思维导图和分析说明表,您可以更直观地理解和选择适合的数据可视化图表类型,帮助更有效地展示和分析数据。
45 8
|
10天前
|
数据可视化 编译器 Python
Manim:数学可视化的强大工具 | python小知识
Manim(Manim Community Edition)是由3Blue1Brown的Grant Sanderson开发的数学动画引擎,专为数学和科学可视化设计。它结合了Python的灵活性与LaTeX的精确性,支持多领域的内容展示,能生成清晰、精确的数学动画,广泛应用于教育视频制作。安装简单,入门容易,适合教育工作者和编程爱好者使用。
65 7
|
14天前
|
API Python
【Azure Developer】分享一段Python代码调用Graph API创建用户的示例
分享一段Python代码调用Graph API创建用户的示例
38 11
|
16天前
|
测试技术 Python
探索Python中的装饰器:简化代码,增强功能
在Python的世界中,装饰器是那些能够为我们的代码增添魔力的小精灵。它们不仅让代码看起来更加优雅,还能在不改变原有函数定义的情况下,增加额外的功能。本文将通过生动的例子和易于理解的语言,带你领略装饰器的奥秘,从基础概念到实际应用,一起开启Python装饰器的奇妙旅程。
31 11
|
11天前
|
Python
探索Python中的装饰器:简化代码,增强功能
在Python的世界里,装饰器就像是给函数穿上了一件神奇的外套,让它们拥有了超能力。本文将通过浅显易懂的语言和生动的比喻,带你了解装饰器的基本概念、使用方法以及它们如何让你的代码变得更加简洁高效。让我们一起揭开装饰器的神秘面纱,看看它是如何在不改变函数核心逻辑的情况下,为函数增添新功能的吧!
|
12天前
|
程序员 测试技术 数据安全/隐私保护
深入理解Python装饰器:提升代码重用与可读性
本文旨在为中高级Python开发者提供一份关于装饰器的深度解析。通过探讨装饰器的基本原理、类型以及在实际项目中的应用案例,帮助读者更好地理解并运用这一强大的语言特性。不同于常规摘要,本文将以一个实际的软件开发场景引入,逐步揭示装饰器如何优化代码结构,提高开发效率和代码质量。
38 6
|
17天前
|
Python
如何提高Python代码的可读性?
如何提高Python代码的可读性?
30 4