Interface specifications

Overview

This page enumerates and provides links to documents containing Application Programmer Interface (API) specifications for a number of Python modules that may be useful for building KP's or extending the KOS in some way. A more comprehensive overview of how to write KP's and the tools KP's have availabe to them can be found in the KP interface document.

The interfaces described here are Python modules. There is also a collection of ILU interface definitions, described in the Interface Specifications section.

How to read API documents

Interfaces are described in a manner similar to that used for Python modules, but with additional forms used to convey additional constraints which are specified in the interfaces:

• Classes are enumerated in the Classes section in the beginning of the document with a descriptive overview of the class. The method API corresponding to the class is explained in sections for each object type following any other sections.

• Some methods may be left undocumented. Only those considered useful for the user of the module have been explained with detail.

Modules useful for KPs and plugins:

• iotools
• ilutools
• kptools
• nstools
• pathhack
• pluginlib
• Suitcase
• tktools

Documented internal modules

• access
• FileImpl
• MappingImpl
• NamespaceImpl
• RS
• shadow