Python 代码的质量控制之 flake8 & Pylint

栏目: Python · 发布时间: 6年前

内容简介:Python 代码的质量控制之 flake8 & Pylint

无需多言,我偏执地认为,所有动态语言写成的项目,都应该使用 XXLint 之类的工具,该暴露的错误能提前就提前。

甚至,所有项目在 commit 之前都需要做两件事情:

  1. lint 检查
  2. UT

动态语言是边解释边执行,缺乏编译期。这是劣势也是优势,这是优势也是劣势。

Python 中,常用的质量控制 工具 就是:pytest(或其他),Pylint,flake8(较强大),本文介绍后两者。

如何使用

如果没有提及这两款工具,那么一个自然的想法是: 给定源码目录 src,工具要能够检查 src 所有符合要求的文件 ,即:

flake8 $OPTIONS $src

事实上,这些工具就是这么工作的。指定文件或目录,然后它帮你检查。

与工作流的整合

命令行的使用尚且简单,不过没有人这么使用(这仍然是重复性劳动),冗长的文档也没几个人喜欢阅读,所以最佳实践才是重点。

我个人的最佳实践是: 与 git pre-commit 结合,如果检查不过,就不让 commit。

思路大概有如下几种:

  1. pre-commit 使用 bash 脚本编写,调用对应命令执行
  2. pre-commit 使用 Python 脚本编写(个人比较偏好这种,主要是对 Shell 实在爱不起来)

如果使用 Python 脚本,我比较喜欢使用 Fabric 来组织我的代码( Fabric 简单小巧,够用)。

比如项目结构一般会这样:

.pylintrc
.flake8
fabfile.py
project/
tests/
docs/

那么 fabfile.py 的内容大致就是

@task
def runpylint():
    local('pylint project/')
    
@task
def runflake8():
    local('flake8 project/')
    
@task
def runpytest():
    pass

@task
def runfabfile():
    execute(runpylint)
    execute(runflake8)
    execute(runpytest)
    
手动执行: 
    fab runfabfile

那么 .git/hooks/pre-commit 的内容就是:

#!/usr/bin/env bash

function _runfab() {
    fab runfabfile
    
    if [[ "$?" == 0 ]]; then
        return 0
    else
        return 1
    fi
}

_runfab

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持 码农网

查看所有标签

猜你喜欢:

本站部分资源来源于网络,本站转载出于传递更多信息之目的,版权归原作者或者来源机构所有,如转载稿涉及版权问题,请联系我们

社群运营五十讲

社群运营五十讲

陈菜根 / 北京时代华文书局 / 2018-4-1 / 49.80

物以类聚,人以群分,社群营销不只是简单的建群、卖东西,而是建立一种自动运转的,去中心化的生态圈,让相同爱好的人产生关系,迸发出裂变的火花,创造更多的营销机会。本书从基本的社群概念入手,讲解了社群的五大要素,社群活动的运作,社群的变现模式以及如何做一个社群师等内容,最后再从如何打造社群IP入手,详细讲解了社群IP的定义、分类及操作过程。一起来看看 《社群运营五十讲》 这本书的介绍吧!

随机密码生成器
随机密码生成器

多种字符组合密码

Base64 编码/解码
Base64 编码/解码

Base64 编码/解码

html转js在线工具
html转js在线工具

html转js在线工具