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.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.
|
||||
"""
|
||||
|
||||
Reference in New Issue
Block a user