Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

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

Supported Python versions are 2.7 and 3.4. Supported Django versions are 1.4 through 1.8.

The plugin itself is pip installable:

$ pip install django_coverage_plugin

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

[run]
plugins =
    django_coverage_plugin

Then run your tests under coverage.py. It requires the latest coverage.py, so it may not work with other coverage-related tools such as test-runner coverage plugins.

You will see your templates listed in your coverage report alongside your Python modules.

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

Files included by the {% ssi %} tag are not included in the coverage measurements.

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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_coverage_plugin-1.0b2.tar.gz (4.9 kB view details)

Uploaded Source

File details

Details for the file django_coverage_plugin-1.0b2.tar.gz.

File metadata

File hashes

Hashes for django_coverage_plugin-1.0b2.tar.gz
Algorithm Hash digest
SHA256 7e2a9b12833f08bf12ff272d8dfff552ab3290a6b30093f1d51b1b756cd5397d
MD5 30ca9f8ddec399db0481c410fcbbba10
BLAKE2b-256 31bed771b3d4eb4d1dcc6a42d1089cbd2702d98b96e10d9a300a4e11cf42b2d9

See more details on using hashes here.

Release history Release notifications | RSS feed

3.2.2

2 files

3.2.0

2 files

3.1.1

2 files

3.1.0

2 files

3.0.0

2 files

2.0.4

2 files

2.0.3

2 files

2.0.2

2 files

2.0.1

1 file

2.0.0

1 file

1.8.0

1 file

1.7.0

1 file

1.6.0

1 file

1.5.0

1 file

1.4.2

1 file

1.4.1

1 file

1.4

1 file

1.3.1

1 file

1.3

1 file

1.2.2

1 file

1.2.1

1 file

1.2

1 file

1.1

1 file

1.0

1 file

This release

1.0b2 This release

1 file

1.0b1

0.6

1 file

0.5

1 file

0.3.3

1 file

0.3.2

1 file

0.3.1

1 file

0.3

1 file

0.1

1 file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page