Commit 9e054ff1 authored by Brett Cannon's avatar Brett Cannon

Flesh out test_support docs.

parent a0a19f5a
...@@ -332,10 +332,22 @@ test_support provides the following useful objects: ...@@ -332,10 +332,22 @@ test_support provides the following useful objects:
platform doesn't offer all the required facilities (like large platform doesn't offer all the required facilities (like large
file support), even if all the required modules are available. file support), even if all the required modules are available.
* ``ResourceDenied`` - this is raised when a test requires a resource that
is not available. Primarily used by 'requires'.
* ``verbose`` - you can use this variable to control print output. Many * ``verbose`` - you can use this variable to control print output. Many
modules use it. Search for "verbose" in the test_*.py files to see modules use it. Search for "verbose" in the test_*.py files to see
lots of examples. lots of examples.
* ``forget(module_name)`` - attempts to cause Python to "forget" that it
loaded a module and erase any PYC files.
* ``is_resource_enabled(resource)`` - Returns a boolean based on whether
the resource is enabled or not.
* ``requires(resource [, msg])`` - if the required resource is not
available the ResourceDenied exception is raised.
* ``verify(condition, reason='test failed')``. Use this instead of:: * ``verify(condition, reason='test failed')``. Use this instead of::
assert condition[, reason] assert condition[, reason]
...@@ -344,6 +356,10 @@ test_support provides the following useful objects: ...@@ -344,6 +356,10 @@ test_support provides the following useful objects:
mode, and it raises ``TestFailed`` on failure instead of mode, and it raises ``TestFailed`` on failure instead of
``AssertionError``. ``AssertionError``.
* ``have_unicode`` - true if Unicode is available, false otherwise.
* ``is_jython`` - true if the interpreter is Jython, false otherwise.
* ``TESTFN`` - a string that should always be used as the filename when * ``TESTFN`` - a string that should always be used as the filename when
you need to create a temp file. Also use ``try``/``finally`` to you need to create a temp file. Also use ``try``/``finally`` to
ensure that your temp files are deleted before your test completes. ensure that your temp files are deleted before your test completes.
...@@ -359,13 +375,13 @@ test_support provides the following useful objects: ...@@ -359,13 +375,13 @@ test_support provides the following useful objects:
somewhere along sys.path or in the Lib/test tree - see somewhere along sys.path or in the Lib/test tree - see
test_linuxaudiodev.py for an example of its use. test_linuxaudiodev.py for an example of its use.
* ``use_large_resources`` - true iff tests requiring large time or space
should be run.
* ``fcmp(x,y)`` - you can call this function to compare two floating * ``fcmp(x,y)`` - you can call this function to compare two floating
point numbers when you expect them to only be approximately equal point numbers when you expect them to only be approximately equal
withing a fuzz factor (``test_support.FUZZ``, which defaults to 1e-6). withing a fuzz factor (``test_support.FUZZ``, which defaults to 1e-6).
* ``check_syntax(statement)`` - make sure that the statement is *not*
correct Python syntax.
Python and C statement coverage results are currently available at Python and C statement coverage results are currently available at
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment