Add experimental multipart support and addExpectFailure and addUnexpectedSuccess...
authorRobert Collins <robertc@robertcollins.net>
Tue, 15 Dec 2009 09:43:47 +0000 (20:43 +1100)
committerRobert Collins <robertc@robertcollins.net>
Tue, 15 Dec 2009 09:43:47 +0000 (20:43 +1100)
1  2 
python/subunit/__init__.py

index b3ffceb2ee54c00a2a01a6e5e43bce14ada7dacf,e48b386a170fced0aa456c9968383ad56a753d56..6e8df90317444eb29a957094ea4e94307871c8d3
@@@ -41,10 -41,19 +41,20 @@@ Twisted. See the ``TestProtocolServer`
  
  Subunit includes extensions to the Python ``TestResult`` protocol. These are
  all done in a compatible manner: ``TestResult`` objects that do not implement
- the extension methods will not cause errors to be raised, instead the extesion
+ the extension methods will not cause errors to be raised, instead the extension
  will either lose fidelity (for instance, folding expected failures to success
- in Python versions < 2.7 or 3.1), or discard the extended data (for tags,
- timestamping and progress markers).
+ in Python versions < 2.7 or 3.1), or discard the extended data (for extra
+ details, tags, timestamping and progress markers).
+ The test outcome methods ``addSuccess``, ``addError``, ``addExpectedFailure``,
+ ``addFailure``, ``addSkip`` take an optional keyword parameter ``details``
+ which can be used instead of the usual python unittest parameter.
+ When used the value of details should be a dict from ``string`` to 
+ ``testtools.content.Content`` objects. This is a draft API being worked on with
+ the Python Testing In Python mail list, with the goal of permitting a common
+ way to provide additional data beyond a traceback, such as captured data from
 -disk, logging messages etc.
++disk, logging messages etc. The reference for this API is in testtools (0.9.0
++and newer).
  
  The ``tags(new_tags, gone_tags)`` method is called (if present) to add or
  remove tags in the test run that is currently executing. If called when no