diff options
author | Lance Stout <lancestout@gmail.com> | 2011-12-04 16:26:14 -0800 |
---|---|---|
committer | Lance Stout <lancestout@gmail.com> | 2011-12-04 16:26:14 -0800 |
commit | 2586fdffda9dac5ee56664c74e71bd54ae47ee18 (patch) | |
tree | 8c3eff0ed8ed6539b7eace355a90e8ede9634d0a /sleekxmpp/xmlstream/matcher/base.py | |
parent | c9dc9ec11e8ef141234d8376fe8882ae13babbf8 (diff) | |
download | slixmpp-2586fdffda9dac5ee56664c74e71bd54ae47ee18.tar.gz slixmpp-2586fdffda9dac5ee56664c74e71bd54ae47ee18.tar.bz2 slixmpp-2586fdffda9dac5ee56664c74e71bd54ae47ee18.tar.xz slixmpp-2586fdffda9dac5ee56664c74e71bd54ae47ee18.zip |
Update api docs for handlers and matchers
Diffstat (limited to 'sleekxmpp/xmlstream/matcher/base.py')
-rw-r--r-- | sleekxmpp/xmlstream/matcher/base.py | 23 |
1 files changed, 10 insertions, 13 deletions
diff --git a/sleekxmpp/xmlstream/matcher/base.py b/sleekxmpp/xmlstream/matcher/base.py index 701ab32f..83c26688 100644 --- a/sleekxmpp/xmlstream/matcher/base.py +++ b/sleekxmpp/xmlstream/matcher/base.py @@ -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.base + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - 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 """ @@ -13,21 +16,15 @@ class MatcherBase(object): Base class for stanza matchers. Stanza matchers are used to pick stanzas out of the XML stream and pass them to the appropriate stream handlers. + + :param criteria: Object to compare some aspect of a stanza against. """ def __init__(self, criteria): - """ - Create a new stanza matcher. - - Arguments: - criteria -- Object to compare some aspect of a stanza - against. - """ self._criteria = criteria def match(self, xml): - """ - Check if a stanza matches the stored criteria. + """Check if a stanza matches the stored criteria. Meant to be overridden. """ |