Common

Contents

• Common
  • Loggable
  • getLogger
  • EventAware
  • Serializable
  • GeneralStore

Loggable

class serge.common.Loggable

Bases: object

A helper class that adds a logger to a class

Each instance of the class will have a log attribute and can use this to log output. The log attrbute is a logger with the usual debug, warn, info, and error methods.

addLogger()

Add a logger

getLogger

registry.getLogger(name)

Return a named logger - mainly used when logging from a non-loggable object

EventAware

class serge.common.EventAware

Bases: object

A mixin class that allows objects to respond to events

handleEvent(event)

Handle an incoming event

initEvents()

Initialise the events system

linkEvent(name, callback, arg=None)

Link an event to a callback

processEvent(event)

Process an incoming event

registerEvent(event)

Register an event

registerEvents(events)

Register a number of events

registerEventsFromModule(module)

Register all events found in the module

Events must be strings and their name must be of the form E_THE_NAME

ie: Begins with an ‘E’ and is all uppercase

unlinkEvent(name, callback=None)

Unlink an event from a callback

Serializable

class serge.serialize.Serializable

Bases: object

A mixing class to help serialize and deserialize objects

asString()

Return the properties of this object as a string

copy()

Return another copy of this item

classmethod createInstance()

Return an instance of the class with all default properties set

classmethod fromFile(filename)

Return a new instance from a file

classmethod fromString(text)

Return a new instance from a string

init()

Implement this method to do any object initialization after unpickling

toFile(filename)

Store this object in a file

GeneralStore

class serge.registry.GeneralStore

Bases: serge.serialize.Serializable

Stores things

clearItems()

Clear all the items

duplicateItem(name, new_name)

Create a duplicate of the named item with a new name

getItem(name)

Return an item

getItemDefinitions()

Return all the item definitions

getItems()

Return all the items

getNames()

Return the names of all the items

init()

Initialise from serialized form

registerItem(name, *args, **kw)

Register an item

removeItem(name)

Remove the named item

setPath(path)

Set our base path to locate images