diff options
author | Lance Stout <lancestout@gmail.com> | 2010-09-01 14:28:43 -0400 |
---|---|---|
committer | Lance Stout <lancestout@gmail.com> | 2010-09-01 14:28:43 -0400 |
commit | 5c3066ba305c25bd1d9d8e262f3a119ed434bd72 (patch) | |
tree | da321146b1563d05263ab21f80d28cc6479a064f /sleekxmpp/xmlstream/matcher/stanzapath.py | |
parent | 576eefb09740959a1d4307010e42880acdc1954a (diff) | |
download | slixmpp-5c3066ba305c25bd1d9d8e262f3a119ed434bd72.tar.gz slixmpp-5c3066ba305c25bd1d9d8e262f3a119ed434bd72.tar.bz2 slixmpp-5c3066ba305c25bd1d9d8e262f3a119ed434bd72.tar.xz slixmpp-5c3066ba305c25bd1d9d8e262f3a119ed434bd72.zip |
Updated all of the matcher classes in sleekxmpp.xmlstream.matcher.
Matchers are now PEP8 compliant and have documentation.
Diffstat (limited to 'sleekxmpp/xmlstream/matcher/stanzapath.py')
-rw-r--r-- | sleekxmpp/xmlstream/matcher/stanzapath.py | 34 |
1 files changed, 29 insertions, 5 deletions
diff --git a/sleekxmpp/xmlstream/matcher/stanzapath.py b/sleekxmpp/xmlstream/matcher/stanzapath.py index e315445d..f8ff283d 100644 --- a/sleekxmpp/xmlstream/matcher/stanzapath.py +++ b/sleekxmpp/xmlstream/matcher/stanzapath.py @@ -5,10 +5,34 @@ See the file LICENSE for copying permission. """ -from . import base -from xml.etree import cElementTree -class StanzaPath(base.MatcherBase): +from sleekxmpp.xmlstream.matcher.base import MatcherBase - def match(self, stanza): - return stanza.match(self._criteria) + +class StanzaPath(MatcherBase): + + """ + The StanzaPath matcher selects stanzas that match a given "stanza path", + which is similar to a normal XPath except that it uses the interfaces and + plugins of the stanza instead of the actual, underlying XML. + + In most cases, the stanza path and XPath should be identical, but be + aware that differences may occur. + + Methods: + match -- Overrides MatcherBase.match. + """ + + def match(self, stanza): + """ + Compare a stanza against a "stanza path". A stanza path is similar to + an XPath expression, but uses the stanza's interfaces and plugins + instead of the underlying XML. For most cases, the stanza path and + XPath should be identical, but be aware that differences may occur. + + Overrides MatcherBase.match. + + Arguments: + stanza -- The stanza object to compare against. + """ + return stanza.match(self._criteria) |