Refactor error message formatting

Signed-off-by: Tsuyoshi Hombashi <tsuyoshi.hombashi@gmail.com>

Author: thombashi

pathvalidate/_const.py

@@ -3,7 +3,7 @@
 
 
 DEFAULT_MIN_LEN: Final = 1
-INVALID_CHAR_ERR_MSG_TMPL: Final = "invalids=({invalid}), value={value!r}"
+INVALID_CHAR_ERR_MSG_TMPL: Final = "invalids=({invalid})"
 
 
 _NTFS_RESERVED_FILE_NAMES: Final = (

pathvalidate/_filename.py

@@ -229,46 +229,48 @@ def __validate_universal_filename(self, unicode_filename: str) -> None:
         if match:
             raise InvalidCharError(
                 INVALID_CHAR_ERR_MSG_TMPL.format(
-                    invalid=findall_to_str(match), value=repr(unicode_filename)
+                    invalid=findall_to_str(match),
                 ),
                 platform=Platform.UNIVERSAL,
+                value=unicode_filename,
             )
 
     def __validate_win_filename(self, unicode_filename: str) -> None:
         match = _RE_INVALID_WIN_FILENAME.findall(unicode_filename)
         if match:
             raise InvalidCharError(
                 INVALID_CHAR_ERR_MSG_TMPL.format(
-                    invalid=findall_to_str(match), value=repr(unicode_filename)
+                    invalid=findall_to_str(match),
                 ),
                 platform=Platform.WINDOWS,
+                value=unicode_filename,
             )
 
         if unicode_filename in (".", ".."):
             return
 
         KB2829981_err_tmpl = "{}. Refer: https://learn.microsoft.com/en-us/troubleshoot/windows-client/shell-experience/file-folder-name-whitespace-characters"  # noqa: E501
+        err_kwargs = {
+            ErrorAttrKey.PLATFORM: Platform.WINDOWS,
+            ErrorAttrKey.VALUE: unicode_filename,
+        }
 
         if unicode_filename[-1] in (" ", "."):
             raise InvalidCharError(
-                INVALID_CHAR_ERR_MSG_TMPL.format(
-                    invalid=re.escape(unicode_filename[-1]), value=repr(unicode_filename)
-                ),
-                platform=Platform.WINDOWS,
+                INVALID_CHAR_ERR_MSG_TMPL.format(invalid=re.escape(unicode_filename[-1])),
                 description=KB2829981_err_tmpl.format(
                     "Do not end a file or directory name with a space or a period"
                 ),
+                **err_kwargs,
             )
 
         if unicode_filename[0] in (" "):
             raise InvalidCharError(
-                INVALID_CHAR_ERR_MSG_TMPL.format(
-                    invalid=re.escape(unicode_filename[0]), value=repr(unicode_filename)
-                ),
-                platform=Platform.WINDOWS,
+                INVALID_CHAR_ERR_MSG_TMPL.format(invalid=re.escape(unicode_filename[0])),
                 description=KB2829981_err_tmpl.format(
                     "Do not start a file or directory name with a space"
                 ),
+                **err_kwargs,
             )
 
 

pathvalidate/_filepath.py

@@ -278,19 +278,17 @@ def __validate_unix_filepath(self, unicode_filepath: str) -> None:
         match = _RE_INVALID_PATH.findall(unicode_filepath)
         if match:
             raise InvalidCharError(
-                INVALID_CHAR_ERR_MSG_TMPL.format(
-                    invalid=findall_to_str(match), value=repr(unicode_filepath)
-                )
+                INVALID_CHAR_ERR_MSG_TMPL.format(invalid=findall_to_str(match)),
+                value=unicode_filepath,
             )
 
     def __validate_win_filepath(self, unicode_filepath: str) -> None:
         match = _RE_INVALID_WIN_PATH.findall(unicode_filepath)
         if match:
             raise InvalidCharError(
-                INVALID_CHAR_ERR_MSG_TMPL.format(
-                    invalid=findall_to_str(match), value=repr(unicode_filepath)
-                ),
+                INVALID_CHAR_ERR_MSG_TMPL.format(invalid=findall_to_str(match)),
                 platform=Platform.WINDOWS,
+                value=unicode_filepath,
             )
 
         _drive, value = self.__split_drive(unicode_filepath)

test/test_filename.py

@@ -467,10 +467,10 @@ def test_exception_escape_err_msg(self, value, platform, expected):
             print(platform, repr(value))
             validate_filename(value, platform=platform)
 
-        assert e.value.reason == ErrorReason.INVALID_CHARACTER
+        assert e.value.reason == expected
         assert str(e.value) == (
-            r"[PV1100] invalid characters found: invalids=('\r'), value='asdf\rsdf', "
-            "platform=Windows"
+            r"[PV1100] invalid characters found: invalids=('\r'), "
+            "platform=Windows, value='asdf\\rsdf'"
         )  # noqa
 
     @pytest.mark.parametrize(

test/test_filepath.py

@@ -522,8 +522,8 @@ def test_exception_escape_err_msg(self, value, platform, expected):
 
         assert e.value.reason == expected
         assert str(e.value) == (
-            r"[PV1100] invalid characters found: invalids=('\r'), value='asdf\rsdf', "
-            "platform=Windows"
+            r"[PV1100] invalid characters found: invalids=('\r'), "
+            "platform=Windows, value='asdf\\rsdf'"
         )  # noqa
 
     @pytest.mark.parametrize(