Browse Source

Refs #25735 -- Added tags/exclude_tags arguments to DiscoverRunner docs.

Mariusz Felisiak 4 years ago
parent
commit
37044817f9
1 changed files with 8 additions and 1 deletions
  1. 8 1
      docs/topics/testing/advanced.txt

+ 8 - 1
docs/topics/testing/advanced.txt

@@ -510,7 +510,7 @@ behavior. This class defines the ``run_tests()`` entry point, plus a
 selection of other methods that are used by ``run_tests()`` to set up, execute
 and tear down the test suite.
 
-.. class:: DiscoverRunner(pattern='test*.py', top_level=None, verbosity=1, interactive=True, failfast=False, keepdb=False, reverse=False, debug_mode=False, debug_sql=False, parallel=0, test_name_patterns=None, pdb=False, buffer=False, enable_faulthandler=True, timing=True, **kwargs)
+.. class:: DiscoverRunner(pattern='test*.py', top_level=None, verbosity=1, interactive=True, failfast=False, keepdb=False, reverse=False, debug_mode=False, debug_sql=False, parallel=0, tags=None, exclude_tags=None, test_name_patterns=None, pdb=False, buffer=False, enable_faulthandler=True, timing=True, **kwargs)
 
     ``DiscoverRunner`` will search for tests in any file matching ``pattern``.
 
@@ -550,6 +550,13 @@ and tear down the test suite.
     of processes accordingly. Each process gets its own database. This option
     requires the third-party ``tblib`` package to display tracebacks correctly.
 
+    ``tags`` can be used to specify a set of :ref:`tags for filtering tests
+    <topics-tagging-tests>`. May be combined with ``exclude_tags``.
+
+    ``exclude_tags`` can be used to specify a set of
+    :ref:`tags for excluding tests <topics-tagging-tests>`. May be combined
+    with ``tags``.
+
     If ``debug_sql`` is ``True``, failing test cases will output SQL queries
     logged to the :ref:`django.db.backends logger <django-db-logger>` as well
     as the traceback. If ``verbosity`` is ``2``, then queries in all tests are