August'24: Kamaelia is in maintenance mode and will recieve periodic updates, about twice a year, primarily targeted around Python 3 and ecosystem compatibility. PRs are always welcome. Latest Release: 1.14.32 (2024/3/24)

Kamaelia.BaseIPC

Base IPC class. Subclass it to create your own IPC classes.

When doing so, make sure you set the following:

  • Its doc string, so a string explanation can be generated for an instance of your subclass.
  • 'Parameters' class attribute to a list of named parameters you accept at creation, prefixing optional parameters with "?", e.g. "?depth"

For example

A custom IPC class to report a theft taking place!

class Theft(Kamaelia.BaseIPC.IPC):
    """Something has been stolen!"""

    Parameters = ["?who","what"]

So what happens when we use it?

>>> ipc = Theft(who="Sam", what="sweeties")
>>> ipc.__doc__
'Something has been stolen!'
>>> ipc.who
'Sam'
>>> ipc.what
'sweeties'

Feedback

Got a problem with the documentation? Something unclear that could be clearer? Want to help improve it? Constructive criticism is very welcome - especially if you can suggest a better rewording!

Please leave you feedback here in reply to the documentation thread in the Kamaelia blog.

-- Automatic documentation generator, 05 Jun 2009 at 03:01:38 UTC/GMT