wx.lib.pubsub.core.topicdefnprovider.TopicDefnDeserialString

Deserialize a string containing Python source code defining a topic tree. The string has the same format as expected by TopicDefnDeserialModule.

Class Hierarchy

Inheritance diagram for class TopicDefnDeserialString:

Known Superclasses

wx.lib.pubsub.core.topicdefnprovider.ITopicDefnDeserializer

Methods Summary

__init__	This just saves the string into a temporary file created in
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

Class API

class TopicDefnDeserialString(ITopicDefnDeserializer)

Deserialize a string containing Python source code defining a topic tree. The string has the same format as expected by TopicDefnDeserialModule.

Methods

__init__(self, source)

This just saves the string into a temporary file created in os.getcwd(), and the rest is delegated to TopicDefnDeserialModule. The temporary file (module – as well as its byte-compiled version) will be deleted when the doneIter() method is called.

---

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.