怎么才能写出好看的Python代码？这五个工具你得用上-技术圈

昨天花时间选读了朱雷老师新出版的《Python工匠》的第十三章，简单和大家分享下，总结分享分为两篇，本篇主要介绍如何写出好看的代码，给大家分享我从书里学到的五个代码风格优化工具。

图书由图灵教育提供，感谢图灵教育支持。这周四也给大家安排了赠书活动，3.7开奖，送五本《Python工匠》，欢迎大家去参与呀～一定要注意文末参与规则，点击参与赠书活动。

1、简单聊聊

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

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

我想，通过本书学习，应该是可以让你学到很多自己之前不曾注意到的代码编写技巧和方法，更加精进你的代码和代码编写方式的，如：代码格式化技巧。

所以本书比较适合有一定Python基础的同学，用我的话来说就是：你应该至少看过小甲鱼的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规范、代码中函数的圈复杂度。

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

2.2 isort

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

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

@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