From 5fa80f5d7609e60daee6a14476182e73f33c2cf7 Mon Sep 17 00:00:00 2001
From: Adrian Likins <alikins@redhat.com>
Date: Mon, 24 Sep 2007 11:49:34 -0400
Subject: add some simple support for base object methods

add "module_version", "module_api_version" and "module_description" as
base object methods. All classes based on func_module should get this.

modules should set a self.version, self.api_version, self.description
with approriate values. class or instance variables both work. If
values aren't set, defaults are provided.

alternativelt, the modules can implement and export "module_version",
"module_api_version", and "module_description" themself if they
like
---
 modules/func_module.py | 23 ++++++++++++++++++++++-
 modules/test.py        |  3 +++
 2 files changed, 25 insertions(+), 1 deletion(-)

(limited to 'modules')

diff --git a/modules/func_module.py b/modules/func_module.py
index 4bb06d2..7019bc5 100755
--- a/modules/func_module.py
+++ b/modules/func_module.py
@@ -24,20 +24,41 @@ import traceback
 
 
 class FuncModule(object):
+    version = "0.0.0"
+    api_version = "0.0.0"
+    description = "No Description provided"
+    
     def __init__(self):
 
         config_obj = config_data.Config()
         config_result = config_obj.get()
         self.config = config_result
         self.__init_log()
+        self.__base_methods = {
+            # __'s so we don't clobber useful names
+            "module_version" : self.__module_version,
+            "module_api_version" : self.__module_api_version,
+            "module_description" : self.__module_description,
+            }
         
     def __init_log(self):
         log = logger.Logger()
         self.logger = log.logger
     
     def register_rpc(self, handlers, module_name):
+        # add the internal methods, note that this means they
+        # can get clobbbered by subclass versions
+        for meth in self.__base_methods:
+            handlers["%s.%s" % (module_name, meth)] = self.__base_methods[meth]
         for meth in self.methods:
             handlers["%s.%s" % (module_name,meth)] = self.methods[meth]
-            
 
+    def __module_version(self):
+        return self.version
+
+    def __module_api_version(self):
+        return self.api_version
+
+    def __module_description(self):
+        return self.description
 
diff --git a/modules/test.py b/modules/test.py
index 31f1e94..ea22007 100755
--- a/modules/test.py
+++ b/modules/test.py
@@ -4,6 +4,9 @@ from codes import *
 from modules import func_module
 
 class Test(func_module.FuncModule):
+    version = "11.11.11"
+    api_version = "0.0.1"
+    description = "Just a very simple example module"
     def __init__(self):
         self.methods = {
             "add": self.add
-- 
cgit