topicdefnprovider

Everything that has to do with topic definition tree import/export.

copyright:Copyright 2006-2009 by Oliver Schoenborn, all rights reserved. license:BSD, see LICENSE.txt for details.

Inheritance Diagram

Inheritance diagram for module topicdefnprovider

Functions Summary

exportTreeAsSpec	Prints the topic tree specification starting from rootTopic.
registerTypeForImport

Classes Summary

ITopicDefnDeserializer	All functionality to convert a topic tree representation into a
TopicDefn	Encapsulate date for a topic definition. Returned by
ITopicDefnProvider	All topic definition providers must follow this protocol. They must
MasterTopicDefnProvider	Stores a list of topic definition providers. When queried for a topic
TopicDefnDeserialClass	Interpret a class tree as a topic definition tree. The class name is the
TopicDefnDeserialModule	Deserialize a module containing source code defining a topic tree.
TopicDefnDeserialString	Deserialize a string containing source code defining a topic tree.
TopicDefnProvider	Default implementation of the ITopicDefnProvider API. This
TopicTreeAsSpec	Prints the class representation of topic tree, as Python code

Functions

---

exportTreeAsSpec(rootTopic, **kwargs)

Prints the topic tree specification starting from rootTopic. If not specified, the whole topic tree is printed. The kwargs are the same as TopicTreeAsSpec’s constructor: width(70), indentStep(4), header(None), footer(None), fileObj. If no header or footer are given, the default ones are used (see defaultTopicTreeSpecHeader and defaultTopicTreeSpecFooter), such that the resulting output can be imported in your application. E.g.:

pyFile = file('appTopicTree.py','w')
exportTreeAsSpec( pyFile )
pyFile.close()
import appTopicTree

---

registerTypeForImport(typeName, providerClassObj)