Changeset 772:2166f443d615

Timestamp:

2009-04-05 16:28:42 (17 months ago)

Author:

Stefan Schwarzer <sschwarzer@…>

Branch:

default

convert_revision:

svn:778c30c8-61e0-0310-89d4-fe2f97a467b2/trunk@809

Message:

Make the `ftp_error` module more robust with respect to `ftplib`
exceptions containing bytestrings or unicode strings or no strings
at all. Normally, `ftplib` exceptions will only contain bytestrings
but that may not be true for subclasses of `ftplib` exception
classes in third-party modules.

Files:

• MANIFEST (modified) (1 diff)
• _test_ftp_error.py (added)
• ftp_error.py (modified) (6 diffs)

MANIFEST

@@ -20 +20 @@
 setup.py
 _test_base.py
+_test_ftp_error.py
 _test_ftp_file.py
 _test_ftp_path.py

ftp_error.py

@@ -1 @@
-# Copyright (C) 2003-2008, Stefan Schwarzer <sschwarzer@sschwarzer.net>
+# Copyright (C) 2003-2009, Stefan Schwarzer <sschwarzer@sschwarzer.net>
 # All rights reserved.
 #
@@ -41 +41 @@
 import ftplib
 import sys
+import warnings
 
 import ftputil_version
@@ -48 +49 @@
     """General error class."""
 
-    def __init__(self, ftp_exception):
-        super(FTPError, self).__init__(ftp_exception)
-        # `message` is set by the base class
-        self.strerror = self.message
+    def __init__(self, *args):
+        # contrary to what `ftplib`'s documentation says, `all_errors`
+        #  does _not_ contain the subclasses, so I explicitly add them
+        if args and args[0].__class__ in ftplib.all_errors + \
+                                         tuple(ftplib.Error.__subclasses__()):
+            warnings.warn(("Passing exception objects into the FTPError "
+              "constructor is deprecated and will be disabled in ftputil 2.6"),
+              DeprecationWarning, stacklevel=2)
+        super(FTPError, self).__init__(*args)
+        # don't use `args[0]` because `args` may be empty
+        if args:
+            self.strerror = self.args[0]
+        else:
+            self.strerror = ""
         try:
             self.errno = int(self.strerror[:3])
@@ -110 +121 @@
     pass
 
+
 #XXX Do you know better names for `_try_with_oserror` and
 #    `_try_with_ioerror`?
@@ -118 +130 @@
     derived classes.
     """
+    # use `*exc.args` instead of `str(args)` because args might be
+    #  a unicode string with non-ascii characters
     try:
         return callee(*args, **kwargs)
-    except ftplib.error_temp, obj:
-        raise TemporaryError(obj)
-    except ftplib.error_perm, obj:
-        if str(obj).startswith("502"):
-            raise CommandNotImplementedError(obj)
+    except ftplib.error_temp, exc:
+        raise TemporaryError(*exc.args)
+    except ftplib.error_perm, exc:
+        # if `exc.args` is present, assume it's a byte or unicode string
+        if exc.args and exc.args[0].startswith("502"):
+            raise CommandNotImplementedError(*exc.args)
         else:
-            raise PermanentError(obj)
+            raise PermanentError(*exc.args)
     except ftplib.all_errors:
-        ftp_error = sys.exc_info()[1]
-        raise FTPOSError(ftp_error)
+        exc = sys.exc_info()[1]
+        raise FTPOSError(*exc.args)
 
 class FTPIOError(FTPError, IOError):
     """Generic FTP error related to `IOError`."""
     pass
+
 
 def _try_with_ioerror(callee, *args, **kwargs):
@@ -143 +159 @@
         return callee(*args, **kwargs)
     except ftplib.all_errors:
-        ftp_error = sys.exc_info()[1]
-        raise FTPIOError(ftp_error)
+        exc = sys.exc_info()[1]
+        # use `*exc.args` instead of `str(args)` because args might be
+        #  a unicode string with non-ascii characters
+        raise FTPIOError(*exc.args)