Changeset 171:4f5ee7b81ebf for wokkel

Timestamp:

May 9, 2012, 2:24:28 PM (10 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

default

Message:

Add convenience method Request.parseRequest.

The new method Request.parseRequest is called from Request.fromElement
with the child element of the iq that is passed to fromElement, providing
a convenient hook for parsing the payload of incoming requests.

Location:

wokkel

Files:

• generic.py (modified) (5 diffs)
• test/test_generic.py (modified) (2 diffs)

wokkel/generic.py

@@ -184 +184 @@
     @classmethod
     def fromElement(Class, element):
+        """
+        Create a stanza from a L{domish.Element}.
+        """
         stanza = Class()
         stanza.parseElement(element)
@@ -190 +193 @@
 
     def parseElement(self, element):
+        """
+        Parse the stanza element.
+
+        This is called with the stanza's element when a L{Stanza} is
+        created using L{fromElement}. It parses the stanza's core attributes
+        (addressing, type and id), strips the namespace from the stanza
+        element for easier transport across streams and passes on
+        child elements for further parsing.
+
+        Child element parsers are defined by providing a C{childParsers}
+        attribute on a subclass, as a mapping from (URI, name) to the name
+        of the handler on C{self}. C{parseElement} will accumulate
+        C{childParsers} from its class hierarchy, iterate over the child
+        elements and pass it to matching handlers based on the child element's
+        URI and name. The special key of C{None} can be used to pass all
+        child elements to.
+        """
         if element.hasAttribute('from'):
             self.sender = jid.internJID(element['from'])
@@ -209 +229 @@
                 handler = handlers[child.uri, child.name]
             except KeyError:
-                pass
-            else:
-                getattr(self, handler)(child)
+                try:
+                    handler = handlers[None]
+                except KeyError:
+                    continue
+
+            getattr(self, handler)(child)
 
 
@@ -235 +258 @@
 
 
+
 class Request(Stanza):
     """
@@ -247 +271 @@
     timeout = None
 
+    childParsers = {None: 'parseRequest'}
+
     def __init__(self, recipient=None, sender=None, stanzaType='get'):
         Stanza.__init__(self, recipient=recipient, sender=sender)
         self.stanzaType = stanzaType
+
+
+    def parseRequest(self, element):
+        """
+        Called with the request's child element for parsing.
+
+        When a request instance is created using L{fromElement}, this method
+        is called with the child element of the iq. Override this method for
+        parsing the request's payload.
+        """
 
 

wokkel/test/test_generic.py

@@ -91 +91 @@
 
 
+class StanzaTest(unittest.TestCase):
+    """
+    Tests for L{generic.Stanza}.
+    """
+
+    def test_fromElement(self):
+        xml = """
+        <message type='chat' from='other@example.org' to='user@example.org'/>
+        """
+
+        stanza = generic.Stanza.fromElement(generic.parseXml(xml))
+        self.assertEqual('chat', stanza.stanzaType)
+        self.assertEqual(JID('other@example.org'), stanza.sender)
+        self.assertEqual(JID('user@example.org'), stanza.recipient)
+
+
+    def test_fromElementChildParser(self):
+        """
+        Child elements for which no parser is defined are ignored.
+        """
+        xml = """
+        <message from='other@example.org' to='user@example.org'>
+          <x xmlns='http://example.org/'/>
+        </message>
+        """
+
+        class Message(generic.Stanza):
+            childParsers = {('http://example.org/', 'x'): '_childParser_x'}
+            elements = []
+
+            def _childParser_x(self, element):
+                self.elements.append(element)
+
+        message = Message.fromElement(generic.parseXml(xml))
+        self.assertEqual(1, len(message.elements))
+
+
+    def test_fromElementChildParserAll(self):
+        """
+        Child elements for which no parser is defined are ignored.
+        """
+        xml = """
+        <message from='other@example.org' to='user@example.org'>
+          <x xmlns='http://example.org/'/>
+        </message>
+        """
+
+        class Message(generic.Stanza):
+            childParsers = {None: '_childParser'}
+            elements = []
+
+            def _childParser(self, element):
+                self.elements.append(element)
+
+        message = Message.fromElement(generic.parseXml(xml))
+        self.assertEqual(1, len(message.elements))
+
+
+    def test_fromElementChildParserUnknown(self):
+        """
+        Child elements for which no parser is defined are ignored.
+        """
+        xml = """
+        <message from='other@example.org' to='user@example.org'>
+          <x xmlns='http://example.org/'/>
+        </message>
+        """
+        generic.Stanza.fromElement(generic.parseXml(xml))
+
+
+
+
 class RequestTest(unittest.TestCase):
     """
@@ -100 +172 @@
 
 
+    def test_requestParser(self):
+        """
+        The request's child element is passed to requestParser.
+        """
+        xml = """
+        <iq type='get'>
+          <query xmlns='jabber:iq:version'/>
+        </iq>
+        """
+
+        class VersionRequest(generic.Request):
+            elements = []
+
+            def parseRequest(self, element):
+                self.elements.append((element.uri, element.name))
+
+        request = VersionRequest.fromElement(generic.parseXml(xml))
+        self.assertEqual([(NS_VERSION, 'query')], request.elements)
+
+
     def test_toElementStanzaKind(self):
         """