B lßU\þã@sJdZddlmZddlmZddlmZmZGdd„deƒZd d d „Z dS) z½ Output various aspects of topic tree to string or file. :copyright: Copyright since 2006 by Oliver Schoenborn, all rights reserved. :license: BSD, see LICENSE_BSD_Simple.txt for details. é)ÚTextIO)Ú TextWrapperé)ÚITopicTreeVisitorÚTopicTreeTraverserc@sŠeZdZdZedƒZdZd$eeeeee d œd d „Z d d„Z dd„Z dd„Z dd„Zdd„Zd%dd„Zdd„Zd&dd„Zd d!„Zd"d#„ZdS)'ÚTopicTreePrintera} Example topic tree visitor that prints a prettified representation of topic tree by doing a depth-first traversal of topic tree and print information at each (topic) node of tree. Extra info to be printed is specified via the 'extra' kwarg. Its value must be a list of characters, the order determines output order: - D: print description of topic - a: print kwarg names only - A: print topic kwargs and their description - L: print listeners currently subscribed to topic E.g. TopicTreePrinter(extra='LaDA') would print, for each topic, the list of subscribed listeners, the topic's list of kwargs, the topic description, and the description for each kwarg, >>> Topic "delTopic" >> Listeners: > listener1_2880 (from yourModule) > listener2_3450 (from yourModule) >> Names of Message arguments: > arg1 > arg2 >> Description: whenever a topic is deleted >> Descriptions of Message arguments: > arg1: (required) its description > arg2: some other description ZDAaLZ ALL_TOPICSNéFéú\--ú|==ú-)ÚwidthÚ indentStepÚ bulletTopicÚbulletTopicItemÚbulletTopicArgÚfileObjc Cs²t|j|j|j|jd|_|jt|j ¡ƒks2t ‚ddl }|pB|j |_ g|_ |pRd|_t|jƒ|j} | r€dd | ¡} t| ƒ‚||_t|ƒ|_d|_||_||_||_||_dS)a… Topic tree printer will print listeners for each topic only if printListeners is True. The width will be used to limit the width of text output, while indentStep is the number of spaces added each time the text is indented further. The three bullet parameters define the strings used for each item (topic, topic items, and kwargs). )ÚDÚAÚaÚLrNÚzThese extra chars not known: %sú,)ÚdictÚ(_TopicTreePrinter__printTopicDescriptionÚ$_TopicTreePrinter__printTopicArgsAllÚ%_TopicTreePrinter__printTopicArgNamesÚ&_TopicTreePrinter__printTopicListenersÚ_TopicTreePrinter__contentMethÚ allowedExtrasÚsetÚkeysÚAssertionErrorÚsysÚstdoutÚ_TopicTreePrinter__destinationÚ_TopicTreePrinter__outputÚ_TopicTreePrinter__contentÚjoinÚ ValueErrorÚ_TopicTreePrinter__widthrÚ_TopicTreePrinter__wrapperÚ_TopicTreePrinter__indentÚ_TopicTreePrinter__indentStepÚ_TopicTreePrinter__topicsBulletÚ#_TopicTreePrinter__topicItemsBulletÚ"_TopicTreePrinter__topicArgsBullet) ÚselfZextrar rrrrrr#Z unknownSelÚmsg©r3úr@ÚdefnÚsepÚprefixr3r3r4Z __formatDefnts  zTopicTreePrinter.__formatDefncCs(d|j}|j | ||| ¡¡¡dS)Nz%s Description)r/r&r;r<ZgetDescription)r1r>r=rIr3r3r4Z__printTopicDescription‚s z(TopicTreePrinter.__printTopicDescriptionTc Cs¨| ¡}|r¤d}|rd}d|j|f}|j | ||¡¡||j}| ¡d}xR| ¡D]F\} } |sld} n| |kr|d| } d|j| f} |j | || | ¡¡qZWdS)NzNames of Message arguments:z"Descriptions of message arguments:z%s %srrz (required) %s) ZgetArgDescriptionsr/r&r;r<r-ZgetArgsÚitemsr0) r1r>r=ZdescÚargsZheadNamer?Ú tmpIndentÚrequiredÚkeyÚargr2r3r3r4Z__printTopicArgsAllˆs   z$TopicTreePrinter.__printTopicArgsAllcCs| ||d¡dS)NF)r)r1r>r=r3r3r4Z__printTopicArgNamesœsz%TopicTreePrinter.__printTopicArgNamescCsr| ¡rnd|j}|j | ||¡¡||j}x<| ¡D]0}d|j| ¡|  ¡f}|j | ||¡¡q:WdS)Nz %s Listeners:z%s %s (from %s)) Z hasListenersr/r&r;r<r-ZgetListenersIterr0ÚnameÚmodule)r1r>r=r@rNZlistenerr3r3r4Z__printTopicListenersŸs  z&TopicTreePrinter.__printTopicListeners)Nrr r r r N)rrD)T)Ú__name__Ú __module__Ú __qualname__Ú__doc__Ú frozensetrr:ÚintÚstrrr5r7r9rArBrCr<rrrrr3r3r3r4rs !  rNcKsL|dkr,|dkr$ddlm}| ¡}| ¡}tf|Ž}t|ƒ}| |¡dS)a” Print out the topic tree to a file (or file-like object like a StringIO), starting at rootTopic. If root topic should be root of whole tree, get it from pub.getDefaultTopicTreeRoot(). The treeVisitor is an instance of pub.TopicTreeTraverser. Printing the tree docs would normally involve this:: from pubsub import pub from pubsub.utils.topictreeprinter import TopicTreePrinter traverser = pub.TopicTreeTraverser( TopicTreePrinter(**kwargs) ) traverser.traverse( pub.getDefaultTopicTreeRoot() ) With printTreeDocs, it looks like this:: from pubsub import pub from pubsub.utils import printTreeDocs printTreeDocs() The kwargs are the same as for TopicTreePrinter constructor: extra(None), width(70), indentStep(4), bulletTopic, bulletTopicItem, bulletTopicArg, fileObj(stdout). If fileObj not given, stdout is used. Nr)Úpub)rr[ZgetDefaultTopicMgrZgetRootAllTopicsrrZtraverse)Z rootTopicZtopicMgrÚkwargsr[ZprinterZ traverserr3r3r4Ú printTreeDocs©s  r])NN) rWÚtypingrÚtextwraprZcore.topictreetraverserrrrr]r3r3r3r4Ús