Make example error messages more realistic

Author: josh-newman

src/errors/types.rs

@@ -519,7 +519,7 @@ impl ErrorType {
             Self::BytesType {..} => "Input should be a valid bytes",
             Self::BytesTooShort {..} => "Data should have at least {min_length} byte{expected_plural}",
             Self::BytesTooLong {..} => "Data should have at most {max_length} byte{expected_plural}",
-            Self::BytesInvalidEncoding { .. } => "Data should be valid {encoding}, {encoding_error}",
+            Self::BytesInvalidEncoding { .. } => "Data should be valid {encoding}: {encoding_error}",
             Self::ValueError {..} => "Value error, {error}",
             Self::AssertionError {..} => "Assertion failed, {error}",
             Self::CustomError {..} => "",  // custom errors are handled separately

src/input/input_json.rs

@@ -9,8 +9,8 @@ use strum::EnumMessage;
 
 use crate::errors::{ErrorType, ErrorTypeDefaults, InputValue, LocItem, ValError, ValResult};
 use crate::lookup_key::{LookupKey, LookupPath};
-use crate::validators::ValBytesMode;
 use crate::validators::decimal::create_decimal;
+use crate::validators::ValBytesMode;
 
 use super::datetime::{
     bytes_as_date, bytes_as_datetime, bytes_as_time, bytes_as_timedelta, float_as_datetime, float_as_duration,

src/input/input_python.rs

@@ -15,9 +15,9 @@ use speedate::MicrosecondsPrecisionOverflowBehavior;
 
 use crate::errors::{ErrorType, ErrorTypeDefaults, InputValue, LocItem, ValError, ValResult};
 use crate::tools::{extract_i64, safe_repr};
-use crate::validators::ValBytesMode;
 use crate::validators::decimal::{create_decimal, get_decimal_type};
 use crate::validators::Exactness;
+use crate::validators::ValBytesMode;
 use crate::ArgsKwargs;
 
 use super::datetime::{

src/input/input_string.rs

@@ -7,8 +7,8 @@ use crate::errors::{ErrorTypeDefaults, InputValue, LocItem, ValError, ValResult}
 use crate::input::py_string_str;
 use crate::lookup_key::{LookupKey, LookupPath};
 use crate::tools::safe_repr;
-use crate::validators::ValBytesMode;
 use crate::validators::decimal::create_decimal;
+use crate::validators::ValBytesMode;
 
 use super::datetime::{
     bytes_as_date, bytes_as_datetime, bytes_as_time, bytes_as_timedelta, EitherDate, EitherDateTime, EitherTime,

src/validators/mod.rs

@@ -10,13 +10,13 @@ use pyo3::types::{PyAny, PyDict, PyString, PyTuple, PyType};
 use pyo3::{intern, PyTraverseError, PyVisit};
 
 use crate::build_tools::{py_schema_err, py_schema_error_type, SchemaError};
-pub(crate) use config::ValBytesMode;
 use crate::definitions::{Definitions, DefinitionsBuilder};
 use crate::errors::{LocItem, ValError, ValResult, ValidationError};
 use crate::input::{Input, InputType, StringMapping};
 use crate::py_gc::PyGcTraverse;
 use crate::recursion_guard::RecursionState;
 use crate::tools::SchemaDict;
+pub(crate) use config::ValBytesMode;
 
 mod any;
 mod arguments;

tests/test_errors.py

@@ -322,13 +322,13 @@ def f(input_value, info):
     ('bytes_too_long', 'Data should have at most 1 byte', {'max_length': 1}),
     (
         'bytes_invalid_encoding',
-        'Data should be valid base64, base64 error',
-        {'encoding': 'base64', 'encoding_error': 'base64 error'},
+        'Data should be valid base64: Invalid byte 1, offset 1',
+        {'encoding': 'base64', 'encoding_error': 'Invalid byte 1, offset 1'},
     ),
     (
         'bytes_invalid_encoding',
-        'Data should be valid hex, hex error',
-        {'encoding': 'hex', 'encoding_error': 'hex error'},
+        'Data should be valid hex: Odd number of digits',
+        {'encoding': 'hex', 'encoding_error': 'Odd number of digits'},
     ),
     ('value_error', 'Value error, foobar', {'error': ValueError('foobar')}),
     ('assertion_error', 'Assertion failed, foobar', {'error': AssertionError('foobar')}),

tests/test_json.py

@@ -403,7 +403,7 @@ def test_json_bytes_base64_invalid():
         {
             'type': 'bytes_invalid_encoding',
             'loc': (),
-            'msg': f'Data should be valid base64, Invalid byte {ord("!")}, offset {len(wrong_input)-1}.',
+            'msg': f'Data should be valid base64: Invalid byte {ord("!")}, offset {len(wrong_input)-1}.',
             'input': wrong_input,
         }
     ]
@@ -435,7 +435,7 @@ def test_json_bytes_hex_invalid():
         {
             'type': 'bytes_invalid_encoding',
             'loc': (),
-            'msg': 'Data should be valid hex, Odd number of digits',
+            'msg': 'Data should be valid hex: Odd number of digits',
             'input': wrong_input,
         }
     ]
@@ -447,7 +447,7 @@ def test_json_bytes_hex_invalid():
         {
             'type': 'bytes_invalid_encoding',
             'loc': (),
-            'msg': "Data should be valid hex, Invalid character 'g' at position 1",
+            'msg': "Data should be valid hex: Invalid character 'g' at position 1",
             'input': wrong_input,
         }
     ]