如何使用 pytest 工具测试自己的代码是否符合 pep8 风格

一、引言

自从学习完《Head First Python 2nd Edition》很久之后,我又拾起了 Python 想要学习一下 Flask。

我记得在《Head First Python 2nd Edition》中,作者提到了一个可以检查自己的 Python 代码是否符合 Pep8 风格的 pytest 工具,而我因为太久没有使用 Python 已经忘却了这个工具的用法。

这里我整理下相关资料,也是方便自己日后查询,也方便各位学 Python 的朋友一起学习。

二、安装 pytest-pep8 工具

我们要使用 pytest 必然要先安装这个工具,这里,我们直接安装 pytest-pep8 工具即可将 pytest 和其对应的 pep8 风格检测所需要的扩展也一并下载下来。

Windows 平台下命令行输入:

py -3 -m pip install pytest-pep8

MacOS 或者 linux 平台下命令行输入:

python -m pip install pytest-pep8

三、配置 py.test.exe 的环境变量

此时,在命令直接输入 py.test 是没有响应的,因为你还没有配置好 py.test 工具的环境变量。

我们在 此电脑 图标右键属性,然后点击 高级系统设置,就可以进入到 环境变量 界面。
1
根据自己的需要,选择配置当前用户的 Path,还是配置所有用户均生效的 Path。这里我选择配置当前用户的 Path,如下图填上 py.test 所在位置即可。
2

ps: 很多人不知道自己下载安装的 py.test 工具的位置在哪里,这个其实很简单,我们打开命令行工具,然后输入即可找到 python 的安装地址:

which python

3
而 py.test 就在同级目录下的 Scripts 目录下。

最后,在命令行工具中输入 py.test 可以正常显示即可证明 py.test 工具配置成功:
4

四、使用 pytest 测试 pep8 风格

测试代码:

# 3 blank lines



def hello(username):
    print('hello ' + username)
hello('wangying')

按照 pep8 风格要求,在函数定义之前,是不能有太多空行(超过 2 行)的,因此正常检测应该是会报错的,让我们来测试下这份代码:

py.test --pep test.py

5

可以看到 py.test 提示我们代码的空行太多,我们删除掉再试试:

# 2 blank lines


def hello(username):
    print('hello ' + username)
hello('wangying')

6

这样就通过 pep8 测试了。

五、总结

追求官方提倡的代码风格,是一个非常好的习惯,我们在写 python 代码的时候,没事用 py.test 来检测下自己的代码是否遵从 pep8 风格,也可以对自己的代码质量有一定改善。

Enjoy It :)

猜你喜欢

转载自blog.csdn.net/u012814856/article/details/81136964