codewatch 1.0.0

Monitor and manage deeply customizable metrics about your python code using ASTs

This project is currently deprecated and may be archived. If you're looking for something similar, you could try bellybutton or writing a custom checker in pylint instead.

Overview

Monitor and manage deeply customizable metrics about your python code using ASTs.

Codewatch lets you write simple python code to track statistics about the state of your codebase and write lint-like assertions on those statistics. Use this to incrementally improve and evolve the quality of your code base, increase the visibility of problematic code, to encourage use of new patterns while discouraging old ones, to enforce coding style guides, or to prevent certain kinds of regression errors.

What codewatch does:

1. Traverses your project directory
2. Parses your code into AST nodes and calls your visitor functions
3. Your visitor functions run and populate a stats dictionary
4. After all visitor functions are called, your assertion functions are called
5. Your assertion functions can assert on data in the stats dictionary, save metrics to a dashboard, or anything you can think of

Installation

Python: 2.7, 3.6, 3.7

Execute the following in your terminal:

pip install codewatch

Usage

codewatch codewatch_config_module

codewatch_config_module is a module that should contain your visitors, assertions and filters (if required)

Visitors

You should use the @visit decorator. The passed in node is an astroid node which follows a similar API to ast.Node

from codewatch import visit


def _count_import(stats):
    stats.increment('total_imports_num')

@visit('import')
def count_import(node, stats, _rel_file_path):
    _count_import(stats)

@visit('importFrom')
def count_import_from(node, stats, _rel_file_path):
    _count_import(stats)

This will build a stats dictionary that contains something like the following:

{
    "total_imports_num": 763
}

Assertions

Once again in the codewatch_config_module you can add assertions against this stat dictionary using the @assertion decorator

from codewatch import assertion


@assertion()
def number_of_imports_not_too_high(stats):
    threshold = 700
    actual = stats.get('total_imports_num')
    err = 'There were {} total imports detected which exceeds threshold of {}'.format(actual, threshold)
    assert actual <= threshold, err

In this case, the assertion would fail since 763 is the newStat and the message:

There were 763 total imports detected which exceeds threshold of 700

would be printed

Filters

You can add the following optional filters:

1. directory_filter (defaults to skip test and migration directories)

# visit all directories
def directory_filter(_dir_name):
    return True

2. file_filter (defaults to only include python files, and skips test files)

# visit all files
def file_filter(_file_name):
    return True

Tune these filters to suit your needs.

Contributing

See the Contributing docs

Contributors

Thanks goes to these wonderful people emoji key:

Josh Doncaster Marsiglio 💻	Rohit Jain 💻	Chris Abiad 💻	Francois Campbell 💻	Monica Moore 🎨	Jay Crumb 📖	Jake Bolam 🚇
Shouvik D'Costa 📖	Siavash Bidgoly 🚇	Noah Negin-Ulster 💻	Vardan Nadkarni 💻	greenkeeper[bot] 🚇	Kazushige Tominaga 💻

We welcome contributions from the community, Top Hatters and non-Top Hatters alike. Check out our contributing guidelines for more details.

Credits

Special thanks to Carol Skelly for donating the 'tophat' GitHub organization.