Fixed doctests: skipping them in python 2 so that we can get rid of the IGNORE_EXCEPTION_DETAIL directive. Indeed we need to validate the contents of the exception

Author: Sylvain MARIE

setup.cfg

@@ -20,5 +20,5 @@ test=pytest
 [tool:pytest]
 norecursedirs=tests/helpers
 addopts = --verbose --doctest-modules --ignore-glob='**/_*.py' --ignore=_typing_inspect.py
-doctest_optionflags= NORMALIZE_WHITESPACE IGNORE_EXCEPTION_DETAIL ELLIPSIS
+doctest_optionflags= NORMALIZE_WHITESPACE ELLIPSIS
 testpaths = valid8

valid8/base.py

@@ -439,7 +439,35 @@ def failure_raiser(validation_callable,   # type: ValidationCallableOrLambda
     Wraps the provided validation function so that in case of failure it raises the given `failure_type` or a
     `WrappingFailure` with the given help message.
 
-    mini-lambda functions are automatically transformed to functions.
+    >>> import sys, pytest
+    >>> if sys.version_info < (3, 0):
+    ...     pytest.skip('doctest skipped in python 2 because exception namespace is different but details matter')
+
+    >>> def is_big(x): return x > 10
+    >>> is_big_with_details = failure_raiser(is_big, help_msg="x should be big")
+    >>> is_big_with_details(11)
+    >>> is_big_with_details(2)
+    Traceback (most recent call last):
+    ...
+    valid8.base.ValidationFailed: x should be big. Function [is_big] returned [False] for value 2.
+    >>> class MyTooSmall(ValidationFailed):
+    ...     help_msg = "x should be bigger than 10. Found {wrong_value}"
+    >>> is_big_with_details = failure_raiser(is_big, failure_type=MyTooSmall)
+    >>> is_big_with_details(11)
+    >>> is_big_with_details(2)
+    Traceback (most recent call last):
+    ...
+    valid8.base.MyTooSmall: x should be bigger than 10. Found 2. Function [is_big] returned [False] for value 2.
+
+    mini-lambda functions are automatically transformed to functions:
+
+    >>> from mini_lambda import x
+    >>> is_small_with_details = failure_raiser(x < 3, help_msg="x should be smaller than 3")
+    >>> is_small_with_details(2)
+    >>> is_small_with_details(11)
+    Traceback (most recent call last):
+    ...
+    valid8.base.ValidationFailed: x should be smaller than 3. Function [x < 3] returned [False] for value 11.
 
     :param validation_callable:
     :param failure_type: an optional subclass of `WrappingFailure` that should be raised in case of failure, instead of

valid8/common_syntax.py

@@ -73,6 +73,10 @@ def _make_validation_func_callable(vf_definition  # type: ValidationFuncDefiniti
 
     If `vf_definition` is a single <validation_func> callable, it is returned directly (no wrapping)
 
+    >>> import sys, pytest
+    >>> if sys.version_info < (3, 0):
+    ...     pytest.skip('doctest skipped in python 2 because exception namespace is different but details matter')
+
     >>> def vf(x): return x + 1 == 0
     >>> assert _make_validation_func_callable(vf) is vf
 
@@ -85,7 +89,7 @@ def _make_validation_func_callable(vf_definition  # type: ValidationFuncDefiniti
     >>> vf_with_details('hello')
     Traceback (most recent call last):
     ...
-    MyFailure: blah. Function [vf] raised [TypeError: can...
+    valid8.common_syntax.MyFailure: blah. Function [vf] raised [TypeError: can...
 
     Notes:
 
@@ -176,6 +180,10 @@ def _make_validation_func_callables(*vf_definition  # type: OneOrSeveralVFDefini
     and a tuple containing the results will be returned. See `_make_validation_func_callable` for details on the
     supported tuples to use.
 
+    >>> import sys, pytest
+    >>> if sys.version_info < (3, 0):
+    ...     pytest.skip('doctest skipped in python 2 because exception namespace is different but details matter')
+
     >>> # two dummy validation callables
     >>> def is_big(x): return x > 10
     >>> def is_minus_1(x): return x + 1 == 0
@@ -191,7 +199,7 @@ def _make_validation_func_callables(*vf_definition  # type: OneOrSeveralVFDefini
     >>> several_vfs[1]('hello')
     Traceback (most recent call last):
     ...
-    MyFailure: not minus 1!. Function [is_minus_1] raised [TypeError: can...
+    valid8.common_syntax.MyFailure: not minus 1!. Function [is_minus_1] raised [TypeError: can...
 
     If a single `vf_definition` is provided AND it is a non-tuple iterable (typically a list),
     `_make_validation_func_callables(vf_definition)` is equivalent to `_make_validation_func_callables(*vf_definition)`
@@ -209,7 +217,7 @@ def _make_validation_func_callables(*vf_definition  # type: OneOrSeveralVFDefini
     >>> vfs[0](2)
     Traceback (most recent call last):
     ...
-    WrappingFailure: x should be big. Function [is_big] returned [False] for value 2.
+    valid8.base.ValidationFailed: x should be big. Function [is_big] returned [False] for value 2.
 
     :param vf_definition: the base validation function or list of base validation functions to use. A callable, a
         tuple(callable, help_msg_str), a tuple(callable, failure_type), tuple(callable, help_msg_str, failure_type)