Changeset 165:76a61f5aa343 for wokkel/compat.py

Timestamp:

Jan 22, 2012, 2:51:25 PM (10 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

default

Message:

Cleanups leading up to Wokkel 0.7.0.

As we now depend on Twisted 10.0.0 or higher, the following classes and
interfaces were deprecated:

• wokkel.compat.BootstrapMixin?
• wokkel.compat.XmlStreamServerFactory?
• wokkel.iwokkel.IXMPPHandler
• wokkel.iwokkel.IXMPPHandlerCollection
• wokkel.subprotocols.XMPPHandlerCollection

This also resolves all Pyflakes warnings, changes links for www.xmpp.org to
xmpp.org and fixes the copyright notice in LICENSE to include 2012.

File:

• wokkel/compat.py (modified) (8 diffs)

wokkel/compat.py

@@ -13 +13 @@
 from itertools import count
 
-from twisted.internet import protocol
+from twisted.python.deprecate import deprecatedModuleAttribute
+from twisted.python.versions import Version
 from twisted.words.protocols.jabber import xmlstream
-
-class BootstrapMixin(object):
-    """
-    XmlStream factory mixin to install bootstrap event observers.
-
-    This mixin is for factories providing
-    L{IProtocolFactory<twisted.internet.interfaces.IProtocolFactory>} to make
-    sure bootstrap event observers are set up on protocols, before incoming
-    data is processed. Such protocols typically derive from
-    L{utility.EventDispatcher}, like L{XmlStream}.
-
-    You can set up bootstrap event observers using C{addBootstrap}. The
-    C{event} and C{fn} parameters correspond with the C{event} and
-    C{observerfn} arguments to L{utility.EventDispatcher.addObserver}.
-
-    @since: 8.2.
-    @ivar bootstraps: The list of registered bootstrap event observers.
-    @type bootstrap: C{list}
-    """
-
-    def __init__(self):
-        self.bootstraps = []
-
-
-    def installBootstraps(self, dispatcher):
-        """
-        Install registered bootstrap observers.
-
-        @param dispatcher: Event dispatcher to add the observers to.
-        @type dispatcher: L{utility.EventDispatcher}
-        """
-        for event, fn in self.bootstraps:
-            dispatcher.addObserver(event, fn)
-
-
-    def addBootstrap(self, event, fn):
-        """
-        Add a bootstrap event handler.
-
-        @param event: The event to register an observer for.
-        @type event: C{str} or L{xpath.XPathQuery}
-        @param fn: The observer callable to be registered.
-        """
-        self.bootstraps.append((event, fn))
-
-
-    def removeBootstrap(self, event, fn):
-        """
-        Remove a bootstrap event handler.
-
-        @param event: The event the observer is registered for.
-        @type event: C{str} or L{xpath.XPathQuery}
-        @param fn: The registered observer callable.
-        """
-        self.bootstraps.remove((event, fn))
-
-
-
-class XmlStreamServerFactory(BootstrapMixin,
-                             protocol.ServerFactory):
-    """
-    Factory for Jabber XmlStream objects as a server.
-
-    @since: 8.2.
-    @ivar authenticatorFactory: Factory callable that takes no arguments, to
-                                create a fresh authenticator to be associated
-                                with the XmlStream.
-    """
-
-    protocol = xmlstream.XmlStream
-
-    def __init__(self, authenticatorFactory):
-        BootstrapMixin.__init__(self)
-        self.authenticatorFactory = authenticatorFactory
-
-
-    def buildProtocol(self, addr):
-        """
-        Create an instance of XmlStream.
-
-        A new authenticator instance will be created and passed to the new
-        XmlStream. Registered bootstrap event observers are installed as well.
-        """
-        authenticator = self.authenticatorFactory()
-        xs = self.protocol(authenticator)
-        xs.factory = self
-        self.installBootstraps(xs)
-        return xs
-
-
+from twisted.words.protocols.jabber.xmlstream import XmlStreamServerFactory
+from twisted.words.xish.xmlstream import BootstrapMixin
+
+deprecatedModuleAttribute(
+        Version("Wokkel", 0, 7, 0),
+        "Use twisted.words.xish.xmlstream.BootstrapMixin instead.",
+        __name__,
+        "BootstrapMixin")
+
+deprecatedModuleAttribute(
+        Version("Wokkel", 0, 7, 0),
+        "Use twisted.words.protocols.jabber.xmlstream.XmlStreamServerFactory "
+                "instead.",
+        __name__,
+        "XmlStreamServerFactory")
 
 class IQ(xmlstream.IQ):
@@ -142 +68 @@
     @ivar _container: The L{_ConstantsContainer} subclass this constant belongs
         to; only set once the constant is initialized by that subclass.
+
+    @since: Twisted 12.0.0.
     """
     def __init__(self):
@@ -185 +113 @@
     objects representing named constants for a particular L{_ConstantsContainer}
     subclass.
+
+    @since: Twisted 12.0.0.
     """
     def __get__(self, oself, cls):
@@ -212 +142 @@
         instances.  This is initialized via the L{_EnumerantsInitializer}
         descriptor the first time it is accessed.
+
+    @since: Twisted 12.0.0.
     """
     _constantType = None
@@ -308 +240 @@
     subclasses.  Do not instantiate L{NamedConstant} elsewhere and do not
     subclass it.
+
+    @since: Twisted 12.0.0.
     """
 
@@ -316 +250 @@
     A L{Names} subclass contains constants which differ only in their names and
     identities.
+
+    @since: Twisted 12.0.0.
     """
     _constantType = NamedConstant
@@ -328 +264 @@
     L{ValueConstant} is only for use in the definition of L{Values} subclasses.
     Do not instantiate L{ValueConstant} elsewhere and do not subclass it.
+
+    @since: Twisted 12.0.0.
     """
     def __init__(self, value):
@@ -339 +277 @@
     A L{Values} subclass contains constants which are associated with arbitrary
     values.
+
+    @since: Twisted 12.0.0.
     """
     _constantType = ValueConstant