Rework work with unicode in exceptions and data model

Author: penguinolog

exec_helpers/_ssh_client_base.py

@@ -350,19 +350,19 @@ def is_alive(self):  # type: () -> bool
 
     def __repr__(self):  # type: () -> str
         """Representation for debug purposes."""
-        return "{cls}(host={self.hostname}, port={self.port}, auth={self.auth!r})".format(
+        return "{cls}(host={self.hostname}, port={self.port}, auth={self.auth!r})".format(  # type: ignore
             cls=self.__class__.__name__, self=self
-        )
+        ).encode('utf-8')
 
     def __unicode__(self):  # type: () -> typing.Text  # pragma: no cover
         """Representation for debug purposes."""
         return "{cls}(host={self.hostname}, port={self.port}) for user {username}".format(
             cls=self.__class__.__name__, self=self, username=self.auth.username
         )
 
-    def __str__(self):  # type: ignore  # pragma: no cover
+    def __str__(self):  # type: () -> str  # pragma: no cover
         """Representation for debug purposes."""
-        return self.__unicode__().encode("utf-8")
+        return self.__unicode__().encode("utf-8")  # type: ignore
 
     @property
     def _ssh(self):  # type: () -> paramiko.SSHClient

exec_helpers/exceptions.py

@@ -109,17 +109,13 @@ def __init__(self, result, timeout):  # type: (exec_result.ExecResult, typing.Un
         :param timeout: timeout for command
         :type timeout: typing.Union[int, float]
         """
-        stdout_brief = result.stdout_brief.encode(encoding="utf-8", errors="backslashreplace").decode("utf-8")
-        stderr_brief = result.stderr_brief.encode(encoding="utf-8", errors="backslashreplace").decode("utf-8")
         message = (
             "Wait for {result.cmd!r} during {timeout!s}s: no return code and no response on SIGTERM + SIGKILL signals!"
             "\n"
             "\tSTDOUT:\n"
-            "{stdout_brief}\n"
+            "{result.stdout_brief!r}\n"
             "\tSTDERR:\n"
-            "{stderr_brief}".format(
-                result=result, timeout=timeout, stdout_brief=stdout_brief, stderr_brief=stderr_brief
-            )
+            "{result.stderr_brief!r}".format(result=result, timeout=timeout)
         )
         super(ExecHelperNoKillError, self).__init__(message, result=result, timeout=timeout)
 
@@ -128,14 +124,12 @@ def make_timeout_error_message(
     result, timeout
 ):  # type: (exec_result.ExecResult, typing.Union[int, float]) -> typing.Text
     """Make timeout failed message."""
-    stdout_brief = result.stdout_brief.encode(encoding="utf-8", errors="backslashreplace").decode("utf-8")
-    stderr_brief = result.stderr_brief.encode(encoding="utf-8", errors="backslashreplace").decode("utf-8")
     return (
         "Wait for {result.cmd!r} during {timeout!s}s: no return code!\n"
         "\tSTDOUT:\n"
-        "{stdout_brief}\n"
+        "{result.stdout_brief!r}\n"
         "\tSTDERR:\n"
-        "{stderr_brief}".format(result=result, timeout=timeout, stdout_brief=stdout_brief, stderr_brief=stderr_brief)
+        "{result.stderr_brief!r}".format(result=result, timeout=timeout)
     )
 
 
@@ -183,17 +177,13 @@ def __init__(
         """
         self.result = result
         self.expected = proc_enums.exit_codes_to_enums(expected)
-        stdout_brief = result.stdout_brief.encode(encoding="utf-8", errors="backslashreplace").decode("utf-8")
-        stderr_brief = result.stderr_brief.encode(encoding="utf-8", errors="backslashreplace").decode("utf-8")
         message = (
             "Command {result.cmd!r} returned exit code {result.exit_code} "
             "while expected {expected}\n"
             "\tSTDOUT:\n"
-            "{stdout_brief}\n"
+            "{result.stdout_brief!r}\n"
             "\tSTDERR:\n"
-            "{stderr_brief}".format(
-                result=self.result, expected=self.expected, stdout_brief=stdout_brief, stderr_brief=stderr_brief
-            )
+            "{result.stderr_brief!r}".format(result=result, expected=self.expected)
         )
         super(CalledProcessError, self).__init__(message)
 

exec_helpers/exec_result.py

@@ -122,9 +122,11 @@ def __unicode__(self):  # type: () -> typing.Text  # pragma: no cover
         """Get string for debug purposes."""
         return self[:]
 
-    def __repr__(self):  # type: () -> typing.Text
+    def __repr__(self):  # type: () -> str
         """Repr for debug purposes."""
-        return "{cls}(data={self._data!r})".format(cls=self.__class__.__name__, self=self)
+        return (
+            "{cls}(data={self._data!r})".format(cls=self.__class__.__name__, self=self).encode('utf-8')  # type: ignore
+        )
 
 
 class ExecResult(object):
@@ -600,11 +602,11 @@ def __repr__(self):  # type: () -> str
         else:
             started = ""
         return (
-            "{cls}(cmd={self.cmd!r}, stdout={self.stdout}, stderr={self.stderr}, "
+            "{cls}(cmd={self.cmd!r}, stdout={self.stdout}, stderr={self.stderr}, "  # type: ignore
             "exit_code={self.exit_code!s}{started},)".format(cls=self.__class__.__name__, self=self, started=started)
-        )
+        ).encode('utf-8')
 
-    def __str__(self):  # type: () -> str
+    def __unicode__(self):  # type: () -> typing.Text
         """Representation for logging."""
         if self.started:
             started = "\tstarted={started},\n".format(started=self.started.strftime("%Y-%m-%d %H:%M:%S"))
@@ -634,6 +636,10 @@ def __str__(self):  # type: () -> str
             )
         )
 
+    def __str__(self):  # type: () -> str  # pragma: no cover
+        """Representation for debug purposes."""
+        return self.__unicode__().encode("utf-8")  # type: ignore
+
     def __eq__(self, other):  # type: (typing.Any) -> bool
         """Comparision."""
         return (

exec_helpers/proc_enums.py

@@ -70,12 +70,16 @@ class SigNum(int, enum.Enum):
     SIGPWR = 30  # Power failure restart (System V).
     SIGSYS = 31  # Bad system call.
 
-    def __str__(self):  # type: () -> str  # pragma: no cover
+    def __unicode__(self):  # type: () -> typing.Text  # pragma: no cover
         """Representation for logs."""
         return "{self.name}<{self.value:d}(0x{self.value:02X})>".format(  # pylint: disable=missing-format-attribute
             self=self
         )
 
+    def __str__(self):  # type: () -> str  # pragma: no cover
+        """Representation for debug purposes."""
+        return self.__unicode__().encode("utf-8")  # type: ignore
+
 
 if six.PY3:  # pragma: no cover
     digit_type = int
@@ -181,12 +185,16 @@ class ExitCodes(digit_type, enum.Enum):
     SH_EX_SIGPWR = 128 + SigNum.SIGPWR
     SH_EX_SIGSYS = 128 + SigNum.SIGSYS
 
-    def __str__(self):  # type: () -> str
+    def __unicode__(self):  # type: () -> typing.Text
         """Representation for logs."""
         return "{self.name}<{self.value:d}(0x{self.value:02X})>".format(  # pylint: disable=missing-format-attribute
             self=self
         )
 
+    def __str__(self):  # type: () -> str  # pragma: no cover
+        """Representation for debug purposes."""
+        return self.__unicode__().encode("utf-8")  # type: ignore
+
 
 EXPECTED = 0 if "win32" == sys.platform else ExitCodes.EX_OK
 INVALID = 0xDEADBEEF if "win32" == sys.platform else ExitCodes.EX_INVALID

exec_helpers/ssh_auth.py

@@ -219,7 +219,7 @@ def __copy__(self):  # type: () -> SSHAuth
         """Copy self."""
         return self.__class__(username=self.username, password=self.__password, key=self.__key, keys=self.__keys)
 
-    def __repr__(self):  # type: (...) -> str
+    def __repr__(self):  # type: () -> str
         """Representation for debug purposes."""
         _key = None if self.__key is None else "<private for pub: {}>".format(self.public_key)
         _keys = []  # type: typing.List[typing.Union[str, None]]
@@ -230,16 +230,20 @@ def __repr__(self):  # type: (...) -> str
             _keys.append("<private for pub: {}>".format(self.__get_public_key(key=k)) if k is not None else None)
 
         return (
-            "{cls}("
+            "{cls}("  # type: ignore
             "username={self.username!r}, "
             "password=<*masked*>, "
             "key={key}, "
             "keys={keys}, "
             "key_filename={self.key_filename!r}, "
             "passphrase=<*masked*>,"
             ")".format(cls=self.__class__.__name__, self=self, key=_key, keys=_keys)
-        )
+        ).encode('utf-8')
 
-    def __str__(self):  # type: (...) -> str
+    def __unicode__(self):  # type: () -> typing.Text
         """Representation for debug purposes."""
         return "{cls} for {self.username}".format(cls=self.__class__.__name__, self=self)
+
+    def __str__(self):  # type: () -> str
+        """Representation for debug purposes."""
+        return self.__unicode__().encode('utf-8')  # type: ignore