Make epytext documentation work

This commit is contained in:
Jonathan Lange
2013-04-04 09:36:11 +00:00
parent 1ea77d74fa
commit 68e6f4792d

View File

@@ -333,6 +333,7 @@ class StreamResult(object):
final status event any further file or status events from the final status event any further file or status events from the
same test_id+route_code may be discarded or associated with a new same test_id+route_code may be discarded or associated with a new
test by the StreamResult. (But no exception will be thrown). test by the StreamResult. (But no exception will be thrown).
Interim states: Interim states:
* None - no particular status is being reported, or status being * None - no particular status is being reported, or status being
reported is not associated with a test (e.g. when reporting on reported is not associated with a test (e.g. when reporting on
@@ -340,6 +341,7 @@ class StreamResult(object):
* inprogress - the test is currently running. Emitted by tests when * inprogress - the test is currently running. Emitted by tests when
they start running and at any intermediary point they might they start running and at any intermediary point they might
choose to indicate their continual operation. choose to indicate their continual operation.
Final states: Final states:
* exists - the test exists. This is used when a test is not being * exists - the test exists. This is used when a test is not being
executed. Typically this is when querying what tests could be run executed. Typically this is when querying what tests could be run
@@ -354,6 +356,7 @@ class StreamResult(object):
* skip - the test was selected to run but chose to be skipped. E.g. * skip - the test was selected to run but chose to be skipped. E.g.
a test dependency was missing. This is purely informative - the a test dependency was missing. This is purely informative - the
test is not considered to be a failure. test is not considered to be a failure.
:param test_tags: Optional set of tags to apply to the test. Tags :param test_tags: Optional set of tags to apply to the test. Tags
have no intrinsic meaning - that is up to the test author. have no intrinsic meaning - that is up to the test author.
:param runnable: Allows status reports to mark that they are for :param runnable: Allows status reports to mark that they are for
@@ -517,19 +520,16 @@ class StreamResultRouter(StreamResult):
:param do_start_stop_run: If True then startTestRun and stopTestRun :param do_start_stop_run: If True then startTestRun and stopTestRun
events will be passed onto this sink. events will be passed onto this sink.
route_code_prefix routes events based on a prefix of the route code in
the event. It takes the following arguments::
:param route_prefix: A prefix to match on - e.g. '0'.
:param consume_route: If True, remove the prefix from the route_code
when forwarding events.
test_id routes events based on the test id::
:param test_id: The test id to route on. Use None to select non-test
events.
map may raise errors::
:raises: ValueError if the policy is unknown :raises: ValueError if the policy is unknown
:raises: TypeError if the policy is given arguments it cannot handle. :raises: TypeError if the policy is given arguments it cannot handle.
``route_code_prefix`` routes events based on a prefix of the route
code in the event. It takes a ``route_prefix`` argument to match on
(e.g. '0') and a ``consume_route`` argument, which, if True, removes
the prefix from the ``route_code`` when forwarding events.
``test_id`` routes events based on the test id. It takes a single
argument, ``test_id``. Use ``None`` to select non-test events.
""" """
policy_method = StreamResultRouter._policies.get(policy, None) policy_method = StreamResultRouter._policies.get(policy, None)
if not policy_method: if not policy_method:
@@ -582,6 +582,7 @@ class StreamToDict(StreamResult):
by stopTestRun and notified there and then. by stopTestRun and notified there and then.
The callback is passed a dict with the following keys: The callback is passed a dict with the following keys:
* id: the test id. * id: the test id.
* tags: The tags for the test. A set of unicode strings. * tags: The tags for the test. A set of unicode strings.
* details: A dict of file attachments - ``testtools.content.Content`` * details: A dict of file attachments - ``testtools.content.Content``
@@ -774,7 +775,7 @@ class StreamSummary(StreamToDict):
class TestControl(object): class TestControl(object):
"""Controls a running test run, allowing it to be interrupted. """Controls a running test run, allowing it to be interrupted.
:attribute shouldStop: If True, tests should not run and should instead :ivar shouldStop: If True, tests should not run and should instead
return immediately. Similarly a TestSuite should check this between return immediately. Similarly a TestSuite should check this between
each test and if set stop dispatching any new tests and return. each test and if set stop dispatching any new tests and return.
""" """