core/event.py

   1 # synarere -- a highly modular and stable IRC bot.
   2 # Copyright (C) 2010 Michael Rodriguez.
   3 # Rights to this code are documented in docs/LICENSE.
   4
   5 '''Event system for non-IRC events.'''
   6
   7 # Import required core module.
   8 import logger
   9
  10 # Event data.
  11 events = {}
  12
  13 def dispatch(name, *args):
  14     '''Dispatch the event.'''
  15
  16     global events
  17
  18     # Call every function attached to 'name'.
  19     try:
  20         for func in events[name]['funcs']:
  21             func(*args)
  22     except KeyError:
  23         pass
  24
  25 def attach(event, func):
  26     '''Add a function to an event.'''
  27
  28     global events
  29
  30     try:
  31         test = events[event]
  32     except KeyError:
  33         events[event] = { 'funcs' : [] }
  34
  35     if func in events[event]['funcs']:
  36         return True
  37
  38     events[event]['funcs'].append(func)
  39     return True
  40
  41     logger.debug('attach(): attached event %s to %s' % (event, func))
  42
  43 def detach(event, func):
  44     '''Remove a function from an event.'''
  45
  46     global events
  47
  48     if func not in events[event]['funcs']:
  49         return False
  50
  51     events[event]['funcs'].remove(func)
  52
  53     logger.debug('detach(): detached event %s from %s' % (event, func))