Merge branch 'master' of github.com:giampaolo/pyftpdlib

Author: giampaolo

HISTORY.rst

@@ -1,5 +1,20 @@
 Bug tracker at https://github.com/giampaolo/pyftpdlib/issues
 
+Version: 2.2.0 - XXXX-XX-XX
+===========================
+
+
+**Compatibility notes**
+
+* ``pyftpdlib.authorizers.AuthenticationFailed`` moved into
+  ``pyftpdlib.exceptions.AuthenticationFailed``. Old alias is still available.
+* ``pyftpdlib.authorizers.AuthorizerError`` moved into
+  ``pyftpdlib.exceptions.AuthorizerError``. Old alias is still available.
+* ``pyftpdlib.filesystems.FilesystemError`` moved into
+  ``pyftpdlib.exceptions.FilesystemError``. Old alias is still available.
+
+
+
 Version: 2.1.0 - 2025-09-25
 ===========================
 

MANIFEST.in

@@ -38,8 +38,18 @@ include make.bat
 include pyftpdlib/__init__.py
 include pyftpdlib/__main__.py
 include pyftpdlib/authorizers.py
+include pyftpdlib/exceptions.py
 include pyftpdlib/filesystems.py
-include pyftpdlib/handlers.py
+include pyftpdlib/handlers/__init__.py
+include pyftpdlib/handlers/ftp/__init__.py
+include pyftpdlib/handlers/ftp/control.py
+include pyftpdlib/handlers/ftp/data.py
+include pyftpdlib/handlers/ftp/dispatchers.py
+include pyftpdlib/handlers/ftp/producers.py
+include pyftpdlib/handlers/ftps/__init__.py
+include pyftpdlib/handlers/ftps/control.py
+include pyftpdlib/handlers/ftps/data.py
+include pyftpdlib/handlers/ftps/ssl.py
 include pyftpdlib/ioloop.py
 include pyftpdlib/log.py
 include pyftpdlib/prefork.py

demo/md5_ftpd.py

@@ -11,8 +11,8 @@
 import hashlib
 import os
 
-from pyftpdlib.authorizers import AuthenticationFailed
 from pyftpdlib.authorizers import DummyAuthorizer
+from pyftpdlib.exceptions import AuthenticationFailed
 from pyftpdlib.handlers import FTPHandler
 from pyftpdlib.servers import FTPServer
 

docs/api.rst

@@ -14,25 +14,26 @@ Modules and classes hierarchy
 
 ::
 
-  pyftpdlib.authorizers.AuthenticationFailed
   pyftpdlib.authorizers.DummyAuthorizer
   pyftpdlib.authorizers.UnixAuthorizer
   pyftpdlib.authorizers.WindowsAuthorizer
-  pyftpdlib.handlers.FTPHandler
-  pyftpdlib.handlers.TLS_FTPHandler
-  pyftpdlib.handlers.DTPHandler
-  pyftpdlib.handlers.TLS_DTPHandler
-  pyftpdlib.handlers.ThrottledDTPHandler
-  pyftpdlib.filesystems.FilesystemError
+  pyftpdlib.exceptions.AuthenticationFailed
+  pyftpdlib.exceptions.AuthorizerError
+  pyftpdlib.exceptions.FilesystemError
   pyftpdlib.filesystems.AbstractedFS
   pyftpdlib.filesystems.UnixFilesystem
-  pyftpdlib.servers.FTPServer
-  pyftpdlib.servers.ThreadedFTPServer
-  pyftpdlib.servers.MultiprocessFTPServer
-  pyftpdlib.ioloop.IOLoop
-  pyftpdlib.ioloop.Connector
+  pyftpdlib.handlers.DTPHandler
+  pyftpdlib.handlers.FTPHandler
+  pyftpdlib.handlers.ThrottledDTPHandler
+  pyftpdlib.handlers.TLS_DTPHandler
+  pyftpdlib.handlers.TLS_FTPHandler
   pyftpdlib.ioloop.Acceptor
   pyftpdlib.ioloop.AsyncChat
+  pyftpdlib.ioloop.Connector
+  pyftpdlib.ioloop.IOLoop
+  pyftpdlib.servers.FTPServer
+  pyftpdlib.servers.MultiprocessFTPServer
+  pyftpdlib.servers.ThreadedFTPServer
 
 Users
 =====
@@ -91,7 +92,7 @@ Users
 
   .. method:: validate_authentication(username, password, handler)
 
-    Raises :class:`pyftpdlib.authorizers.AuthenticationFailed` if the supplied
+    Raises :class:`pyftpdlib.exceptions.AuthenticationFailed` if the supplied
     username and password don't match the stored credentials.
 
     *Changed in 1.0.0: new handler parameter.*

pyftpdlib/authorizers.py

@@ -17,30 +17,19 @@ class for:
 interact with UNIX and Windows password database.
 """
 
-
 import os
 import warnings
 
+from .exceptions import AuthenticationFailed
+from .exceptions import AuthorizerError
+
 __all__ = [
     "DummyAuthorizer",
     # 'BaseUnixAuthorizer', 'UnixAuthorizer',
     # 'BaseWindowsAuthorizer', 'WindowsAuthorizer',
 ]
 
 
-# ===================================================================
-# --- exceptions
-# ===================================================================
-
-
-class AuthorizerError(Exception):
-    """Base class for authorizer exceptions."""
-
-
-class AuthenticationFailed(Exception):
-    """Exception raised when authentication fails for any reason."""
-
-
 # ===================================================================
 # --- base class
 # ===================================================================

pyftpdlib/exceptions.py

@@ -0,0 +1,36 @@
+# Copyright (C) 2007 Giampaolo Rodola' <g.rodola@gmail.com>.
+# Use of this source code is governed by MIT license that can be
+# found in the LICENSE file.
+
+__all__ = ["AuthenticationFailed", "AuthorizerError", "FilesystemError"]
+
+
+class AuthorizerError(Exception):
+    """Base class for authorizer exceptions."""
+
+
+class AuthenticationFailed(Exception):
+    """Exception raised when authentication fails for any reason."""
+
+
+class FilesystemError(Exception):
+    """Custom class for filesystem-related exceptions.
+    You can raise this from an AbstractedFS subclass in order to
+    send a customized error string to the client.
+    """
+
+
+class _RetryError(Exception):
+    """Raised when a socket operation would block, and hence it should
+    be retried at a later time.
+    """
+
+
+class _FileReadWriteError(OSError):
+    """Exception raised when reading or writing a file during a transfer."""
+
+
+class _GiveUpOnSendfile(Exception):
+    """Exception raised in case use of sendfile() fails on first try,
+    in which case send() will be used.
+    """

pyftpdlib/filesystems.py

@@ -7,6 +7,7 @@
 import tempfile
 import time
 
+from .exceptions import FilesystemError
 from .utils import memoize
 
 try:
@@ -16,7 +17,7 @@
     pwd = grp = None
 
 
-__all__ = ["AbstractedFS", "FilesystemError"]
+__all__ = ["AbstractedFS"]
 
 
 _months_map = {
@@ -35,18 +36,6 @@
 }
 
 
-# ===================================================================
-# --- custom exceptions
-# ===================================================================
-
-
-class FilesystemError(Exception):
-    """Custom class for filesystem-related exceptions.
-    You can raise this from an AbstractedFS subclass in order to
-    send a customized error string to the client.
-    """
-
-
 # ===================================================================
 # --- base class
 # ===================================================================

pyftpdlib/handlers/__init__.py

@@ -0,0 +1,15 @@
+# Copyright (C) 2007 Giampaolo Rodola' <g.rodola@gmail.com>.
+# Use of this source code is governed by MIT license that can be
+# found in the LICENSE file.
+
+from .ftp.control import FTPHandler  # noqa: F401
+from .ftp.data import DTPHandler  # noqa: F401
+from .ftp.data import ThrottledDTPHandler  # noqa: F401
+
+try:
+    from OpenSSL import SSL  # noqa: F401
+except ImportError:
+    pass
+else:
+    from .ftps.control import TLS_FTPHandler  # noqa: F401
+    from .ftps.data import TLS_DTPHandler  # noqa: F401

pyftpdlib/handlers/ftp/__init__.py

@@ -0,0 +1,3 @@
+# Copyright (C) 2007 Giampaolo Rodola' <g.rodola@gmail.com>.
+# Use of this source code is governed by MIT license that can be
+# found in the LICENSE file.