pre-commit.py

#!/usr/bin/env python

import os
import re
import subprocess
import sys

modified = re.compile('^\s*(?:M|A)(\s+)(?P<name>.*)')

CHECKS = [
    {
        'output': 'Checking for pdbs...',
        'command': 'grep -n "import pdb" %s',
        'ignore_files': ['.*pre-commit'],
        'print_filename': True,
    },
    {
        'output': 'Checking for ipdbs...',
        'command': 'grep -n "import ipdb" %s',
        'ignore_files': ['.*pre-commit'],
        'print_filename': True,
    },
    {
        'output': 'Checking for print statements...',
        'command': 'grep -n print %s',
        'match_files': ['.*\.py$'],
        'ignore_files': ['.*migrations.*', '.*management/commands.*', '.*manage.py', '.*/scripts/.*'],
        'print_filename': True,
    },
    {
        'output': 'Checking for console.log()...',
        'command': 'grep -n console.log %s',
        'match_files': ['.*yipit/.*\.js$'],
        'print_filename': True,
    },
]


def matches_file(file_name, match_files):
    return any(re.compile(match_file).match(file_name) for match_file in match_files)


def check_files(files, check, repo_root):
    result = 0
    print check['output']
    for file_name in files:
        if 'match_files' not in check or matches_file(file_name, check['match_files']):
            if 'ignore_files' not in check or not matches_file(file_name, check['ignore_files']):
                process = subprocess.Popen(check['command'] % (repo_root + '/' + file_name), stdout=subprocess.PIPE,
                                           stderr=subprocess.PIPE, shell=True)
                out, err = process.communicate()
                if out or err:
                    if check['print_filename']:
                        prefix = '\t%s:' % file_name
                    else:
                        prefix = '\t'
                    output_lines = ['%s%s' % (prefix, line) for line in out.splitlines()]
                    print '\n'.join(output_lines)
                    if err:
                        print err
                    result = 1
    return result


def main(all_files, virtual_env=None):
    p = subprocess.Popen(['git', 'rev-parse', '--show-toplevel'], stdout=subprocess.PIPE)
    out, _ = p.communicate()
    repo_root = out.splitlines()[0]

    files = []
    if all_files:
        for root, dirs, file_names in os.walk('.'):
            for file_name in file_names:
                files.append(os.path.join(root, file_name))
    else:
        p = subprocess.Popen(['git', 'status', '--porcelain'], stdout=subprocess.PIPE)
        out, err = p.communicate()
        for line in out.splitlines():
            match = modified.match(line)
            if match:
                files.append(match.group('name'))

    result = 0

    if 'VIRTUAL_ENV' in os.environ or virtual_env:
        p = subprocess.Popen(['find', repo_root, '-name', 'manage.py'], stdout=subprocess.PIPE)
        out, _ = p.communicate()
        manage = out.splitlines()[0]
        print 'Running Django Code Validator...'
        if 'VIRTUAL_ENV' in os.environ:
            # virtual env already activated run django check
            command = '$VIRTUAL_ENV/bin/python %s check' % manage
        else:
            command = '. %s/bin/activate && $VIRTUAL_ENV/bin/python %s check' % (virtual_env, manage)
        return_code = subprocess.call(command, shell=True)

        result = return_code or result

    if result:
        sys.exit(result)

    for check in CHECKS:
        result = check_files(files, check, repo_root) or result

    sys.exit(result)


if __name__ == '__main__':
    g_all_files = False
    g_virtual_env = None
    if len(sys.argv) > 1:
        if sys.argv[1] == '--all-files':
            g_all_files = True
            if len(sys.argv) > 2:
                g_virtual_env = sys.argv[2]
        else:
            g_virtual_env = sys.argv[1]

    main(g_all_files, g_virtual_env)

How to install this script:

1. cd ~/bin
2. wget https://gist.githubusercontent.com/ceasaro/3f73faa15e89a374558a/raw/95d91dd7600413f0eedf453b29936ea7d0b9234d/pre-commit.py
3. chmod -x pre-commit.py
4. activate you're virtual env workon [YOUR_DJANGO_VIRTUALENV]
5. printf '#!/bin/sh \n~/bin/python-pre-commit.py [YOUR_DJANGO_VIRTUALENV]' > .git/hook/pre-commit