Module utils

django.test.utils

source link

Classes

class Approximate
class CaptureQueriesContext
Context manager that captures queries executed by the specified connection.
class ContextList
A wrapper that provides direct key access to context items contained in a list of context objects.
class LoggingCaptureMixin
Capture the output from the 'django' logger and store it on the class's logger_output attribute.
class NullTimeKeeper
class TestContextDecorator
A base class that can either be used as a context manager during tests or as a test function or unittest.TestCase subclass decorator to perform temporary alterations.
class TimeKeeper
class ignore_warnings
class isolate_apps
Act as either a decorator or a context manager to register models defined in its wrapped context to an isolated registry.
class modify_settings
Like override_settings, but makes it possible to append, prepend, or remove items instead of redefining the entire list.
class override_script_prefix
Decorator or context manager to temporary override the script prefix.
class override_settings
Act as either a decorator or a context manager. If it's a decorator, take a
class override_system_checks
Act as a decorator. Override list of registered system checks. Useful when you override `INSTALLED_APPS`, e.g. if you exclude `auth` app, you also need to exclude its system checks.

Functions

▶ def captured_output(stream_name) @contextmanager
Return a context manager used by captured_stdout/stdin/stderr that temporarily replaces the sys stream *stream_name* with a StringIO.
@contextmanager
def captured_output(stream_name)
source link
```
Note: This function and the following ``captured_std*`` are copied
      from CPython's ``test.support`` module.
```

▶ def captured_stderr()

Capture the output of sys.stderr:

source link

with captured_stderr() as stderr:
           print("hello", file=sys.stderr)
       self.assertEqual(stderr.getvalue(), "hello
")

▶ def captured_stdin()

Capture the input to sys.stdin:

source link

with captured_stdin() as stdin:
           stdin.write('hello
')
           stdin.seek(0)
           # call test code that consumes from sys.stdin
           captured = input()
       self.assertEqual(captured, "hello")

▶ def captured_stdout()

Capture the output of sys.stdout:

source link

with captured_stdout() as stdout:
           print("hello")
       self.assertEqual(stdout.getvalue(), "hello
")

▶ def compare_xml(want, got)

Try to do a 'xml-comparison' of want and got. Plain string comparison

source link

doesn't always work because, for example, attribute ordering should not be
important. Ignore comment nodes, processing instructions, document type
node, and leading and trailing whitespaces.

Based on https://github.com/lxml/lxml/blob/master/src/lxml/doctestcompare.py

Reexports

Imported in django.test.testcases.

▷ def dependency_ordered(test_databases, dependencies)
Reorder test_databases into an order that honors the dependencies described in TEST[DEPENDENCIES].
source link
▷ def extend_sys_path(*paths) @contextmanager
Context manager to temporarily add paths to sys.path.
@contextmanager
def extend_sys_path(*paths)
source link

▶ def freeze_time(t) @contextmanager

Context manager to temporarily freeze time.time(). This temporarily

@contextmanager
def freeze_time(t)

source link

modifies the time function of the time module. Modules which import the
time function directly (e.g. `from time import time`) won't be affected
This isn't meant as a public API, but helps reduce some repetitive code in
Django's test suite.

▶ def get_runner(settings, test_runner_class=None)
source link
Reexports
- Imported in django.core.management.commands.test.

▶ def get_unique_databases_and_mirrors(aliases=None)

Figure out which databases actually need to be created.

source link

Deduplicate entries in DATABASES that correspond the same database or are
configured as test mirrors.

Return two values:
- test_databases: ordered mapping of signatures to (name, list of aliases)
                  where all aliases share the same underlying database.
- mirrored_aliases: mapping of mirror aliases to original aliases.

▷ def instrumented_test_render(self, context)
An instrumented Template render method, providing a signal that can be intercepted by the test Client.
source link
▷ def isolate_lru_cache(lru_cache_object) @contextmanager
Clear the cache of an LRU cache object on entering and exiting.
@contextmanager
def isolate_lru_cache(lru_cache_object)
source link
▷ def register_lookup(field, *lookups, lookup_name=None) @contextmanager
Context manager to temporarily register lookups on a model field using lookup_name (or the lookup's lookup_name if not provided).
@contextmanager
def register_lookup(
field,
*lookups,
lookup_name=None,
)
source link
▷ def require_jinja2(test_func)
Decorator to enable a Jinja2 template engine in addition to the regular Django template engine for a test or skip it if Jinja2 isn't available.
source link
▶ def setup_databases(verbosity, interactive, *, time_keeper=None, keepdb=False, debug_sql=False, ...)
Create the test databases.
def setup_databases(
verbosity,
interactive,
*,
time_keeper=None,
keepdb=False,
debug_sql=False,
parallel=0,
aliases=None,
)
source link
Reexports
- Imported in django.test.runner as _setup_databases.
▶ def setup_test_environment(debug=None)
Perform global pre-test setup, such as installing the instrumented template renderer and setting the email backend to the locmem email backend.
source link
Reexports
- Imported in django.test.runner.
▶ def tag(*tags)
Decorator to add tags to a test class or method.
source link
Reexports
- Imported in django.test.selenium.
- Imported in django.test.
▶ def teardown_databases(old_config, verbosity, parallel=0, keepdb=False)
Destroy all the non-mirror databases.
source link
Reexports
- Imported in django.test.runner as _teardown_databases.
▶ def teardown_test_environment()
Perform any global post-test teardown, such as restoring the original template renderer and restoring the email sending functions.
source link
Reexports
- Imported in django.test.runner.