Friday, 14 August 2009

Pylint Recursively

Not sure why I am blogging this, but I've been having a bit of fun with pylint, which checks python code for "bad smells" (ie. code which doesn't match the PEP standards).
Pylint also finds unused imports, variables etc...

I have written a little script to get only errors and scores out of pylint.
It works recursively looking for *.py scripts within a directory passed to it on the command line, or (if that is missing) within the current working directory.

Posted here in case it is of any use to anyone.

#! /usr/bin/env python
'''
this module runs pylint on all python scripts found in a directory tree
'''

import os
import re
import sys

total = 0.0
count = 0

def check(module):
'''
apply pylint to the file specified if it is a *.py file
'''
global total, count

if module[-3:] == ".py":

print "CHECKING ", module
pout = os.popen('pylint %s'% module, 'r')
for line in pout:
if re.match("E....:.", line):
print line
if "Your code has been rated at" in line:
print line
score = re.findall("\d.\d\d", line)[0]
total += float(score)
count += 1

if __name__ == "__main__":
try:
print sys.argv
BASE_DIRECTORY = sys.argv[1]
except IndexError:
print "no directory specified, defaulting to current working directory"
BASE_DIRECTORY = os.getcwd()

print "looking for *.py scripts in subdirectories of ", BASE_DIRECTORY
for root, dirs, files in os.walk(BASE_DIRECTORY):
for name in files:
filepath = os.path.join(root, name)
check(filepath)

print "==" * 50
print "%d modules found"% count
print "AVERAGE SCORE = %.02f"% (total / count)

1 comment:

Ender said...

Many thanks, your entry is the first one in my Google search and was exactly what I was looking for. :-)