phoenix_title wx.lib.pubsub.core.topicdefnprovider.TopicDefnDeserialClass

Convert a nested class tree as a topic definition tree. Format: the class name is the topic name, its doc string is its description. The topic’s message data specification is determined by inspecting a class method called the same as SPEC_METHOD_NAME. The doc string of that method is parsed to extract the description for each message data.


class_hierarchy Class Hierarchy

Inheritance diagram for class TopicDefnDeserialClass:

super_classes Known Superclasses

wx.lib.pubsub.core.topicdefnprovider.ITopicDefnDeserializer


method_summary Methods Summary

__init__

If pyClassObj is given, it is an object that contains nested

getDefinedTopics

getNextTopic

Get the next topic definition available from the data. The return

getTreeDoc

Get the docstring for the topic tree.

resetIter

Called by the TopicDefnProvider if it needs to


api Class API

class TopicDefnDeserialClass(ITopicDefnDeserializer)

Convert a nested class tree as a topic definition tree. Format: the class name is the topic name, its doc string is its description. The topic’s message data specification is determined by inspecting a class method called the same as SPEC_METHOD_NAME. The doc string of that method is parsed to extract the description for each message data.


Methods

__init__(self, pyClassObj=None)

If pyClassObj is given, it is an object that contains nested classes defining root topics; the root topics contain nested classes defining subtopics; etc.



getDefinedTopics(self)


getNextTopic(self)

Get the next topic definition available from the data. The return must be an instance of TopicDefn. Must return None when no topics are left.



getTreeDoc(self)

Get the docstring for the topic tree.



resetIter(self)

Called by the TopicDefnProvider if it needs to restart the topic iteration. Override this only if special action needed, such as resetting a file pointer to beginning of file.