Update api docs for handlers and matchers
This commit is contained in:
@@ -1,9 +1,12 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
"""
|
||||
SleekXMPP: The Sleek XMPP Library
|
||||
Copyright (C) 2010 Nathanael C. Fritz
|
||||
This file is part of SleekXMPP.
|
||||
sleekxmpp.xmlstream.matcher.stanzapath
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
See the file LICENSE for copying permission.
|
||||
Part of SleekXMPP: The Sleek XMPP Library
|
||||
|
||||
:copyright: (c) 2011 Nathanael C. Fritz
|
||||
:license: MIT, see LICENSE for more details
|
||||
"""
|
||||
|
||||
from sleekxmpp.xmlstream.matcher.base import MatcherBase
|
||||
@@ -15,24 +18,17 @@ 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.
|
||||
instead of the underlying XML. See the documentation for the stanza
|
||||
:meth:`~sleekxmpp.xmlstream.stanzabase.ElementBase.match()` method
|
||||
for more information.
|
||||
|
||||
Overrides MatcherBase.match.
|
||||
|
||||
Arguments:
|
||||
stanza -- The stanza object to compare against.
|
||||
:param stanza: The :class:`~sleekxmpp.xmlstream.stanzabase.ElementBase`
|
||||
stanza to compare against.
|
||||
"""
|
||||
return stanza.match(self._criteria)
|
||||
|
||||
Reference in New Issue
Block a user