Navigation

phoenix_title wx.lib.pubsub.core.topicdefnprovider.TopicDefnDeserialModule

Deserialize a module containing Python source code defining a topic tree. This loads the module and gives it to an instance of TopicDefnDeserialClass.


class_hierarchy Class Hierarchy

Inheritance diagram for class TopicDefnDeserialModule:

super_classes Known Superclasses

wx.lib.pubsub.core.topicdefnprovider.ITopicDefnDeserializer


method_summary Methods Summary

__init__

Load the given named module, searched for in searchPath or, if not

doneIter

Called automatically by TopicDefnProvider once

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 TopicDefnDeserialModule(ITopicDefnDeserializer)

Deserialize a module containing Python source code defining a topic tree. This loads the module and gives it to an instance of TopicDefnDeserialClass.


Methods

__init__(self, moduleName, searchPath=None)

Load the given named module, searched for in searchPath or, if not specified, in sys.path. Give it to a TopicDefnDeserialClass.


doneIter(self)

Called automatically by TopicDefnProvider once it considers the iteration completed. Override this only if deserializer needs to take action, such as closing a file.


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.