code-checker 0.1.0

Run pre-commit code checkers

This app does any number of checks such as unittests or pylint before git commit. If at least one check will not pass, commit is aborted.

To use code-checker in your project execute command setup-githook. This command creates git pre-commit hook (.git/hooks/pre-commit) and precommit_checks.py listed below.

import os
import sys
from codechecker.checker import PylintChecker
from codechecker.checker import ExitCodeChecker
from codechecker import job_processor
from codechecker import helper

ACCEPTED_PYLINT_RATE = 9

# Execute checks only on files added to git staging area
file_list = helper.get_staged_files()

py_files = [f for f in file_list if f.endswith('.py')]
# Exclude test cases
py_files = [f for f in py_files if not os.path.basename(f).startswith('test_')]

# Add checkers
checkers = []
checkers.append(ExitCodeChecker('python3 -m unittest discover .',
                                'python unittest'))
for file_name in py_files:
    checkers.append(PylintChecker(file_name, ACCEPTED_PYLINT_RATE))
    checkers.append(ExitCodeChecker('pep8 {}'.format(file_name),
                                    'PEP8: {}'.format(file_name)))

sys.exit(job_processor.process_jobs(checkers))

Above script executes unit tests for project and pylint along with pep8 for every .py file.

precommit_checks.py are separated from .git/hooks/pre-commit so precommit_checks.py is under git version control.

Checks are treated as jobs divided among couple of workers. Number of workers is equal to number of your cpu logical cores, every worker is executed in separate process.

See Currently supported checkers

Installation

pip install code-checker

Note

Installation of code-checker requires Python 3 and pip

Uninstallation

pip uninstall code-checker

Git hooks setup

1. Change current working directory to git repository cd /path/to/repository

2. Execute setup-githooks. This command creates pre-commit hook which run precommit_checker.py before commit

Note

Make sure that every requirement of checkers (pylint, pep8 etc.) are installed in your system or active virtual environment. You should install them manually.

Customization

To customize pre-commit checking edit precommit_checker.py.

Currently supported checkers

ExitCodeChecker:

Description:

Run system shell command and fail if exit code is non 0

Usage: Create ExitCodeChecker object with arguments:

1. command to execute (string)

2. task name displayed before result in console

# ...
from checker import ExitCodeChecker
# ...
jobs = []
# ...
jobs.append(ExitCodeChecker('python3 -m unittest discover .',
                            'python unittest'))

Example result:

* python unittest: OK

pylint:

Description:

Check passes if pylint code rate for particular file is greather or equal to accepted code rate. Accepted code rate is

Requirements:

pylint

Usage:

# ...
from checker import PylintChecker
# ...
ACCEPTED_PYLINT_RATE = 9
jobs = []
# ...
jobs.append(PylintChecker(file_name, ACCEPTED_PYLINT_RATE))