Package peppy :: Package plugins :: Module chatbots :: Class ChatPlugin

Class ChatPlugin

               object --+        
                        |        
    yapsy.IPlugin.IPlugin --+    
                            |    
               object --+   |    
                        |   |    
lib.userparams.ClassPrefs --+    
                            |    
               object --+   |    
                        |   |    
         debug.debugmixin --+    
                            |    
   yapsy.plugins.IPeppyPlugin --+
                                |
                               ChatPlugin

Nested Classes
Inherited from `lib.userparams.ClassPrefs`: `__metaclass__`

Instance Methods

Inherited from yapsy.plugins.IPeppyPlugin: __init__, activate, activateHook, deactivate, deactivateHook

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

convenience

Inherited from yapsy.plugins.IPeppyPlugin: importModule, isInUse

interface

supportedShells(self)
Return a list of shells that this interface supports, e.g.

getPipe(self, filename)
Return a file-like object that is the interface to the shell.

getActions(self)
Create a global menu item for each chatbot.

Inherited from yapsy.plugins.IPeppyPlugin: aboutFiles, addCommandLineOptions, attemptOpen, finalShutdown, getCompatibleActions, getCompatibleMajorModes, getCompatibleMinorModes, getMajorModes, getMinorModes, getSidebars, initialActivation, loadVirtualFileSystem, processCommandLineOptions, requestedShutdown

Class Methods

Inherited from yapsy.plugins.IPeppyPlugin: setStartupComplete

Inherited from debug.debugmixin: dprint

Class Variables
	actions = `None`
	classprefs = `<peppy.lib.userparams.PrefsProxy object at 0x865d...`
Inherited from `yapsy.plugins.IPeppyPlugin`: `default_classprefs`, `preferences_tab` Inherited from `lib.userparams.ClassPrefs`: `preferences_sort_weight` Inherited from `debug.debugmixin`: `debuglevel`

Properties
Inherited from `object`: `__class__`

Method Details

supportedShells(self)

Return a list of shells that this interface supports, e.g. a bash shell should return ['bash'] or python should return ['python'].

Overrides: yapsy.plugins.IPeppyPlugin.supportedShells: (inherited documentation)

getPipe(self, filename)

Return a file-like object that is the interface to the shell. Typically this will act like a pipe to an object: stuff that is written to this file handle will get sent through the pipe to the shell, and when data is available it can be read from this object.

Overrides: yapsy.plugins.IPeppyPlugin.getPipe: (inherited documentation)

getActions(self)

Create a global menu item for each chatbot.

Since we don't want to hard-code the chatbots, we have to dynamically create an Action class for each chatbot. This is used to create the menu. The class and menu creation is only done once, subsequent passes through here returns the cached menu.

Overrides: yapsy.plugins.IPeppyPlugin.getActions

Class Variable Details

classprefs

Value:

<peppy.lib.userparams.PrefsProxy object at 0x865d690>