当前位置：首页 > 编程日记 > 正文

如何写出符合Python审美的代码风格？

编程日记 2025-01-17 07:10:00

640?wx_fmt=jpeg

作者 | Rocky0429

来源 | Python空间

本文为 AI科技大本营投稿文章（欢迎给我们投稿，投稿请联系微信1092722531）

写在之前

每个人都有自己的代码风格，随着写的行数增加，自己对于代码的审美也会变的不一样，这就像是一个逐渐蜕变的过程，每过一段时间回头再去看看自己之前写的代码就会生出一种「这么丑的玩意儿竟然是我写的」这种感慨。

之前不论是写 C 或者是 C++ 的时候，对于代码风格的好坏观感完全是凭着自己的主观意识，也没有什么官方标准说这样那样就是好看的。等学了 Python 以后，神奇的发现 Python 官方竟然给出了一种编码规范 PEP 8，当然这个只是个标准而已，并没有强制要求大家都要去遵守，但又好像大多数人都使用了 PEP 8 编码风格，使它已经成为了事实上的代码风格标准。

PEP 8 编码规范

Python 代码从第一眼看上去，给人的感觉就是简洁优美，可读性强，也就是我们日常所说的「高颜值」。一方面是因为 Python 自身的优秀设计，比如统一的锁进，没有多余的符号从而让代码变的更加简洁；另一方面就是因为它有着一套较为统一的编码风格，当然它本身只是编码风格方面的建议而不是强制，相应的在编写 Python 代码的编辑器自动提供 PFP 8 检查，当你编写的代码违反了 PEP 8 规范的时候，会给出警告信息和修正的建议。与此同时，还有专门的检查工具对 Python 的代码风格进行检查。

由上，还是建议在编写 Python 代码的时候都遵循 PEP 8 编码规范，毕竟你以后不可能是只一个人写代码，未来不论是在公司或者某些开源项目中，作为其中的一份子，肯定还是要在风格上向大众看齐的。

PEP 8 编码规范详细的给出了 Python 编码的指导，包括什么对齐啦，包的导入顺序啦，空格和注释啦还有命名习惯等方方面面，并且还有详细的事例。

下面我以「包」的导入为例，看一下 PEP 8 给出的具体编程指导。在 Python 中， import 应该一次只导入一个模块，不同的模块应该独立一行：

import pandas
import numpy

反面例子：

import pandas,numpy

如果想要从一个模块里面导入多个，也可以像下面这样：

from subprocess import Popen, PIPE

import 语句应该处于源码文件的顶部，位于模块注释和文档字符串之后，全局变量和常量之前。在导入不同的库的时候，应该按照以下的顺序分组，各个分组之间以空行分隔：

导入标准库模块
导入相关第三方库模块
导入当前应用程序/库模块

具体事例如下所示：

import os
import time

import psutil

from test import u_test,my_test

Python 中还支持相对导入和绝对导入，在这里还是强推绝对导入。因为绝对导入的可读性更好一些，也不容易出错，即使出错了也会给出更加详细的错误信息。具体如下所示：

from sub_package import tools
from sub_package.tools import msg

当然除了上述以外还有更多对于包的规范的描述，PEP 8 的编码风格指导比较长，并且写的非常详细，所以我就不在这一一介绍了，详细的可以参考 Python 官网上的资料。

pycodestyle 检查代码规范

我在上面说过 PEP 8 只是官方给出的 Python 编码规范，并没有强制要求大家都遵守，但是又由于大家都在用，所以它也就变成了事实上的 Python 代码风格标准，既然都是标准了，那么就应该有工具来检查这个标准，这样可以帮助 Python 小白规范自己的代码，也可以帮助大家在开源或者工作中形成统一的代码风格。

为了达成上述的目的，官方提供了同名的命令行工具来检查 Python 代码是否违反了 PEP 8 规范，并且对违反规范的地方给出了相应的提示信息。

pip install pep8

规范的名字是 PEP 8 ，这个检查代码风格的命令行工具叫 pep8，这个很容易引起大家的困惑，因此 Python 之父建议将 pep8 重新命名为 pycodestyle，下面我们来看一下 pycodestyle 的用法。

首先通过 pip 安装一下：

pip install pycodestyle

对一个或者多个文件运行 pycodestyle，打印检查报告：

640?

通过 --show-source 显示不符合规范的源码，以便程序员进行修改，具体如下所示：

640?

autopep8 格式化代码

autopep8 能够将 Python 代码自动格式化为 PEP 8 风格，它使用 pycodestyle 工具来决定代码中的哪部分需要被格式化，这能够修复大部分 pycodestyle 工具中报告的排版问题。autopep8 本身也是一个用 Python 写的工具，所以我们还是可以用 pip 直接安装：

pip install autopep8

它的使用方式也很简单，具体如下所示：

autopep8 --in-place test_search.py

上述代码如果不带 --in-place 的话，会将 autopep8 格式化以后的代码直接输出到控制台。我们可以用这种方式检查 autopep8 的修改，使用 --in-place 则会直接将结果保存到源文件中。在这我继续用上面的例子中用到的 py 文件，具体如下所示：

640?

上面的例子中，autopep8 顺利的修复了所有的问题，但是如果你这个时候查看源文件的话，你会发现源文件的内容还是和原来一样，并没有被修改。这个时候我们就要用到 --in-place，加上这个选项将不会有任何输出， autopep8 会直接修改源文件。

autopep8 --in-place test_search.py

（*本文为转载文章，如需转载请联系邮箱 zhuanzai@geekpark.net）

◆

如何写出符合Python审美的代码风格？

相关文章：

程序员都该懂点 HTTP

谁的青春不迷茫，其实我们都一样

关于Iframe在IE6下不显示的bug

腾讯优图吴永坚：迈向深度学习，我们面临模型训练与推荐的双重考验

JS子窗口调用父窗口中的函数

父亲节遇上端午节，你难道不回家吗？

蜘蛛爬虫网络高像素图片抓取工具[搜索引擎]

技术流 | 手把手教你用Python设计一个命令行界面

送给那些还在迷茫的人

cisco路由器与QOS技术

shell介绍，命令历史，命令补全和别名，通配符，输入输出重定向

2018年Python开源项目Top100！只在这里！

亲君圆梦，创业一起来

半途而废的香山之旅

POwershell 更改文件权限

“清华帮”AI造富

什么时候是创业最佳时机？7个最佳的励志创业时机GET了吗

连接ORACLE实例

用Inno Setup来解决.NetFramework安装问题

我想，有间花房

JS重写提示框(confirm)

实现通用人工智能还要多久？Hinton与AlphaGo之父这样回答

SQL Server 2008备份大全实战(七)

一个中心、三大原则，阿里这样做智能对话开发平台

大学生目前普遍存在的问题，看你中招了没？

javascript用感

Vulkan Tutorial 12 Fixed functions

年后跳槽BAT必看：10种数据结构、算法和编程课助你面试通关

戚薇在冰箱放香水，是贫穷限制了想象力!

使用apache的activemq集合JMS处理异步消息