From 31797e5efe9c275b59d3b87998428ee50a9830a9 Mon Sep 17 00:00:00 2001 From: Ezio Melotti Date: Fri, 29 Mar 2013 03:42:29 +0200 Subject: [PATCH] #8906: document failureException, longMessage, and maxDiff in the class docstring. Patch by Boris Feld. --- Lib/unittest/case.py | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/Lib/unittest/case.py b/Lib/unittest/case.py index dd513061168..f56af5574b0 100644 --- a/Lib/unittest/case.py +++ b/Lib/unittest/case.py @@ -237,24 +237,23 @@ class TestCase(object): should not change the signature of their __init__ method, since instances of the classes are instantiated automatically by parts of the framework in order to be run. - """ - # This attribute determines which exception will be raised when - # the instance's assertion methods fail; test methods raising this - # exception will be deemed to have 'failed' rather than 'errored' + When subclassing TestCase, you can set these attributes: + * failureException: determines which exception will be raised when + the instance's assertion methods fail; test methods raising this + exception will be deemed to have 'failed' rather than 'errored'. + * longMessage: determines whether long messages (including repr of + objects used in assert methods) will be printed on failure in *addition* + to any explicit message passed. + * maxDiff: sets the maximum length of a diff in failure messages + by assert methods using difflib. It is looked up as an instance + attribute so can be configured by individual tests if required. + """ failureException = AssertionError - # This attribute determines whether long messages (including repr of - # objects used in assert methods) will be printed on failure in *addition* - # to any explicit message passed. - longMessage = True - # This attribute sets the maximum length of a diff in failure messages - # by assert methods using difflib. It is looked up as an instance attribute - # so can be configured by individual tests if required. - maxDiff = 80*8 # If a string is longer than _diffThreshold, use normal comparison instead