Error messages improvements: removed the brackets in Wrong value: [...] for the Failure details. Fixed #32

Also fixed a few tests where `Failure()` did not have a first argument with the value.

Author: Sylvain MARIE

docs/index.md

@@ -73,7 +73,7 @@ results in
 
 ```bash
 ValidationError[ValueError]: Error validating [surface=-1]. \
-   TooSmall: x >= 0 does not hold for x=-1. Wrong value: [-1].
+   TooSmall: x >= 0 does not hold for x=-1. Wrong value: -1.
 ```
 
 Note that the resulting exception object contains much of the available information (`var_name`, `var_value`, `validation_outcome`) as fields.
@@ -201,7 +201,7 @@ yields for `surf = -1`
 ```bash
 InvalidSurface[ValueError]: Surface should be a positive integer. \
    Error validating [surface=-1]. \
-   TooSmall: x >= 0 does not hold for x=-1. Wrong value: [-1].
+   TooSmall: x >= 0 does not hold for x=-1. Wrong value: -1.
 ```
 
 ### (c) message templating
@@ -221,7 +221,7 @@ yields
 ```bash
 InvalidSurface[ValueError]: Surface should be > 0, found -1. \
    Error validating [surface=-1]. \
-   TooSmall: x >= 0 does not hold for x=-1. Wrong value: [-1].
+   TooSmall: x >= 0 does not hold for x=-1. Wrong value: -1.
 ```
 
 Note: as shown in that last example, the value being validated is already sent to the help message string to format under the `'var_value'` key, so you do not need to pass it. 

valid8/base.py

@@ -311,7 +311,7 @@ def get_details(self):
         if len(strval) > self.__max_str_length_displayed__:
             return '(Actual value is too big to be printed in this message)'
         else:
-            return 'Wrong value: [{}]'.format(self.wrong_value)
+            return 'Wrong value: %s' % repr(self.wrong_value)
 
 
 class WrappingFailure(Failure):

valid8/entry_points.py

@@ -301,7 +301,6 @@ def get_details(self):
                        ''.format(what=self.get_what_txt(), val=self.validator.get_main_function_name(),
                                  result=self.validation_outcome)
 
-        # return 'Wrong value: [{}]'.format(self.var_value)
         return contents
 
     def get_variable_str(self):

valid8/tests/readme/test_readme_index.py

@@ -15,7 +15,7 @@ def test_readme_index_usage_quick():
         validate('surface', surf, instance_of=int, min_value=0)
     e = exc_info.value
     assert str(e) == "Error validating [surface=-1]. " \
-                     "TooSmall: x >= 0 does not hold for x=-1. Wrong value: [-1]."
+                     "TooSmall: x >= 0 does not hold for x=-1. Wrong value: -1."
 
 
 def test_readme_usage_validator():
@@ -56,7 +56,7 @@ def test_readme_usage_validator():
             v.alid = surf > 0
     e = exc_info.value
     assert str(e) == "Error validating [surface=1j]. " \
-                     "HasWrongType: Value should be an instance of %s. Wrong value: [1j]." % repr(int)
+                     "HasWrongType: Value should be an instance of %s. Wrong value: 1j." % repr(int)
 
     from valid8 import assert_instance_of
     with pytest.raises(ValidationError) as exc_info:
@@ -66,7 +66,7 @@ def test_readme_usage_validator():
     e = exc_info.value
     assert str(e) == "Error validating [surface=1j]. " \
                      "Validation function [assert_instance_of(surf, int) ; v.alid = surf > 0] raised " \
-                     "HasWrongType: Value should be an instance of %s. Wrong value: [1j]." % repr(int)
+                     "HasWrongType: Value should be an instance of %s. Wrong value: 1j." % repr(int)
 
 
 def test_readme_usage_customization():
@@ -79,7 +79,7 @@ def test_readme_usage_customization():
     #                 help_msg="Surface should be a positive integer")
     # e = exc_info.value
     # assert str(e) == "Surface should be a positive integer. Error validating [surface=-1]. " \
-    #                  "TooSmall: x >= 0 does not hold for x=-1. Wrong value: [-1]."
+    #                  "TooSmall: x >= 0 does not hold for x=-1. Wrong value: -1."
 
     # (A) custom error message (exception is still a ValidationError)
     with pytest.raises(ValidationError) as exc_info:
@@ -99,7 +99,7 @@ class InvalidSurface(ValidationError):
     assert isinstance(e, InvalidSurface)
     assert str(e) == "Surface should be a positive integer. " \
                      "Error validating [surface=-1]. " \
-                     "TooSmall: x >= 0 does not hold for x=-1. Wrong value: [-1]."
+                     "TooSmall: x >= 0 does not hold for x=-1. Wrong value: -1."
 
     # (C) custom error types with templating
     class InvalidSurface(ValidationError):
@@ -112,13 +112,13 @@ class InvalidSurface(ValidationError):
     assert isinstance(e, InvalidSurface)
     assert type(e).__name__ == "InvalidSurface[ValueError]"
     assert str(e) == "Surface should be > 0, found -1. Error validating [surface=-1]. " \
-                     "TooSmall: x >= 0 does not hold for x=-1. Wrong value: [-1]."
+                     "TooSmall: x >= 0 does not hold for x=-1. Wrong value: -1."
 
     # (D) ValueError/TypeError
     with pytest.raises(ValidationError) as exc_info:
         validate('surface', -1, instance_of=int, min_value=0)
     e = exc_info.value
-    assert str(e) == "Error validating [surface=-1]. TooSmall: x >= 0 does not hold for x=-1. Wrong value: [-1]."
+    assert str(e) == "Error validating [surface=-1]. TooSmall: x >= 0 does not hold for x=-1. Wrong value: -1."
     assert repr(e.__class__) == "<class 'valid8.entry_points.ValidationError[ValueError]'>"
 
     with pytest.raises(ValidationError) as exc_info:
@@ -142,7 +142,7 @@ def test_readme_index_usage_basic():
     e = exc_info.value
     assert str(e) == 'Error validating [surface=-1]. ' \
                      'Validation function [is_multiple_of_100] raised ' \
-                     'IsNotMultipleOf: Value should be a multiple of 100. Wrong value: [-1].'
+                     'IsNotMultipleOf: Value should be a multiple of 100. Wrong value: -1.'
 
     # (2) native mini_lambda support to define validation functions
     from mini_lambda import x
@@ -281,7 +281,7 @@ def test_readme_index_usage_customization():
         assert_valid('surface', None, x > 0, none_policy=NonePolicy.FAIL)
     e = exc_info.value
     assert str(e) == 'Error validating [surface=None]. Validation function [reject_none(x > 0)] raised ' \
-                     'ValueIsNone: The value must be non-None. Wrong value: [None].'
+                     'ValueIsNone: The value must be non-None. Wrong value: None.'
 
     # *** (4) TEST: custom Failure (not ValidationError) message. Does it have any interest ? ***
     with pytest.raises(ValidationError) as exc_info:
@@ -291,7 +291,7 @@ def test_readme_index_usage_customization():
                      'Validation function [is_multiple_of_100] raised ' \
                      'WrappingFailure: Surface should be a multiple of 100. ' \
                      'Function [is_multiple_of_100] raised ' \
-                     '[IsNotMultipleOf: Value should be a multiple of 100. Wrong value: [-1]].'
+                     '[IsNotMultipleOf: Value should be a multiple of 100. Wrong value: -1].'
 
     # (4) custom error message (exception is still a ValidationError)
     with pytest.raises(ValidationError) as exc_info:
@@ -311,7 +311,7 @@ class InvalidSurface(ValidationError):
     assert str(e) == 'Surface should be a positive number. ' \
                      'Error validating [surface=-1]. ' \
                      'Validation function [is_multiple_of_100] raised ' \
-                     'IsNotMultipleOf: Value should be a multiple of 100. Wrong value: [-1].'
+                     'IsNotMultipleOf: Value should be a multiple of 100. Wrong value: -1.'
 
     # (6) custom error types with templating
     class InvalidSurface(ValidationError):
@@ -341,7 +341,7 @@ def test_readme_index_usage_composition():
                      "Validation function [and((x >= 0) & (x < 10000), is_multiple_of_100)] raised " \
                      "AtLeastOneFailed: At least one validation function failed validation for value [-1]. " \
                      "Successes: [] / Failures: {'(x >= 0) & (x < 10000)': 'False', " \
-                     "'is_multiple_of_100': 'IsNotMultipleOf: Value should be a multiple of 100. Wrong value: [-1]'}."
+                     "'is_multiple_of_100': 'IsNotMultipleOf: Value should be a multiple of 100. Wrong value: -1'}."
 
     # (8) ... with a global custom error type. Oh by the way this supports templating
     class InvalidSurface(ValidationError):
@@ -358,7 +358,7 @@ class InvalidSurface(ValidationError):
                      "AtLeastOneFailed: At least one validation function failed validation for value [-1]. " \
                      "Successes: [] / Failures: {" \
                      "'(x >= 0) & (x < 10000)': 'False', " \
-                     "'is_multiple_of_100': 'IsNotMultipleOf: Value should be a multiple of 100. Wrong value: [-1]'}."
+                     "'is_multiple_of_100': 'IsNotMultipleOf: Value should be a multiple of 100. Wrong value: -1'}."
 
     # (9) ... and possible user-friendly intermediate failure messages
     with pytest.raises(ValidationError) as exc_info:
@@ -374,7 +374,7 @@ class InvalidSurface(ValidationError):
                      "Function [(x >= 0) & (x < 10000)] returned [False] for value [-1].', " \
                      "'is_multiple_of_100': 'WrappingFailure: Surface should be a multiple of 100. " \
                      "Function [is_multiple_of_100] raised [IsNotMultipleOf: Value should be a multiple of 100. " \
-                     "Wrong value: [-1]].'}."
+                     "Wrong value: -1].'}."
 
     # *********** other even more complex tests ***********
 
@@ -396,4 +396,4 @@ class InvalidSurface(ValidationError):
                      "Function [(x >= 0) & (x < 10000)] returned [False] for value [-1].', " \
                      "'is_multiple_of_100': 'WrappingFailure: Surface should be a multiple of 100, found -1. " \
                      "Function [is_multiple_of_100] raised [IsNotMultipleOf: Value should be a multiple of 100. " \
-                     "Wrong value: [-1]].'}."
+                     "Wrong value: -1].'}."

valid8/tests/readme/test_readme_usage.py

@@ -47,7 +47,7 @@ def hello(age):
     assert str(e) == "Error validating [age=152]. Validation function [and(isfinite, between_0_and_150)] raised " \
                      "AtLeastOneFailed: At least one validation function failed validation for value [152]. " \
                      "Successes: ['isfinite'] / Failures: {" \
-                     "'between_0_and_150': 'NotInRange: 0 <= x <= 150 does not hold for x=152. Wrong value: [152]'}."
+                     "'between_0_and_150': 'NotInRange: 0 <= x <= 150 does not hold for x=152. Wrong value: 152'}."
 
     # v3: age is an integer
     # https://stackoverflow.com/questions/3501382/checking-whether-a-variable-is-an-integer-or-not
@@ -227,7 +227,7 @@ def test_usage_validators():
         validate_is_greater_than_1('val',0.2)
     e = exc_info.value
     assert str(e) == "Error validating [val=0.2]. Validation function [gt_1] raised " \
-                     "Failure: Wrong value: [x is not greater than 1, x=0.2]."
+                     "Failure: x is not greater than 1, x=0.2. Wrong value: 0.2."
     validate_is_greater_than_2('val',2)
     with pytest.raises(ValidationError) as exc_info:
         validate_is_greater_than_2('val',0.2)
@@ -294,7 +294,7 @@ def gt_0(x):
             raise ValueError('x is not greater than 0, x={}'.format(x))
     def gt_1(x):
         if x < 1:
-            raise Failure('x is not greater than 1, x={}'.format(x))
+            raise Failure(x, 'x is not greater than 1, x={}'.format(x))
 
     # (not recommended) relying on assert, only valid in 'debug' mode
     def gt_2(x):
@@ -346,7 +346,7 @@ def gt_ex1(x):
         if x >= 1:
             return True
         else:
-            raise Failure('x >= 1 does not hold for x={}'.format(x))
+            raise Failure(x, 'x >= 1 does not hold for x={}'.format(x))
 
     def gt_assert2(x):
         """(not recommended) relying on assert, only valid in 'debug' mode"""

valid8/tests/test_entry_points_annotations.py

@@ -287,13 +287,13 @@ def test_validate_custom_validators_with_exception():
     def gt_ex1(x):
         """ A validator raising a custom exception in case of failure """
         if not x >= 1:
-            raise Failure('x >= 1 does not hold for x={val}'.format(val=x))
+            raise Failure(x, 'x >= 1 does not hold for x={val}'.format(val=x))
 
     def is_mod(ref):
         """ A validator generator, with parameters and which raises a custom exception """
         def is_mod(x):
             if x % ref != 0:
-                raise Failure('x % {ref} == 0 does not hold for x={val}'.format(ref=ref, val=x))
+                raise Failure(x, 'x % {ref} == 0 does not hold for x={val}'.format(ref=ref, val=x))
         return is_mod
 
     @validate_io(a=[gt_ex1, lt(12), is_mod(5)])
@@ -311,7 +311,7 @@ def myfunc(a):
                      "Validation function [and(gt_ex1, lesser_than_12, is_mod)] raised " \
                      "AtLeastOneFailed: At least one validation function failed validation for value [0]. " \
                      "Successes: ['lesser_than_12', 'is_mod'] / " \
-                     "Failures: {'gt_ex1': 'Failure: Wrong value: [x >= 1 does not hold for x=0]'}."
+                     "Failures: {'gt_ex1': 'Failure: x >= 1 does not hold for x=0. Wrong value: 0'}."
 
     with pytest.raises(InputValidationError) as exc_info:
         print(2)
@@ -321,7 +321,7 @@ def myfunc(a):
                      "Validation function [and(gt_ex1, lesser_than_12, is_mod)] raised " \
                      "AtLeastOneFailed: At least one validation function failed validation for value [3]. " \
                      "Successes: ['gt_ex1', 'lesser_than_12'] / " \
-                     "Failures: {'is_mod': 'Failure: Wrong value: [x % 5 == 0 does not hold for x=3]'}."
+                     "Failures: {'is_mod': 'Failure: x % 5 == 0 does not hold for x=3. Wrong value: 3'}."
 
     with pytest.raises(InputValidationError) as exc_info:
         print(3)
@@ -331,7 +331,7 @@ def myfunc(a):
                      "Validation function [and(gt_ex1, lesser_than_12, is_mod)] raised " \
                      "AtLeastOneFailed: At least one validation function failed validation for value [15]. " \
                      "Successes: ['gt_ex1', 'is_mod'] / " \
-                     "Failures: {'lesser_than_12': 'TooBig: x <= 12 does not hold for x=15. Wrong value: [15]'}."
+                     "Failures: {'lesser_than_12': 'TooBig: x <= 12 does not hold for x=15. Wrong value: 15'}."
 
 
 def test_validate_mini_lambda():

valid8/tests/test_entry_points_inline.py

@@ -25,7 +25,7 @@ def test_validate_():
         validate('surface', surf, instance_of=int, min_value=0)
     e = exc_info.value
     assert str(e) == "Error validating [surface=-1]. " \
-                     "TooSmall: x >= 0 does not hold for x=-1. Wrong value: [-1]."
+                     "TooSmall: x >= 0 does not hold for x=-1. Wrong value: -1."
 
     # error wrong type
     surf = 1j
@@ -34,7 +34,7 @@ def test_validate_():
         validate('surface', surf, instance_of=(int, ), min_value=0)
     e = exc_info.value
     assert str(e) == "Error validating [surface=1j]. " \
-                     "HasWrongType: Value should be an instance of %s. Wrong value: [1j]." % repr(int)
+                     "HasWrongType: Value should be an instance of %s. Wrong value: 1j." % repr(int)
 
 
 def test_readme_usage_validate__customization():
@@ -48,7 +48,7 @@ def test_readme_usage_validate__customization():
                  help_msg="Surface should be a positive integer")
     e = exc_info.value
     assert str(e) == "Surface should be a positive integer. Error validating [surface=1j]. " \
-                     "HasWrongType: Value should be an instance of %s. Wrong value: [1j]." % repr(int)
+                     "HasWrongType: Value should be an instance of %s. Wrong value: 1j." % repr(int)
 
     # (B) custom error types (recommended to provide unique applicative errors)
     class InvalidSurface(ValidationError):
@@ -69,7 +69,7 @@ class InvalidSurface(ValidationError):
     e = exc_info.value
     assert isinstance(e, InvalidSurface)
     assert str(e) == "Surface should be > 0, found 1j. Error validating [surface=1j]. " \
-                     "HasWrongType: Value should be an instance of %s. Wrong value: [1j]." % repr(int)
+                     "HasWrongType: Value should be an instance of %s. Wrong value: 1j." % repr(int)
 
 
 def test_validator_context_manager():

valid8/validation_lib/collections.py

@@ -374,7 +374,8 @@ def on_each_(*validation_functions_collection):
     def on_each_val(x  # type: Tuple
                     ):
         if len(validation_function_funcs) != len(x):
-            raise Failure('on_each_: x does not have the same number of elements than validation_functions_collection.')
+            raise Failure(x, 'on_each_: x does not have the same number of elements than '
+                             '`validation_functions_collection`.')
         else:
             # apply each validation_function on the input with the same position in the collection
             idx = -1