Skip to main content

Adds coverage to Django's DiscoverRunner.

Project description

Adds coverage to Django 1.6’s test runner and Carl Meyer and Jannis Leidel’s django-discover-runner.

Inspired by django-coverage.

django-discoverage works with Django 1.4 and above. If you are using Django 1.4 or 1.5, django-discover-runner is required and will be automatically installed. That package backports the implementation of DiscoverRunner included in Django 1.6.

Quick usage

To run the tests, type:

./ test [options] [appname …]

To run the tests without code coverage (i.e. run django-discover-runner instead), type:

./ test –no-coverage [options] [appname …]

If you want to use the --no-coverage option, make sure you add discoverage to your INSTALLED_APPS.

Detailed usage

One of the objectives of Django’s DiscoverRunner (previously django-discover-runner) is to allow the separation of a Django app’s tests from the code it’s testing. Since tests no longer reside in an app, django-discoverage needs a different way to know which apps to include in the coverage report. The runner does this in two ways which are discussed below.

First, it tries to infer which apps you are testing from the name of the package in which the test’s module lives. For example, if you have an app blog and you test the view of the app in the module, the app will be included in the coverage report. The same happens if the app is a subpackage and appears in INSTALLED_APPS as

This behavior is controlled by the PKG_NAME_APP_DISCOVERY setting.

Although not on by default, tested apps can also be guessed from the name of the test’s module. For example, if MODULE_NAME_APP_DISCOVERY is True and there is a module named tests.test_blog, the blog app will be included in the report. You can override the regular expression used to extract the app name using the MODULE_NAME_DISCOVERY_PATTERN setting.

The second way in which django-discoverage finds apps is by looking for an iterable of app names (named by default TESTS_APPS) in three places:

  1. On a TestCase instance in the suite.

  2. In the TestCase subclass’s module (test*.py by default).

  3. In the TestCase subclass’s immediate package. If MyTestCase is in the package tests.myapp.test_views, the runner inspects tests.myapp. It does not currently traverse parent packages.

Let’s say you had the following test module,

TESTS_APPS = ('blog',)

class MyTestCase(TestCase):
    TESTS_APPS = ('mycoolapp', 'myproject.anothercoolapp')

All modules in the apps blog, mycoolapp, and myproject.anothercoolapp will be included in the report along with any apps listed in

Modules specified in OMIT_MODULES will not, however, appear in the report.



Determines whether tested apps are guessed from a test module’s package name. It is on by default.


Determines whether tested apps are guessed from a test module’s name.


A regular expression with a single capturing group that extracts the app name from a module name (e.g. “blog” from test_blog). Defaults to "test_?(\w+)".


The name of the iterable django-discoverage looks for in the three places listed above. Defaults to TESTS_APPS.


Modules not to be traced by coverage. See the coverage API documentation for more details. Defaults to ['*test*'].


A list of regular expressions that impact coverage reporting. If a line of tested code matches one of the patterns in the list, it will not count as a missed line. See the coverage API documentation for more details.

Defaults to:

  • def get_absolute_url(self):

  • def __unicode__(self):

  • def __str__(self):

  • Any statement with import * in it

Change Log

1.0.0 (2013-08-27)

  • Handle ImproperlyConfigured exception raised by django-discover-runner

  • The runner is now successfully used in several projects so it’s moving to 1.0.

0.7.2 (2013-06-19)

  • Require django-discover-runner 1.0 which now backports Django 1.6’s implementation of DiscoverRunner.

0.7.1 (2013-06-18)

  • Only install django-discover-runner if the version of Django installed is lower than 1.6

0.7.0 (2013-06-05)

0.6.2 (2013-03-13)

  • Change the default of COVERAGE_OMIT_MODULES back to ['*test*']

0.6.1 (2013-03-06)

  • Include South’s test database patching

0.6.0 (2013-02-05)

  • Python 3 support

  • Test suite for app discovery methods

  • --no-coverage option

Project details

Download files

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

Source Distribution

django-discoverage-1.0.0.tar.gz (6.7 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page