summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorRobert Collins <robertc@robertcollins.net>2009-07-28 23:32:10 +1000
committerRobert Collins <robertc@robertcollins.net>2009-07-28 23:32:10 +1000
commit7aa495ccf553cf96c04cf2c2419aec8dd7465fac (patch)
tree5b90a06fe9dadb0a5fea1cdb61caaddcb512d575 /README
parent9361b85f6b08a1b0838d157a6b2f427291a06aa7 (diff)
downloadsubunit-git-7aa495ccf553cf96c04cf2c2419aec8dd7465fac.tar.gz
Basic progress support.
Diffstat (limited to 'README')
-rw-r--r--README9
1 files changed, 7 insertions, 2 deletions
diff --git a/README b/README
index c4c21df..677f0ce 100644
--- a/README
+++ b/README
@@ -130,12 +130,17 @@ result object::
# needed and report to your result object.
suite.run(result)
-subunit includes extensions to the python ``TestResult`` protocol. The
-``time(a_datetime)`` method is called (if present) when a ``time:``
+subunit includes extensions to the python ``TestResult`` protocol.
+
+The ``time(a_datetime)`` method is called (if present) when a ``time:``
directive is encountered in a subunit stream. This is used to tell a TestResult
about the time that events in the stream occured at, to allow reconstructing
test timing from a stream.
+The ``progress(offset, whence)`` method controls progress data for a stream.
+The offset parameter is an int, and whence is one of subunit.SEEK_CUR,
+subunit.SEEK_SET.
+
Finally, subunit.run is a convenience wrapper to run a python test suite via
the command line, reporting via subunit::