B lU\4@sdZddlmZmZmZmZddlmZmZm Z m Z m Z GdddeZ GdddeZ Gd d d eZeeefed d d Zde edddZdeee edddZdS)a Provide an interface class for handling pubsub notification messages, and an example class (though very useful in practice) showing how to use it. Notification messages are generated by pubsub - if a handler has been configured via pub.addNotificationHandler() - when pubsub does certain tasks, such as when a listener subscribes to or unsubscribes from a topic Derive from this class to handle notification events from various parts of pubsub. E.g. when a listener subscribes, unsubscribes, or dies, a notification handler, if you specified one via pub.addNotificationHandler(), is given the relevant information. :copyright: Copyright since 2006 by Oliver Schoenborn, all rights reserved. :license: BSD, see LICENSE_BSD_Simple.txt for details. )ListMappingAnyTextIO) TopicManagerINotificationHandlerListenerTopic Publisherc@seZdZdZeeedddZeedddZeeddd Z de eed d d Z ee e e e e e fdddZe dddZd S)IgnoreNotificationsMixinz Derive your Notifications handler from this class if your handler just wants to be notified of one or two types of pubsub events. Then just override the desired methods. The rest of the notifications will automatically be ignored. ) pubListenertopicObjnewSubcCsdS)N)selfr rrrr8lib/python3.7/site-packages/pubsub/utils/notification.pynotifySubscribe#sz(IgnoreNotificationsMixin.notifySubscribe)r rcCsdS)Nr)rr rrrrnotifyUnsubscribe&sz*IgnoreNotificationsMixin.notifyUnsubscribecCsdS)Nr)rr rrrrnotifyDeadListener)sz+IgnoreNotificationsMixin.notifyDeadListenerN)stagerr cCsdS)Nr)rrrr rrr notifySend,sz#IgnoreNotificationsMixin.notifySend)r descriptionrequiredargsDocscCsdS)Nr)rrrrrrrrnotifyNewTopic/sz'IgnoreNotificationsMixin.notifyNewTopic) topicNamecCsdS)Nr)rrrrrnotifyDelTopic2sz'IgnoreNotificationsMixin.notifyDelTopic)N)__name__ __module__ __qualname____doc__r r boolrrrstrrrrrrrrrrr s r c@seZdZdZdZdeedddZddZe e e d d d Z e e d d dZ e e d ddZdee e dddZe eeeeeefdddZedddZdS)NotifyByWriteFilezE Print a message to stdout when a notification is received. zPUBSUB:N)fileObjprefixcCs0|p|j|_|dkr&ddl}|j|_n||_dS)z Will write to stdout unless fileObj given. Will use defaultPrefix as prefix for each line output, unless prefix specified. Nr) defaultPrefix_NotifyByWriteFile__presysstdout_NotifyByWriteFile__fileObj)rr%r&r)rrr__init__=s   zNotifyByWriteFile.__init__cCs ||_dS)N)r+)rr%rrr changeFileKszNotifyByWriteFile.changeFile)r rrcCs2|r d}nd}||j||f}|j|dS)Nz*%s Subscribed listener "%s" to topic "%s" z0%s Subscription of "%s" to topic "%s" redundant )r(getNamer+write)rr rrmsgrrrrNs z!NotifyByWriteFile.notifySubscribe)r rcCs(d}||j||f}|j|dS)Nz.%s Unsubscribed listener "%s" from topic "%s" )r(r.r+r/)rr rr0rrrrVsz#NotifyByWriteFile.notifyUnsubscribecCs$d|j||f}|j|dS)Nz(%s Listener "%s" of Topic "%s" has died )r(r.r+r/)rr rr0rrrr[sz$NotifyByWriteFile.notifyDeadListener)rrr cCs\|dkrd|j||f}n.|dkr:d|j|f}nd|j|f}|j|dS)Ninz0%s Sending message of topic "%s" to listener %s prez'%s Start sending message of topic "%s" z&%s Done sending message of topic "%s" )r(r.r+r/)rrrr r0rrrrbs zNotifyByWriteFile.notifySend)rrrrcCs"d|j|f}|j|dS)Nz%s New topic "%s" created )r(r.r+r/)rrrrrr0rrrrksz NotifyByWriteFile.notifyNewTopic)rcCsd|j|f}|j|dS)Nz%s Topic "%s" destroyed )r(r+r/)rrr0rrrrosz NotifyByWriteFile.notifyDelTopic)NN)N)rrr r!r'rr#r,r-r r r"rrrrrrrrrrrrr$6s r$c@seZdZdZdZededededededed Zd$ed d d Zed ddZ e e e dddZ e e dddZe e dddZd%ee e dddZe eeeeeefdddZeddd Ze eeefd!d"d#Zd S)&NotifyByPubsubMessageaF Handle pubsub notification messages by generating messages of a 'pubsub.' subtopic. Also provides an example of how to create a notification handler. Use it by calling:: import pubsub.utils pubsub.utils.useNotifyByPubsubMessage() ... pub.setNotificationFlags(...) # optional E.g. whenever a listener is unsubscribed, a 'pubsub.unsubscribe' message is generated. If you have subscribed a listener of this topic, your listener will be notified of what listener unsubscribed from what topic. Zpubsubz%s.sendMessagez %s.subscribez%s.unsubscribez %s.newTopicz %s.delTopicz%s.deadListener)send subscribe unsubscribenewTopicdelTopic deadListenerN)topicMgrcCs"d|_d|_|dk r||dS)NF) _pubTopic_NotifyByPubsubMessage__sendingcreateNotificationTopics)rr:rrrr,szNotifyByPubsubMessage.__init__cCsPy||jWn:tk rJ||j|_|jdt|j|YnXdS)z Create the notification topics. The root of the topics created is self.topicRoot. The topicMgr is (usually) pub.topicMgr. z"root of all pubsub-specific topicsN)ZgetTopic topicRoot ValueErrorgetOrCreateTopicr;setDescription _createTopicstopics)rr:rrrr=s  z.NotifyByPubsubMessage.createNotificationTopics)r rrcCsF|jdks|jrdS|jd}||k rBt|||d}|||dS)Nr5)listenertopicr)r;r< getSubtopicdict&_NotifyByPubsubMessage__doNotification)rr rrpubTopickwargsrrrrs  z%NotifyByPubsubMessage.notifySubscribe)r rcCsJ|jdks|jrdS|jd}||k rFt|||d}|||dS)Nr6)rE listenerRawrD)r;r<rFrGZ getCallablerH)rr rrIrJrrrrs z'NotifyByPubsubMessage.notifyUnsubscribecCs<|jdks|jrdS|jd}t||d}|||dS)Nr9)rErD)r;r<rFrGrH)rr rrIrJrrrrs   z(NotifyByPubsubMessage.notifyDeadListener)rrr cCs\|jdks|jrdS|jd}|dkrD||krDd|}t|||t||ddS)a Stage must be 'pre' or 'post'. Note that any pubsub sendMessage operation resulting from this notification (which sends a message; listener could handle by sending another message!) will NOT themselves lead to a send notification. NZ sendMessager2z(Not allowed to send messages of topic %s)rEr)r;r<rFr.r?rHrG)rrrr Z sendMsgTopicr0rrrrs  z NotifyByPubsubMessage.notifySend)rrrrcCs@|jdks|jrdS|jd}t||||d}|||dS)Nr7)rErrargs)r;r<rFrGrH)rrrrrrIrJrrrrs  z$NotifyByPubsubMessage.notifyNewTopic)rcCs6|jdks|jrdS|jd}||t|ddS)Nr8)name)r;r<rFrHrG)rrrIrrrrs z$NotifyByPubsubMessage.notifyDelTopic)rIrJcCs$d|_z|jf|Wdd|_XdS)NTF)r<Zpublish)rrIrJrrrZ__doNotificationsz&NotifyByPubsubMessage.__doNotification)N)N)rrr r!r>rGrCrr,r=r r r"rrrr#rrrrrrrHrrrrr3ts$    r3)topicMapr:csd&fdd }||dddddd ||d d d d dd||dddddd||ddddddd||dddd ||d!d"d#d$d%dS)'al Create notification topics. These are used when some of the notification flags have been set to True (see pub.setNotificationFlags(). The topicMap is a dict where key is the notification type, and value is the topic name to create. Notification type is a string in ('send', 'subscribe', 'unsubscribe', 'newTopic', 'delTopic', 'deadListener'). Ncs$|}|||||dS)N)r@rAZ setMsgArgSpec)_name_descZ _requiredrrE)r:rrr7s  z_createTopics..newTopicr5z,whenever a listener is subscribed to a topicz%topic that listener has subscribed toz,instance of pub.Listener containing listenerz8false if listener was already subscribed, true otherwise)rOrPrErDrr6z0whenever a listener is unsubscribed from a topicz:instance of Topic that listener has been unsubscribed fromzAinstance of pub.Listener unsubscribed; None if listener not foundzlistener unsubscribed)rOrPrErDrKr4z*sent at beginning and end of sendMessage()z(instance of topic for message being sentz0stage of send operation: "pre" or "post" or "in"zwhich listener being sent to)rOrPrErrDr7zwhenever a new topic is definedzinstance of Topic createdzdescription of topic (use)zHthe argument names/descriptions for arguments that listeners must acceptz1which args are required (all others are optional))rOrPrErrLrr8zwhenever a topic is deletedz2full name of the Topic instance that was destroyed)rOrPrMr9z4whenever a listener dies without having unsubscribedz1instance of Topic that listener was subscribed toz1instance of pub.Listener containing dead listener)rOrPrErD)Nr)rNr:r7r)r:rrBsFrBNT) publisherallcKsN|dkrddlm}|}|}t|}|||jfd|i|dS)a[ Will cause all of pubsub's notifications of pubsub "actions" (such as new topic created, message sent, listener subscribed, etc) to be sent out as messages. Topic will be 'pubsub' subtopics, such as 'pubsub.newTopic', 'pubsub.delTopic', 'pubsub.sendMessage', etc. The 'all' and kwargs args are the same as pubsub's setNotificationFlags(), except that 'all' defaults to True. The publisher is rarely needed: * The publisher must be specfied if pubsub is not installed on the system search path (ie from pubsub import ... would fail or import wrong pubsub -- such as if pubsub is within wxPython's wx.lib package). Then pbuModule is the pub module to use:: from wx.lib.pubsub import pub from wx.lib.pubsub.utils import notification notification.useNotifyByPubsubMessage() Nr)pubrR)rSgetDefaultPublisherZ getTopicMgrr3addNotificationHandlersetNotificationFlags)rQrRrJrSr: notifHandlerrrruseNotifyByPubsubMessage"s  rY)r%r&rQrRcKsH|dkrddlm}|}t||}|||jfd|i|dS)a? Will cause all pubsub notifications of pubsub "actions" (such as new topic created, message sent, listener died etc) to be written to specified file (or stdout if none given). The fileObj need only provide a 'write(string)' method. The first two arguments are the same as those of NotifyByWriteFile constructor. The 'all' and kwargs arguments are those of pubsub's setNotificationFlags(), except that 'all' defaults to True. See useNotifyByPubsubMessage() for an explanation of pubModule (typically only if pubsub inside wxPython's wx.lib) Nr)rSrR)rTrSrUr$rVrW)r%r&rQrRrJrSrXrrruseNotifyByWriteFileBs    rZ)NT)NNNT)r!typingrrrrZcorerrr r r r r$r3r#rBr"rYrZrrrrs>x6