traipse: orpg/tools/pubsub.py annotate

annotate orpg/tools/pubsub.py @ 39:ed322725b928 ornery-orc tip

Traipse 'OpenRPG' {110114-00} Traipse is a distribution of OpenRPG that is designed to be easy to setup and go. Traipse also makes it easy for developers to work on code without fear of sacrifice. 'Ornery-Orc' continues the trend of 'Grumpy' and adds fixes to the code. 'Ornery-Orc's main goal is to offer more advanced features and enhance the productivity of the user. Update Summary (Closed) New Features: New to Map, can re-order Grid, Miniatures, and Whiteboard layer draw order New to Server GUI, can now clear log New Earthdawn Dieroller New IronClaw roller, sheet, and image New ShapeShifter PC Sheet Updates: Update to Warhammer PC Sheet. Rollers set as macros. Should work with little maintanence. Update to Browser Server window. Display rooms with ' " & cleaner Update to Server. Handles ' " & cleaner Update to Dieroller. Cleaner, more effecient expression system Update to Hidden Die plugin, allows for non standard dice rolls Update to location.py, allows for more portable references when starting Traipse Update to the Features node Fixes: Fix to InterParse that was causing an Infernal Loop with Namespace Internal Fix to XML data, removed old Minidom and switched to Element Tree Fix to Server that was causing eternal attempt to find a Server ID, in Register Rooms thread Fix to Server, removing wxPython dependencies where not needed Fix to metaservers.xml file not being created Fix to Single and Double quotes in Whiteboard text Fix to Background images not showing when using the Image Server Fix to Duplicate chat names appearing Fix to Server GUI's logging output Fix to FNB.COLORFUL_TABS bug Fix to Gametree for XSLT Sheets Fix to Gametree for locating gametree files Fix to Send to Chat from Gametree Fix to Gametree, renaming and remapping operates correctly Fix to aliaslib, prevents error caused when SafeHTML is sent None

author	sirebral
date	Fri, 14 Jan 2011 05:24:52 -0600
parents	ff154cf3350c
children

rev	line source
0 4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	1
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	2 #---------------------------------------------------------------------------
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	3 """
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	4 This module provides a publish-subscribe component that allows
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	5 listeners to subcribe to messages of a given topic. Contrary to the
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	6 original wxPython.lib.pubsub module (which it is based on), it uses
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	7 weak referencing to the subscribers so the lifetime of subscribers
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	8 is not affected by Publisher. Also, callable objects can be used in
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	9 addition to functions and bound methods. See Publisher class docs for
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	10 more details.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	11
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	12 Thanks to Robb Shecter and Robin Dunn for having provided
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	13 the basis for this module (which now shares most of the concepts but
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	14 very little design or implementation with the original
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	15 wxPython.lib.pubsub).
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	16
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	17 The publisher is a singleton instance of the PublisherClass class. You
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	18 access the instance via the Publisher object available from the module::
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	19
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	20 from wx.lib.pubsub import Publisher
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	21 Publisher().subscribe(...)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	22 Publisher().sendMessage(...)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	23 ...
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	24
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	25 :Author: Oliver Schoenborn
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	26 :Since: Apr 2004
28 ff154cf3350c Traipse 'OpenRPG' {100203-00} sirebral parents: 0 diff changeset	27 :Version: $Id: pubsub.py,v Traipse 'Ornery-Orc' prof.ebral Exp $
0 4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	28 :Copyright: \(c) 2004 Oliver Schoenborn
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	29 :License: wxWidgets
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	30 """
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	31
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	32 _implNotes = """
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	33 Implementation notes
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	34 --------------------
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	35
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	36 In class Publisher, I represent the topics-listener set as a tree
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	37 where each node is a topic, and contains a list of listeners of that
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	38 topic, and a dictionary of subtopics of that topic. When the Publisher
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	39 is told to send a message for a given topic, it traverses the tree
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	40 down to the topic for which a message is being generated, all
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	41 listeners on the way get sent the message.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	42
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	43 Publisher currently uses a weak listener topic tree to store the
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	44 topics for each listener, and if a listener dies before being
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	45 unsubscribed, the tree is notified, and the tree eliminates the
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	46 listener from itself.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	47
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	48 Ideally, _TopicTreeNode would be a generic _TreeNode with named
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	49 subnodes, and _TopicTreeRoot would be a generic _Tree with named
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	50 nodes, and Publisher would store listeners in each node and a topic
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	51 tuple would be converted to a path in the tree. This would lead to a
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	52 much cleaner separation of concerns. But time is over, time to move on.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	53 """
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	54 #---------------------------------------------------------------------------
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	55
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	56 # for function and method parameter counting:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	57 from types import InstanceType
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	58 from inspect import getargspec, ismethod, isfunction
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	59 # for weakly bound methods:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	60 from new import instancemethod as InstanceMethod
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	61 from weakref import ref as WeakRef
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	62
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	63 # -----------------------------------------------------------------------------
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	64
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	65 def _isbound(method):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	66 """Return true if method is a bound method, false otherwise"""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	67 assert ismethod(method)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	68 return method.im_self is not None
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	69
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	70
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	71 def _paramMinCountFunc(function):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	72 """Given a function, return pair (min,d) where min is minimum # of
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	73 args required, and d is number of default arguments."""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	74 assert isfunction(function)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	75 (args, va, kwa, dflt) = getargspec(function)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	76 lenDef = len(dflt or ())
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	77 lenArgs = len(args or ())
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	78 lenVA = int(va is not None)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	79 return (lenArgs - lenDef + lenVA, lenDef)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	80
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	81
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	82 def _paramMinCount(callableObject):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	83 """
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	84 Given a callable object (function, method or callable instance),
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	85 return pair (min,d) where min is minimum # of args required, and d
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	86 is number of default arguments. The 'self' parameter, in the case
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	87 of methods, is not counted.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	88 """
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	89 if type(callableObject) is InstanceType:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	90 min, d = _paramMinCountFunc(callableObject.__call__.im_func)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	91 return min-1, d
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	92 elif ismethod(callableObject):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	93 min, d = _paramMinCountFunc(callableObject.im_func)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	94 return min-1, d
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	95 elif isfunction(callableObject):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	96 return _paramMinCountFunc(callableObject)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	97 else:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	98 raise 'Cannot determine type of callable: '+repr(callableObject)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	99
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	100
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	101 def _tupleize(items):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	102 """Convert items to tuple if not already one,
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	103 so items must be a list, tuple or non-sequence"""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	104 if isinstance(items, list):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	105 raise TypeError, 'Not allowed to tuple-ize a list'
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	106 elif isinstance(items, (str, unicode)) and items.find('.') != -1:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	107 items = tuple(items.split('.'))
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	108 elif not isinstance(items, tuple):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	109 items = (items,)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	110 return items
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	111
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	112
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	113 def _getCallableName(callable):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	114 """Get name for a callable, ie function, bound
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	115 method or callable instance"""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	116 if ismethod(callable):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	117 return '%s.%s ' % (callable.im_self, callable.im_func.func_name)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	118 elif isfunction(callable):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	119 return '%s ' % callable.__name__
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	120 else:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	121 return '%s ' % callable
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	122
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	123
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	124 def _removeItem(item, fromList):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	125 """Attempt to remove item from fromList, return true
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	126 if successful, false otherwise."""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	127 try:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	128 fromList.remove(item)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	129 return True
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	130 except ValueError:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	131 return False
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	132
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	133
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	134 # -----------------------------------------------------------------------------
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	135
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	136 class _WeakMethod:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	137 """Represent a weak bound method, i.e. a method doesn't keep alive the
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	138 object that it is bound to. It uses WeakRef which, used on its own,
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	139 produces weak methods that are dead on creation, not very useful.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	140 Typically, you will use the getRef() function instead of using
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	141 this class directly. """
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	142
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	143 def __init__(self, method, notifyDead = None):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	144 """The method must be bound. notifyDead will be called when
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	145 object that method is bound to dies. """
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	146 assert ismethod(method)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	147 if method.im_self is None:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	148 raise ValueError, "We need a bound method!"
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	149 if notifyDead is None:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	150 self.objRef = WeakRef(method.im_self)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	151 else:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	152 self.objRef = WeakRef(method.im_self, notifyDead)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	153 self.fun = method.im_func
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	154 self.cls = method.im_class
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	155
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	156 def __call__(self):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	157 """Returns a new.instancemethod if object for method still alive.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	158 Otherwise return None. Note that instancemethod causes a
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	159 strong reference to object to be created, so shouldn't save
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	160 the return value of this call. Note also that this __call__
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	161 is required only for compatibility with WeakRef.ref(), otherwise
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	162 there would be more efficient ways of providing this functionality."""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	163 if self.objRef() is None:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	164 return None
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	165 else:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	166 return InstanceMethod(self.fun, self.objRef(), self.cls)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	167
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	168 def __eq__(self, method2):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	169 """Two WeakMethod objects compare equal if they refer to the same method
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	170 of the same instance. Thanks to Josiah Carlson for patch and clarifications
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	171 on how dict uses eq/cmp and hashing. """
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	172 if not isinstance(method2, _WeakMethod):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	173 return False
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	174 return self.fun is method2.fun \
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	175 and self.objRef() is method2.objRef() \
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	176 and self.objRef() is not None
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	177
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	178 def __hash__(self):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	179 """Hash is an optimization for dict searches, it need not
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	180 return different numbers for every different object. Some objects
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	181 are not hashable (eg objects of classes derived from dict) so no
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	182 hash(objRef()) in there, and hash(self.cls) would only be useful
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	183 in the rare case where instance method was rebound. """
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	184 return hash(self.fun)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	185
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	186 def __repr__(self):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	187 dead = ''
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	188 if self.objRef() is None:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	189 dead = '; DEAD'
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	190 obj = '<%s at %s%s>' % (self.__class__, id(self), dead)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	191 return obj
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	192
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	193 def refs(self, weakRef):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	194 """Return true if we are storing same object referred to by weakRef."""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	195 return self.objRef == weakRef
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	196
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	197
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	198 def _getWeakRef(obj, notifyDead=None):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	199 """Get a weak reference to obj. If obj is a bound method, a _WeakMethod
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	200 object, that behaves like a WeakRef, is returned, if it is
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	201 anything else a WeakRef is returned. If obj is an unbound method,
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	202 a ValueError will be raised."""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	203 if ismethod(obj):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	204 createRef = _WeakMethod
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	205 else:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	206 createRef = WeakRef
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	207
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	208 if notifyDead is None:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	209 return createRef(obj)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	210 else:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	211 return createRef(obj, notifyDead)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	212
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	213
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	214 # -----------------------------------------------------------------------------
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	215
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	216 def getStrAllTopics():
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	217 """Function to call if, for whatever reason, you need to know
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	218 explicitely what is the string to use to indicate 'all topics'."""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	219 return ''
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	220
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	221
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	222 # alias, easier to see where used
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	223 ALL_TOPICS = getStrAllTopics()
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	224
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	225 # -----------------------------------------------------------------------------
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	226
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	227
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	228 class _NodeCallback:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	229 """Encapsulate a weak reference to a method of a TopicTreeNode
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	230 in such a way that the method can be called, if the node is
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	231 still alive, but the callback does not keep the node alive.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	232 Also, define two methods, preNotify() and noNotify(), which can
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	233 be redefined to something else, very useful for testing.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	234 """
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	235
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	236 def __init__(self, obj):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	237 self.objRef = _getWeakRef(obj)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	238
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	239 def __call__(self, weakCB):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	240 notify = self.objRef()
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	241 if notify is not None:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	242 self.preNotify(weakCB)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	243 notify(weakCB)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	244 else:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	245 self.noNotify()
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	246
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	247 def preNotify(self, dead):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	248 """'Gets called just before our callback (self.objRef) is called"""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	249 pass
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	250
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	251 def noNotify(self):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	252 """Gets called if the TopicTreeNode for this callback is dead"""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	253 pass
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	254
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	255
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	256 class _TopicTreeNode:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	257 """A node in the topic tree. This contains a list of callables
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	258 that are interested in the topic that this node is associated
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	259 with, and contains a dictionary of subtopics, whose associated
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	260 values are other _TopicTreeNodes. The topic of a node is not stored
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	261 in the node, so that the tree can be implemented as a dictionary
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	262 rather than a list, for ease of use (and, likely, performance).
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	263
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	264 Note that it uses _NodeCallback to encapsulate a callback for
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	265 when a registered listener dies, possible thanks to WeakRef.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	266 Whenever this callback is called, the onDeadListener() function,
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	267 passed in at construction time, is called (unless it is None).
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	268 """
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	269
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	270 def __init__(self, topicPath, onDeadListenerWeakCB):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	271 self.__subtopics = {}
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	272 self.__callables = []
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	273 self.__topicPath = topicPath
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	274 self.__onDeadListenerWeakCB = onDeadListenerWeakCB
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	275
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	276 def getPathname(self):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	277 """The complete node path to us, ie., the topic tuple that would lead to us"""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	278 return self.__topicPath
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	279
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	280 def createSubtopic(self, subtopic, topicPath):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	281 """Create a child node for subtopic"""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	282 return self.__subtopics.setdefault(subtopic,
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	283 _TopicTreeNode(topicPath, self.__onDeadListenerWeakCB))
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	284
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	285 def hasSubtopic(self, subtopic):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	286 """Return true only if topic string is one of subtopics of this node"""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	287 return self.__subtopics.has_key(subtopic)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	288
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	289 def getNode(self, subtopic):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	290 """Return ref to node associated with subtopic"""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	291 return self.__subtopics[subtopic]
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	292
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	293 def addCallable(self, callable):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	294 """Add a callable to list of callables for this topic node"""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	295 try:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	296 id = self.__callables.index(_getWeakRef(callable))
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	297 return self.__callables[id]
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	298 except ValueError:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	299 wrCall = _getWeakRef(callable, _NodeCallback(self.__notifyDead))
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	300 self.__callables.append(wrCall)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	301 return wrCall
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	302
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	303 def getCallables(self):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	304 """Get callables associated with this topic node"""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	305 return [cb() for cb in self.__callables if cb() is not None]
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	306
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	307 def hasCallable(self, callable):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	308 """Return true if callable in this node"""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	309 try:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	310 self.__callables.index(_getWeakRef(callable))
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	311 return True
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	312 except ValueError:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	313 return False
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	314
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	315 def sendMessage(self, message):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	316 """Send a message to our callables"""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	317 deliveryCount = 0
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	318 for cb in self.__callables:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	319 listener = cb()
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	320 if listener is not None:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	321 listener(message)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	322 deliveryCount += 1
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	323 return deliveryCount
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	324
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	325 def removeCallable(self, callable):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	326 """Remove weak callable from our node (and return True).
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	327 Does nothing if not here (and returns False)."""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	328 try:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	329 self.__callables.remove(_getWeakRef(callable))
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	330 return True
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	331 except ValueError:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	332 return False
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	333
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	334 def clearCallables(self):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	335 """Abandon list of callables to caller. We no longer have
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	336 any callables after this method is called."""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	337 tmpList = [cb for cb in self.__callables if cb() is not None]
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	338 self.__callables = []
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	339 return tmpList
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	340
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	341 def __notifyDead(self, dead):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	342 """Gets called when a listener dies, thanks to WeakRef"""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	343 #print 'TreeNODE', `self`, 'received death certificate for ', dead
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	344 self.__cleanupDead()
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	345 if self.__onDeadListenerWeakCB is not None:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	346 cb = self.__onDeadListenerWeakCB()
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	347 if cb is not None:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	348 cb(dead)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	349
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	350 def __cleanupDead(self):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	351 """Remove all dead objects from list of callables"""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	352 self.__callables = [cb for cb in self.__callables if cb() is not None]
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	353
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	354 def __str__(self):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	355 """Print us in a not-so-friendly, but readable way, good for debugging."""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	356 strVal = []
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	357 for callable in self.getCallables():
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	358 strVal.append(_getCallableName(callable))
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	359 for topic, node in self.__subtopics.iteritems():
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	360 strVal.append(' (%s: %s)' %(topic, node))
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	361 return ''.join(strVal)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	362
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	363
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	364 class _TopicTreeRoot(_TopicTreeNode):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	365 """
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	366 The root of the tree knows how to access other node of the
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	367 tree and is the gateway of the tree user to the tree nodes.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	368 It can create topics, and and remove callbacks, etc.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	369
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	370 For efficiency, it stores a dictionary of listener-topics,
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	371 so that unsubscribing a listener just requires finding the
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	372 topics associated to a listener, and finding the corresponding
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	373 nodes of the tree. Without it, unsubscribing would require
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	374 that we search the whole tree for all nodes that contain
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	375 given listener. Since Publisher is a singleton, it will
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	376 contain all topics in the system so it is likely to be a large
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	377 tree. However, it is possible that in some runs, unsubscribe()
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	378 is called very little by the user, in which case most unsubscriptions
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	379 are automatic, ie caused by the listeners dying. In this case,
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	380 a flag is set to indicate that the dictionary should be cleaned up
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	381 at the next opportunity. This is not necessary, it is just an
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	382 optimization.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	383 """
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	384
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	385 def __init__(self):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	386 self.__callbackDict = {}
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	387 self.__callbackDictCleanup = 0
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	388 # all child nodes will call our __rootNotifyDead method
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	389 # when one of their registered listeners dies
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	390 _TopicTreeNode.__init__(self, (ALL_TOPICS,),
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	391 _getWeakRef(self.__rootNotifyDead))
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	392
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	393 def addTopic(self, topic, listener):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	394 """Add topic to tree if doesnt exist, and add listener to topic node"""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	395 assert isinstance(topic, tuple)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	396 topicNode = self.__getTreeNode(topic, make=True)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	397 weakCB = topicNode.addCallable(listener)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	398 assert topicNode.hasCallable(listener)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	399
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	400 theList = self.__callbackDict.setdefault(weakCB, [])
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	401 assert self.__callbackDict.has_key(weakCB)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	402 # add it only if we don't already have it
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	403 try:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	404 weakTopicNode = WeakRef(topicNode)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	405 theList.index(weakTopicNode)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	406 except ValueError:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	407 theList.append(weakTopicNode)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	408 assert self.__callbackDict[weakCB].index(weakTopicNode) >= 0
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	409
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	410 def getTopics(self, listener):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	411 """Return the list of topics for given listener"""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	412 weakNodes = self.__callbackDict.get(_getWeakRef(listener), [])
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	413 return [weakNode().getPathname() for weakNode in weakNodes
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	414 if weakNode() is not None]
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	415
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	416 def isSubscribed(self, listener, topic=None):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	417 """Return true if listener is registered for topic specified.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	418 If no topic specified, return true if subscribed to something.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	419 Use topic=getStrAllTopics() to determine if a listener will receive
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	420 messages for all topics."""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	421 weakCB = _getWeakRef(listener)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	422 if topic is None:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	423 return self.__callbackDict.has_key(weakCB)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	424 else:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	425 topicPath = _tupleize(topic)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	426 for weakNode in self.__callbackDict[weakCB]:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	427 if topicPath == weakNode().getPathname():
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	428 return True
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	429 return False
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	430
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	431 def unsubscribe(self, listener, topicList):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	432 """Remove listener from given list of topics. If topicList
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	433 doesn't have any topics for which listener has subscribed,
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	434 nothing happens."""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	435 weakCB = _getWeakRef(listener)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	436 if not self.__callbackDict.has_key(weakCB):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	437 return
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	438
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	439 cbNodes = self.__callbackDict[weakCB]
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	440 if topicList is None:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	441 for weakNode in cbNodes:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	442 weakNode().removeCallable(listener)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	443 del self.__callbackDict[weakCB]
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	444 return
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	445
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	446 for weakNode in cbNodes:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	447 node = weakNode()
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	448 if node is not None and node.getPathname() in topicList:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	449 success = node.removeCallable(listener)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	450 assert success == True
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	451 cbNodes.remove(weakNode)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	452 assert not self.isSubscribed(listener, node.getPathname())
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	453
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	454 def unsubAll(self, topicList, onNoSuchTopic):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	455 """Unsubscribe all listeners registered for any topic in
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	456 topicList. If a topic in the list does not exist, and
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	457 onNoSuchTopic is not None, a call
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	458 to onNoSuchTopic(topic) is done for that topic."""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	459 for topic in topicList:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	460 node = self.__getTreeNode(topic)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	461 if node is not None:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	462 weakCallables = node.clearCallables()
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	463 for callable in weakCallables:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	464 weakNodes = self.__callbackDict[callable]
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	465 success = _removeItem(WeakRef(node), weakNodes)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	466 assert success == True
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	467 if weakNodes == []:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	468 del self.__callbackDict[callable]
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	469 elif onNoSuchTopic is not None:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	470 onNoSuchTopic(topic)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	471
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	472 def sendMessage(self, topic, message, onTopicNeverCreated):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	473 """Send a message for given topic to all registered listeners. If
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	474 topic doesn't exist, call onTopicNeverCreated(topic)."""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	475 # send to the all-toipcs listeners
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	476 deliveryCount = _TopicTreeNode.sendMessage(self, message)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	477 # send to those who listen to given topic or any of its supertopics
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	478 node = self
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	479 for topicItem in topic:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	480 assert topicItem != ''
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	481 if node.hasSubtopic(topicItem):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	482 node = node.getNode(topicItem)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	483 deliveryCount += node.sendMessage(message)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	484 else: # topic never created, don't bother continuing
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	485 if onTopicNeverCreated is not None:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	486 onTopicNeverCreated(topic)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	487 break
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	488 return deliveryCount
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	489
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	490 def numListeners(self):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	491 """Return a pair (live, dead) with count of live and dead listeners in tree"""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	492 dead, live = 0, 0
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	493 for cb in self.__callbackDict:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	494 if cb() is None:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	495 dead += 1
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	496 else:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	497 live += 1
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	498 return live, dead
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	499
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	500 # clean up the callback dictionary after how many dead listeners
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	501 callbackDeadLimit = 10
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	502
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	503 def __rootNotifyDead(self, dead):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	504 #print 'TreeROOT received death certificate for ', dead
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	505 self.__callbackDictCleanup += 1
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	506 if self.__callbackDictCleanup > _TopicTreeRoot.callbackDeadLimit:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	507 self.__callbackDictCleanup = 0
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	508 oldDict = self.__callbackDict
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	509 self.__callbackDict = {}
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	510 for weakCB, weakNodes in oldDict.iteritems():
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	511 if weakCB() is not None:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	512 self.__callbackDict[weakCB] = weakNodes
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	513
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	514 def __getTreeNode(self, topic, make=False):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	515 """Return the tree node for 'topic' from the topic tree. If it
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	516 doesnt exist and make=True, create it first."""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	517 # if the all-topics, give root;
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	518 if topic == (ALL_TOPICS,):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	519 return self
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	520
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	521 # not root, so traverse tree
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	522 node = self
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	523 path = ()
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	524 for topicItem in topic:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	525 path += (topicItem,)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	526 if topicItem == ALL_TOPICS:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	527 raise ValueError, 'Topic tuple must not contain ""'
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	528 if make:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	529 node = node.createSubtopic(topicItem, path)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	530 elif node.hasSubtopic(topicItem):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	531 node = node.getNode(topicItem)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	532 else:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	533 return None
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	534 # done
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	535 return node
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	536
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	537 def printCallbacks(self):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	538 strVal = ['Callbacks:\n']
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	539 for listener, weakTopicNodes in self.__callbackDict.iteritems():
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	540 topics = [topic() for topic in weakTopicNodes if topic() is not None]
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	541 strVal.append(' %s: %s\n' % (_getCallableName(listener()), topics))
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	542 return ''.join(strVal)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	543
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	544 def __str__(self):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	545 return 'all: %s' % _TopicTreeNode.__str__(self)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	546
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	547
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	548 # -----------------------------------------------------------------------------
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	549
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	550 class _SingletonKey: pass
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	551
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	552 class PublisherClass:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	553 """
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	554 The publish/subscribe manager. It keeps track of which listeners
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	555 are interested in which topics (see subscribe()), and sends a
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	556 Message for a given topic to listeners that have subscribed to
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	557 that topic, with optional user data (see sendMessage()).
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	558
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	559 The three important concepts for Publisher are:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	560
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	561 - listener: a function, bound method or
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	562 callable object that can be called with one parameter
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	563 (not counting 'self' in the case of methods). The parameter
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	564 will be a reference to a Message object. E.g., these listeners
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	565 are ok::
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	566
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	567 class Foo:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	568 def __call__(self, a, b=1): pass # can be called with only one arg
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	569 def meth(self, a): pass # takes only one arg
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	570 def meth2(self, a=2, b=''): pass # can be called with one arg
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	571
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	572 def func(a, b=''): pass
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	573
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	574 Foo foo
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	575 Publisher().subscribe(foo) # functor
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	576 Publisher().subscribe(foo.meth) # bound method
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	577 Publisher().subscribe(foo.meth2) # bound method
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	578 Publisher().subscribe(func) # function
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	579
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	580 The three types of callables all have arguments that allow a call
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	581 with only one argument. In every case, the parameter 'a' will contain
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	582 the message.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	583
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	584 - topic: a single word, a tuple of words, or a string containing a
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	585 set of words separated by dots, for example: 'sports.baseball'.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	586 A tuple or a dotted notation string denotes a hierarchy of
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	587 topics from most general to least. For example, a listener of
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	588 this topic::
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	589
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	590 ('sports','baseball')
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	591
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	592 would receive messages for these topics::
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	593
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	594 ('sports', 'baseball') # because same
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	595 ('sports', 'baseball', 'highscores') # because more specific
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	596
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	597 but not these::
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	598
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	599 'sports' # because more general
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	600 ('sports',) # because more general
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	601 () or ('') # because only for those listening to 'all' topics
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	602 ('news') # because different topic
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	603
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	604 - message: this is an instance of Message, containing the topic for
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	605 which the message was sent, and any data the sender specified.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	606
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	607 :note: This class is visible to importers of pubsub only as a
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	608 Singleton. I.e., every time you execute 'Publisher()', it's
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	609 actually the same instance of PublisherClass that is
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	610 returned. So to use, just do'Publisher().method()'.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	611
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	612 """
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	613
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	614 __ALL_TOPICS_TPL = (ALL_TOPICS, )
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	615
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	616 def __init__(self, singletonKey):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	617 """Construct a Publisher. This can only be done by the pubsub
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	618 module. You just use pubsub.Publisher()."""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	619 if not isinstance(singletonKey, _SingletonKey):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	620 raise invalid_argument("Use Publisher() to get access to singleton")
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	621 self.__messageCount = 0
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	622 self.__deliveryCount = 0
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	623 self.__topicTree = _TopicTreeRoot()
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	624
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	625 #
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	626 # Public API
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	627 #
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	628
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	629 def getDeliveryCount(self):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	630 """How many listeners have received a message since beginning of run"""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	631 return self.__deliveryCount
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	632
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	633 def getMessageCount(self):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	634 """How many times sendMessage() was called since beginning of run"""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	635 return self.__messageCount
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	636
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	637 def subscribe(self, listener, topic = ALL_TOPICS):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	638 """
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	639 Subscribe listener for given topic. If topic is not specified,
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	640 listener will be subscribed for all topics (that listener will
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	641 receive a Message for any topic for which a message is generated).
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	642
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	643 This method may be called multiple times for one listener,
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	644 registering it with many topics. It can also be invoked many
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	645 times for a particular topic, each time with a different
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	646 listener. See the class doc for requirements on listener and
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	647 topic.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	648
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	649 :note: The listener is held by Publisher() only by weak
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	650 reference. This means you must ensure you have at
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	651 least one strong reference to listener, otherwise it
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	652 will be DOA ("dead on arrival"). This is particularly
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	653 easy to forget when wrapping a listener method in a
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	654 proxy object (e.g. to bind some of its parameters),
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	655 e.g.::
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	656
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	657 class Foo:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	658 def listener(self, event): pass
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	659 class Wrapper:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	660 def __init__(self, fun): self.fun = fun
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	661 def __call__(self, args): self.fun(args)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	662 foo = Foo()
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	663 Publisher().subscribe( Wrapper(foo.listener) ) # whoops: DOA!
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	664 wrapper = Wrapper(foo.listener)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	665 Publisher().subscribe(wrapper) # good!
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	666
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	667 :note: Calling this method for the same listener, with two
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	668 topics in the same branch of the topic hierarchy, will
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	669 cause the listener to be notified twice when a message
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	670 for the deepest topic is sent. E.g.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	671 subscribe(listener, 't1') and then subscribe(listener,
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	672 ('t1','t2')) means that when calling sendMessage('t1'),
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	673 listener gets one message, but when calling
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	674 sendMessage(('t1','t2')), listener gets message twice.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	675
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	676 """
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	677 self.validate(listener)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	678
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	679 if topic is None:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	680 raise TypeError, 'Topic must be either a word, tuple of '\
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	681 'words, or getStrAllTopics()'
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	682
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	683 self.__topicTree.addTopic(_tupleize(topic), listener)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	684
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	685 def isSubscribed(self, listener, topic=None):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	686 """Return true if listener has subscribed to topic specified.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	687 If no topic specified, return true if subscribed to something.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	688 Use topic=getStrAllTopics() to determine if a listener will receive
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	689 messages for all topics."""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	690 return self.__topicTree.isSubscribed(listener, topic)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	691
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	692 def validate(self, listener):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	693 """Similar to isValid(), but raises a TypeError exception if not valid"""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	694 # check callable
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	695 if not callable(listener):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	696 raise TypeError, 'Listener '+`listener`+' must be a '\
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	697 'function, bound method or instance.'
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	698 # ok, callable, but if method, is it bound:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	699 elif ismethod(listener) and not _isbound(listener):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	700 raise TypeError, 'Listener '+`listener`+\
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	701 ' is a method but it is unbound!'
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	702
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	703 # check that it takes the right number of parameters
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	704 min, d = _paramMinCount(listener)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	705 if min > 1:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	706 raise TypeError, 'Listener '+`listener`+" can't"\
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	707 ' require more than one parameter!'
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	708 if min <= 0 and d == 0:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	709 raise TypeError, 'Listener '+`listener`+' lacking arguments!'
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	710
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	711 assert (min == 0 and d>0) or (min == 1)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	712
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	713 def isValid(self, listener):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	714 """Return true only if listener will be able to subscribe to
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	715 Publisher."""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	716 try:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	717 self.validate(listener)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	718 return True
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	719 except TypeError:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	720 return False
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	721
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	722 def unsubAll(self, topics=None, onNoSuchTopic=None):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	723 """Unsubscribe all listeners subscribed for topics. Topics can
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	724 be a single topic (string or tuple) or a list of topics (ie
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	725 list containing strings and/or tuples). If topics is not
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	726 specified, all listeners for all topics will be unsubscribed,
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	727 ie. the Publisher singleton will have no topics and no listeners
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	728 left. If onNoSuchTopic is given, it will be called as
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	729 onNoSuchTopic(topic) for each topic that is unknown.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	730 """
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	731 if topics is None:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	732 del self.__topicTree
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	733 self.__topicTree = _TopicTreeRoot()
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	734 return
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	735
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	736 # make sure every topics are in tuple form
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	737 if isinstance(topics, list):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	738 topicList = [_tupleize(x) for x in topics]
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	739 else:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	740 topicList = [_tupleize(topics)]
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	741
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	742 # unsub every listener of topics
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	743 self.__topicTree.unsubAll(topicList, onNoSuchTopic)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	744
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	745 def unsubscribe(self, listener, topics=None):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	746 """Unsubscribe listener. If topics not specified, listener is
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	747 completely unsubscribed. Otherwise, it is unsubscribed only
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	748 for the topic (the usual tuple) or list of topics (ie a list
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	749 of tuples) specified. Nothing happens if listener is not actually
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	750 subscribed to any of the topics.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	751
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	752 Note that if listener subscribed for two topics (a,b) and (a,c),
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	753 then unsubscribing for topic (a) will do nothing. You must
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	754 use getAssociatedTopics(listener) and give unsubscribe() the returned
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	755 list (or a subset thereof).
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	756 """
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	757 self.validate(listener)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	758 topicList = None
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	759 if topics is not None:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	760 if isinstance(topics, list):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	761 topicList = [_tupleize(x) for x in topics]
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	762 else:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	763 topicList = [_tupleize(topics)]
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	764
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	765 self.__topicTree.unsubscribe(listener, topicList)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	766
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	767 def getAssociatedTopics(self, listener):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	768 """Return a list of topics the given listener is registered with.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	769 Returns [] if listener never subscribed.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	770
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	771 :attention: when using the return of this method to compare to
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	772 expected list of topics, remember that topics that are
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	773 not in the form of a tuple appear as a one-tuple in
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	774 the return. E.g. if you have subscribed a listener to
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	775 'topic1' and ('topic2','subtopic2'), this method
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	776 returns::
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	777
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	778 associatedTopics = [('topic1',), ('topic2','subtopic2')]
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	779 """
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	780 return self.__topicTree.getTopics(listener)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	781
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	782 def sendMessage(self, topic=ALL_TOPICS, data=None, onTopicNeverCreated=None):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	783 """Send a message for given topic, with optional data, to
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	784 subscribed listeners. If topic is not specified, only the
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	785 listeners that are interested in all topics will receive message.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	786 The onTopicNeverCreated is an optional callback of your choice that
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	787 will be called if the topic given was never created (i.e. it, or
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	788 one of its subtopics, was never subscribed to by any listener).
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	789 It will be called as onTopicNeverCreated(topic)."""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	790 aTopic = _tupleize(topic)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	791 message = Message(aTopic, data)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	792 self.__messageCount += 1
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	793
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	794 # send to those who listen to all topics
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	795 self.__deliveryCount += \
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	796 self.__topicTree.sendMessage(aTopic, message, onTopicNeverCreated)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	797
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	798 #
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	799 # Private methods
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	800 #
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	801
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	802 def __call__(self):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	803 """Allows for singleton"""
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	804 return self
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	805
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	806 def __str__(self):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	807 return str(self.__topicTree)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	808
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	809 # Create the Publisher singleton. We prevent users from (inadvertently)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	810 # instantiating more than one object, by requiring a key that is
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	811 # accessible only to module. From
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	812 # this point forward any calls to Publisher() will invoke the __call__
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	813 # of this instance which just returns itself.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	814 #
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	815 # The only flaw with this approach is that you can't derive a new
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	816 # class from Publisher without jumping through hoops. If this ever
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	817 # becomes an issue then a new Singleton implementaion will need to be
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	818 # employed.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	819 _key = _SingletonKey()
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	820 Publisher = PublisherClass(_key)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	821
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	822
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	823 #---------------------------------------------------------------------------
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	824
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	825 class Message:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	826 """
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	827 A simple container object for the two components of a message: the
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	828 topic and the user data. An instance of Message is given to your
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	829 listener when called by Publisher().sendMessage(topic) (if your
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	830 listener callback was registered for that topic).
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	831 """
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	832 def __init__(self, topic, data):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	833 self.topic = topic
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	834 self.data = data
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	835
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	836 def __str__(self):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	837 return '[Topic: '+`self.topic`+', Data: '+`self.data`+']'

Mercurial > traipse

annotate orpg/tools/pubsub.py @ 39:ed322725b928 ornery-orc tip