Skip to content
A plugin for coverage.py to measure Django template execution
Branch: master
Clone or download
jambonrose Release v1.6.0 (#62)
* Update year in copyright notice
* Read Me: note missing-template compatibility
* Version 1.6rc1 ⇝ 1.6.0
Latest commit 0072737 Sep 7, 2018

README.rst

Package stability Latest PyPI Version Apache 2.0 License Supported Python Versions Supported Django Versions

Django Template Coverage.py Plugin

A coverage.py plugin to measure test coverage of Django templates.

Supported Python versions: 2.7, 3.4, 3.5 and 3.6.

Supported Django versions: 1.8, 1.11, 2.0, and 2.1.

Supported coverage.py versions are 4.0 and higher.

The plugin is pip installable:

$ pip install django_coverage_plugin

To run it, add this setting to your .coveragerc file:

[run]
plugins =
    django_coverage_plugin

Then run your tests under coverage.py.

You will see your templates listed in your coverage report along with your Python modules. Please use coverage.py v4.4 or greater to allow the plugin to identify untested templates.

If you get a django.core.exceptions.ImproperlyConfigured error, you need to set the DJANGO_SETTINGS_MODULE environment variable.

Configuration

The Django template plugin uses some existing settings from your .coveragerc file. The source=, include=, and omit= options control what template files are included in the report.

Caveats

Coverage.py can't tell whether a {% blocktrans %} tag used the singular or plural text, so both are marked as used if the tag is used.

What the? How?

The technique used to measure the coverage is the same that Dmitry Trofimov used in dtcov, but integrated into coverage.py as a plugin, and made more performant. I'd love to see how well it works in a real production project. If you want to help me with it, feel free to drop me an email.

The coverage.py plugin mechanism is designed to be generally useful for hooking into the collection and reporting phases of coverage.py, specifically to support non-Python files. If you have non-Python files you'd like to support in coverage.py, let's talk.

Tests

To run the tests:

$ pip install -r requirements.txt
$ tox
You can’t perform that action at this time.