sleekxmpp/xmlstream/matcher/base.py

   1 # -*- coding: utf-8 -*-
   2 """
   3     sleekxmpp.xmlstream.matcher.base
   4     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   5
   6     Part of SleekXMPP: The Sleek XMPP Library
   7
   8     :copyright: (c) 2011 Nathanael C. Fritz
   9     :license: MIT, see LICENSE for more details
  10 """
  11
  12
  13 class MatcherBase(object):
  14
  15     """
  16     Base class for stanza matchers. Stanza matchers are used to pick
  17     stanzas out of the XML stream and pass them to the appropriate
  18     stream handlers.
  19
  20     :param criteria: Object to compare some aspect of a stanza against.
  21     """
  22
  23     def __init__(self, criteria):
  24         self._criteria = criteria
  25
  26     def match(self, xml):
  27         """Check if a stanza matches the stored criteria.
  28
  29         Meant to be overridden.
  30         """
  31         return False