Simple framework for python plugins
Plugins are often good to build a loosely coupled, modular software architecture. They also foster third-party contributions.
This article describes how I did it very simply in python, this framework is called spf (Simple plugin framework) and is available on github.
After reading a review on existing framworks, I tried yapsy. Unfortunately it’s python 2, and despite doing a couple of obvious changes in the code, I couldn’t make a working plugin, failing with error
module.__init__() takes at most 2 arguments (3 given)
After that, I decided to understand better how exec() works on init.py and what such a framework should do. I read the brilliant article A Simple Plugin Framework by Marty Alchin (who, I think, was a django contributor, and don’t know if he still is).
His design is so KISS, I love it. This article is just a up-to-date (there was python 2 to python 3 update to do) and simplified (without references to django) version of his « framework ».
The first thing is to define the notion of plugin.
- a mount point is a place where extra features can be added
- a plugin is a specific implementation that is added to a specific place
Let’s first define a mount point, as a metaclass that simply contains the list of plugins to apply there.
class MountPoint(type):
»’
* A way to declare a mount point for plugins. Since plugins are an example of loose coupling, there needs to be a neutral location, somewhere between the plugins and the code that uses them, that each side of the system can look at, without having to know the details of the other side.
* A way to register a plugin at a particular mount point. Since internal code don’t want to look around to find plugins that might work for it, there needs to be a way for plugins to announce their presence. This allows the guts of the system to be blissfully ignorant of where the plugins come from; again, it only needs to care about the mount point.
* A way to retrieve the plugins that have been registered. Once the plugins have done their thing at the mount point, the rest of the system needs to be able to iterate over the installed plugins and use them according to its need.
Add the parameter \`metaclass = MountPoint\` in any class to make it a mont point.
»’
def \_\_init\_\_(cls, name, bases, attrs):
if not hasattr(cls, ‘plugins’):
\# This branch only executes when processing the mount point itself.
\# So, since this is a new plugin type, not an implementation, this
\# class shouldn’t be registered as a plugin. Instead, it sets up a
\# list where plugins can be registered later.
cls.plugins = []
else:
\# This must be a plugin implementation, which should be registered.
\# Simply appending it to the list is all that’s needed to keep
\# track of it later.
cls.plugins.append(cls)
Now, let’s write a mount point. To have a very simple example, my mount point is to print text.
class TextTransformer(object, metaclass=MountPoint):
»’ Plugins can inherit this mount point in order to modify text.
A plugin that registers this mount point must implement the method
* transform_text(self, string):
»’
def \_\_init\_\_(self, program):
pass
As you can see, this is very simple. Because python doesn’t have interfaces, it is very important to write documentation.
For instance, I can have 3 transformers for HTML text
class HtmlTransformer(TextTransformer):
def \_\_init\_\_(self, program):
self.tag = None
#As documented in the Mount point, this must be implemented
def transform_text(self, string):
if self.tag:
return « < {tag}>{original} ».format(tag=self.tag, original=string)
else:
return string
class HtmlEmTransformer(HtmlTransformer):
»’ Plugin to wrap text in a html tag
»’
def \_\_init\_\_(self, program):
»’ This TextTransformer will transform « string« into « _string_«
»’
self.tag = « em »
class HtmlBoldTransformer(HtmlTransformer):
»’ Plugin to wrap text in a html tag
»’
def \_\_init\_\_(self, program):
»’ This TextTransformer will transform « string« into « **string**«
»’
self.tag = « b »
A main method that has a TextTransformer mount point
class MyProgram:
plugins = ExtensionsAt(TextTransformer)
def main(self):
\# Here I declare a mount point TextTransformer
\# « hello world » will be printed by each plugin
for plugin in self.plugins:
retval=plugin.transform_text(« hello world »)
print(« Plugin {plugin} produces {retval} ».format(plugin=plugin, retval=retval))
if \_\_name\_\_ == ‘\_\_main\_\_’:
prog = MyProgram()
prog.main()
As you can see, I have used a utility method to retrieve plugins at a given mount point
class ExtensionsAt(object):
»’ Descriptor to get plugins on a given mount point.
»’
def \_\_init\_\_(self, mount_point):
»’ Initialize the descriptor with the mount point wanted.
Eg: ExtensionsAt(apf.GUIMenu) to get extensions that change the GUI Menu.
»’
self.mount = mount_point
def \_\_get\_\_(self, instance, owner=None):
»’ Plugin are instanciated with the object that is calling them.
»’
return [p(instance) for p in self.mount.plugins]
And that’s it! Provided the plugin classes are loaded in memory, they will be magically executed.
/Library/Frameworks/Python.framework/Versions/3.2/bin/python3.2 /Users/regis/workspace/plugin/apf.py
Plugin HtmlTransformer produces hello world
Plugin HtmlEmTransformer produces <em>hello world</em>
Plugin HtmlBoldTransformer produces <b>hello world</b>
Process finished with exit code 0