From 2f6f4fc16d81fd01bc5a4569e0a1bc4ede4a3af8 Mon Sep 17 00:00:00 2001
From: Lance Stout <lancestout@gmail.com>
Date: Fri, 13 Aug 2010 21:33:11 -0400
Subject: Updated ElementBase.__getitem__ with docs and unit tests.

---
 sleekxmpp/xmlstream/stanzabase.py | 59 ++++++++++++++++++++++++++++-----------
 1 file changed, 42 insertions(+), 17 deletions(-)

(limited to 'sleekxmpp')

diff --git a/sleekxmpp/xmlstream/stanzabase.py b/sleekxmpp/xmlstream/stanzabase.py
index 3e280d61..962cf8ed 100644
--- a/sleekxmpp/xmlstream/stanzabase.py
+++ b/sleekxmpp/xmlstream/stanzabase.py
@@ -183,6 +183,48 @@ class ElementBase(object):
                 self.plugins[interface].setStanzaValues(value)
         return self
 
+    def __getitem__(self, attrib):
+        """
+        Return the value of a stanza interface using dictionary-like syntax.
+
+        Example:
+            >>> msg['body']
+            'Message contents'
+
+        Stanza interfaces are typically mapped directly to the underlying XML
+        object, but can be overridden by the presence of a getAttrib method
+        (or getFoo where the interface is named foo, etc).
+
+        The search order for interface value retrieval for an interface
+        named 'foo' is:
+            1. The list of substanzas.
+            2. The result of calling getFoo.
+            3. The contents of the foo subelement, if foo is a sub interface.
+            4. The value of the foo attribute of the XML object.
+            5. The plugin named 'foo'
+            6. An empty string.
+
+        Arguments:
+            attrib -- The name of the requested stanza interface.
+        """
+        if attrib == 'substanzas':
+            return self.iterables
+        elif attrib in self.interfaces:
+            get_method = "get%s" % attrib.title()
+            if hasattr(self, get_method):
+                return getattr(self, get_method)()
+            else:
+                if attrib in self.sub_interfaces:
+                    return self._getSubText(attrib)
+                else:
+                    return self._getAttr(attrib)
+        elif attrib in self.plugin_attrib_map:
+            if attrib not in self.plugins:
+                self.initPlugin(attrib)
+            return self.plugins[attrib]
+        else:
+            return ''
+
     @property
     def attrib(self): #backwards compatibility
             return self
@@ -266,23 +308,6 @@ class ElementBase(object):
     def findall(self, xpath):
             return self.xml.findall(xpath)
 
-    def __getitem__(self, attrib):
-            if attrib == 'substanzas':
-                    return self.iterables
-            elif attrib in self.interfaces:
-                    if hasattr(self, "get%s" % attrib.title()):
-                            return getattr(self, "get%s" % attrib.title())()
-                    else:
-                            if attrib in self.sub_interfaces:
-                                    return self._getSubText(attrib)
-                            else:
-                                    return self._getAttr(attrib)
-            elif attrib in self.plugin_attrib_map:
-                    if attrib not in self.plugins: self.initPlugin(attrib)
-                    return self.plugins[attrib]
-            else:
-                    return ''
-
     def __setitem__(self, attrib, value):
             if attrib in self.interfaces:
                     if value is not None:
-- 
cgit v1.2.3