Changeset 117 for trunk/turbomail

Timestamp:

11/16/08 08:11:41 (2 months ago)

Author:

fs

Message:

renamed providers to transports which reflects the real purpose better

Location:

trunk/turbomail

Files:

• api.py (modified) (3 diffs)
• control.py (modified) (3 diffs)
• exceptions.py (modified) (2 diffs)
• managers/demand.py (modified) (3 diffs)
• managers/immediate.py (modified) (3 diffs)
• message.py (modified) (2 diffs)
• transports (moved) (moved from trunk/turbomail/providers)
• transports/debug.py (modified) (3 diffs)
• transports/smtp.py (modified) (5 diffs)

trunk/turbomail/api.py

@@ -10 +10 @@
 from turbomail.control import interface
 
-__all__ = ['Extension', 'ProviderFactory', 'Provider', 'Manager']
+__all__ = ['Extension', 'TransportFactory', 'Transport', 'Manager']
 
 
@@ -35 +35 @@
 
 
-class ProviderFactory(Extension):
-    """docstring for ProviderFactory"""
-    provider = None
+class TransportFactory(Extension):
+    """docstring for TransportFactory"""
+    transport = None
     
     def __init__(self):
-        super(ProviderFactory, self).__init__()
+        super(TransportFactory, self).__init__()
     
     def new(self):
         if not self.ready: return None
-        return self.provider()
+        return self.transport()
 
 
-class Provider(object):
-    """A Provider can deliver messages towards their recipients with a specific
+class Transport(object):
+    """A Transport can deliver messages towards their recipients with a specific
     method, e.g. SMTP. They don't care about delivery strategies like queing or
     batch submission."""
     
     def __init__(self):
-        super(Provider, self).__init__()
+        super(Transport, self).__init__()
     
     def deliver(self, message):
-        raise NotImplementedError, "Provider plugin must override this method without inheritance."
+        raise NotImplementedError, "Transport plugin must override this method without inheritance."
     
     
@@ -85 +85 @@
     
     def stop(self):
-        """Called by the manager before the provider instance is destroyed. The
-        provider can do some final cleanups (like releasing external resources)
+        """Called by the manager before the transport instance is destroyed. The
+        transport can do some final cleanups (like releasing external resources)
         here."""
         pass

trunk/turbomail/control.py

@@ -46 +46 @@
         self.config = dict()
         self.manager = None
-        self.provider = None
+        self.transport = None
     
     def __load_single_entry(self, group, name):
@@ -79 +79 @@
                 getattr(self, t).start()
         
-        # Load the requested manager and provider.
+        # Load the requested manager and transport.
         load('manager', 'immediate', extra_classes)
-        load('provider', 'debug', extra_classes)
+        load('transport', 'debug', extra_classes)
         
         # Load and initialize the various extensions.
@@ -116 +116 @@
                 if hasattr(ext, "stop"): ext.stop()
         
-        # Unload the provider and manager.
-        if self.provider and hasattr(self.provider, "stop"): self.provider.stop()
+        # Unload the transport and manager.
+        if self.transport and hasattr(self.transport, "stop"): self.transport.stop()
         if self.manager and hasattr(self.manager, "stop"): self.manager.stop()
         
-        self.provider = None
+        self.transport = None
         self.manager = None
         

trunk/turbomail/exceptions.py

@@ -5 +5 @@
 __version__ = "$Revision$"
 __all__ = ['MailException', 'MailNotEnabledException', 'MailConfigurationException', 
-           'ProviderException', 'ProviderExhaustedException', 'ManagerException']
+           'TransportException', 'TransportExhaustedException', 'ManagerException']
 
 
@@ -29 +29 @@
 
 
-class ProviderException(MailException):
-    """The base for all TurboMail Provider exceptions."""
+class TransportException(MailException):
+    """The base for all TurboMail Transport exceptions."""
     
     pass
 
 
-class ProviderExhaustedException(MailException):
+class TransportExhaustedException(MailException):
     """Attempted to use TurboMail before being enabled."""
     
     def __str__(self):
-        return "This Provider instance is no longer capable of delivering mail."
+        return "This Transport instance is no longer capable of delivering mail."
 
 

trunk/turbomail/managers/demand.py

@@ -10 +10 @@
 from turbomail.exceptions import *
 from turbomail.api import Manager
-from turbomail.exceptions import ProviderExhaustedException
+from turbomail.exceptions import TransportExhaustedException
 from turbomail.control import interface
 
@@ -85 +85 @@
     
     def worker(self):
-        log.debug("Requesting new provider instance from.")
-        provider = interface.provider.new()
-        if not provider: raise ManagerException, "Unable to allocate new provider."
+        log.debug("Requesting new transport instance from.")
+        transport = interface.transport.new()
+        if not transport: raise ManagerException, "Unable to allocate new transport."
         
         while True:
             try:
                 message = self.queue.get(True, self.timeout)
-                provider.deliver(message)
+                transport.deliver(message)
             
             except Empty:
@@ -98 +98 @@
                 break
             
-            except ProviderExhaustedException:
-                log.debug("Worker death from provider exhaustion - spawning child.")
+            except TransportExhaustedException:
+                log.debug("Worker death from transport exhaustion - spawning child.")
                 self.deliver(message)
                 self.spawn()

trunk/turbomail/managers/immediate.py

@@ -10 +10 @@
 from turbomail.api import Manager
 from turbomail.control import interface
-from turbomail.exceptions import ProviderExhaustedException
+from turbomail.exceptions import TransportExhaustedException
 
 __all__ = ['load']
@@ -29 +29 @@
         super(ImmediateManager, self).__init__()
         
-        self.provider = None
+        self.transport = None
         
         log.info("Immediate manager ready.")
@@ -41 +41 @@
             return False
         
-        if not self.provider:
-            log.debug("Requesting new provider instance.")
-            self.provider = interface.provider.new()
-            if not self.provider:
-                raise ManagerException, "Unable to allocate new provider."
+        if not self.transport:
+            log.debug("Requesting new transport instance.")
+            self.transport = interface.transport.new()
+            if not self.transport:
+                raise ManagerException, "Unable to allocate new transport."
         
         try:
-            self.provider.deliver(message)
+            self.transport.deliver(message)
         
-        except ProviderExhaustedException:
-            log.debug("Provider exhausted.")
-            self.provider.stop()
-            self.provider = None
+        except TransportExhaustedException:
+            log.debug("Transport exhausted.")
+            self.transport.stop()
+            self.transport = None
             self.deliver(message)
         

trunk/turbomail/message.py

@@ -96 +96 @@
         
         # TODO: This parameter should be present in a base message class
-        # smtp provider assumes that all messages have it!
+        # smtp transport assumes that all messages have it!
         self.tries = kwpop("tries", "mail.tries", 3)
         
@@ -234 +234 @@
                 headers.append(('X-TurboMail-Message-GUID', self.id))
             
-            if interface.provider:
+            if interface.transport:
                 headers.extend([
-                        ('X-TurboMail-Provider', "%s <%s>" % (interface.provider.name, interface.provider.url)),
-                        ('X-TurboMail-Provider-Version', interface.provider.version),
+                        ('X-TurboMail-Transport', "%s <%s>" % (interface.transport.name, interface.transport.url)),
+                        ('X-TurboMail-Transport-Version', interface.transport.version),
                     ])
             

trunk/turbomail/transports/debug.py

@@ -6 +6 @@
 import logging
 
-from turbomail.api import ProviderFactory, Provider
+from turbomail.api import TransportFactory, Transport
 
 
-log = logging.getLogger("turbomail.provider")
+log = logging.getLogger("turbomail.transport")
 deliverylog = logging.getLogger("turbomail.delivery")
 
@@ -16 +16 @@
 
 def load():
-    return DebugProviderFactory()
+    return DebugTransportFactory()
 
 
-class DebugProvider(Provider):
+class DebugTransport(Transport):
     def __init__(self):
-        super(DebugProvider, self).__init__()
-        log.debug("Debug provider setup.")
+        super(DebugTransport, self).__init__()
+        log.debug("Debug transport setup.")
         self._sent_mails = []
     
     def __del__(self):
         if log:
-            log.debug("Debug provider teardown.")
+            log.debug("Debug transport teardown.")
     
     def deliver(self, message):
@@ -44 +44 @@
 
 
-class DebugProviderFactory(ProviderFactory):
+class DebugTransportFactory(TransportFactory):
     name = "Debug"
     version = "1.0"
-    url = "http://www.python-turbomail.org/wiki/DebugProvider"
-    provider = DebugProvider
+    url = "http://www.python-turbomail.org/wiki/DebugTransport"
+    transport = DebugTransport
 

trunk/turbomail/transports/smtp.py

@@ -7 +7 @@
 import logging
 
-log = logging.getLogger("turbomail.provider")
+log = logging.getLogger("turbomail.transport")
 deliverylog = logging.getLogger("turbomail.delivery")
 
-from turbomail.api import ProviderFactory, Provider
-from turbomail.exceptions import MailConfigurationException, ProviderExhaustedException
+from turbomail.api import TransportFactory, Transport
+from turbomail.exceptions import MailConfigurationException, TransportExhaustedException
 from turbomail.control import interface
 
@@ -20 +20 @@
 
 def load():
-    return SMTPProviderFactory()
+    return SMTPTransportFactory()
 
 
-class SMTPProvider(Provider):
+class SMTPTransport(Transport):
     def __init__(self):
-        super(SMTPProvider, self).__init__()
-        log.debug("SMTPProvider created.")
+        super(SMTPTransport, self).__init__()
+        log.debug("SMTPTransport created.")
         
         self.server = self.config_get('mail.smtp.server', 'localhost')
@@ -76 +76 @@
         
         if self.count == 0:
-            raise ProviderExhaustedException
+            raise TransportExhaustedException
         
         try:
@@ -94 +94 @@
         
         except SMTPServerDisconnected, e:
-            raise ProviderExhaustedException
+            raise TransportExhaustedException
         
         except Exception, e:
@@ -112 +112 @@
 
 
-class SMTPProviderFactory(ProviderFactory):
+class SMTPTransportFactory(TransportFactory):
     name = "SMTP"
     version = "1.0"
-    url = "http://www.python-turbomail.org/wiki/SMTPProvider"
-    provider = SMTPProvider
+    url = "http://www.python-turbomail.org/wiki/SMTPTransport"
+    transport = SMTPTransport