More code cleanup

Shakeel Mohamed · Shakeel Mohamed · commit 0b1d678ec1ec · 2013-07-29T14:11:49.000-07:00
diff --git a/splunklib/modularinput/argument.py b/splunklib/modularinput/argument.py
@@ -84,8 +84,14 @@ def add_to_document(self, parent):
         if self.validation is not None:
             ET.SubElement(arg, "validation").text = self.validation
 
-        ET.SubElement(arg, "data_type").text = self.data_type.lower()
-        ET.SubElement(arg, "required_on_edit").text = str(self.required_on_edit).lower()
-        ET.SubElement(arg, "required_on_create").text = str(self.required_on_create).lower()
+        # add all other subelements to this Argument, represented by (tag, text)
+        subelements = [
+            ("data_type", self.data_type),
+            ("required_on_edit", self.required_on_edit),
+            ("required_on_create", self.required_on_create)
+        ]
+
+        for name, value in subelements:
+            ET.SubElement(arg, name).text = str(value).lower()
 
         return arg
diff --git a/splunklib/modularinput/event.py b/splunklib/modularinput/event.py
@@ -88,7 +88,7 @@ def write_to(self, stream):
         if self.time is not None:
             ET.SubElement(event, "time").text = str(self.time)
 
-        # add all other subelements to this event, represented by (tag, text)
+        # add all other subelements to this Event, represented by (tag, text)
         subelements = [
             ("source", self.source),
             ("sourceType", self.sourceType),
diff --git a/splunklib/modularinput/event_writer.py b/splunklib/modularinput/event_writer.py
@@ -12,9 +12,10 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
-from splunklib.modularinput.event import ET
 import sys
 
+from splunklib.modularinput.event import ET
+
 try:
     from cStringIO import StringIO
 except ImportError:
diff --git a/splunklib/modularinput/input_definition.py b/splunklib/modularinput/input_definition.py
@@ -14,6 +14,7 @@
     import xml.etree.cElementTree as ET
 except ImportError as ie:
     import xml.etree.ElementTree as ET
+
 from utils import parse_xml_data
 
 class InputDefinition:
diff --git a/splunklib/modularinput/scheme.py b/splunklib/modularinput/scheme.py
@@ -64,14 +64,14 @@ def to_xml(self):
         if self.description is not None:
             ET.SubElement(root, "description").text = self.description
 
-        # add other subelements; represented by (tag, text)
+        # add all other subelements to this Scheme, represented by (tag, text)
         subelements = [
-            ("use_external_validation", str(self.use_external_validation).lower()),
-            ("use_single_instance", str(self.use_single_instance).lower()),
-            ("streaming_mode", self.streaming_mode.lower())
+            ("use_external_validation", self.use_external_validation),
+            ("use_single_instance", self.use_single_instance),
+            ("streaming_mode", self.streaming_mode)
         ]
         for name, value in subelements:
-            ET.SubElement(root, name).text = value
+            ET.SubElement(root, name).text = str(value).lower()
 
         endpoint = ET.SubElement(root, "endpoint")
 
diff --git a/splunklib/modularinput/script.py b/splunklib/modularinput/script.py
@@ -13,10 +13,11 @@
 # under the License.
 
 from abc import ABCMeta, abstractmethod
+import sys
+
+from splunklib.modularinput.event_writer import EventWriter
 from splunklib.modularinput.input_definition import InputDefinition
 from splunklib.modularinput.validation_definition import ValidationDefinition
-from splunklib.modularinput.event_writer import EventWriter
-import sys
 
 try:
     import xml.etree.cElementTree as ET
@@ -28,28 +29,32 @@ class Script(object):
     """An abstract base class for implementing modular inputs.
 
     Subclasses should override get_scheme, stream_events,
-    and optional validate_input if the modular Input uses
+    and optionally validate_input if the modular Input uses
     external validation.
 
-    The important function is run, which is used to run modular inputs
+    The run function is used to run modular inputs, it typically should
+    not be overridden.
     """
     __metaclass__ = ABCMeta
 
     def run(self, args):
-        """This function is stable, call run to run a modular input
+        """Run this modular input
 
-        :param args: String[] args from Java
-        :return:
+        :param args: list of command line arguments passed to this script
+        :return: an integer to be used as the exit value of this program
         """
+
+        # call the run_script function, which handles the specifics of running
+        # a modular input
         return self.run_script(args, EventWriter(), sys.stdin)
 
     def run_script(self, args, event_writer, input_stream):
         """Handles all the specifics of running a modular input
 
-        :param args:
-        :param event_writer:
-        :param input_stream:
-        :return:
+        :param args: list of command line arguments passed to this script
+        :param event_writer: an EventWriter object for writing events
+        :param input_stream: an input stream for reading inputs
+        :return: an integer to be used as the exit value of this program
         """
 
         try:
@@ -83,9 +88,9 @@ def run_script(self, args, event_writer, input_stream):
                     event_writer.write_xml_document(root)
 
                     return 1
-
-            err_string = "ERROR Invalid arguments to modular input script:" + ' '.join(args)
-            event_writer._err.write(err_string)
+            else:
+                err_string = "ERROR Invalid arguments to modular input script:" + ' '.join(args)
+                event_writer._err.write(err_string)
 
         except Exception as e:
             err_string = EventWriter.ERROR + e.message
@@ -112,6 +117,8 @@ def validate_input(self, definition):
 
         :param definition: The parameters for the proposed input passed by splunkd
         """
+        pass
+
     @abstractmethod
     def stream_events(self, inputs, ew):
         """The method called to stream events into Splunk. It should do all of its output via
@@ -120,4 +127,3 @@ def stream_events(self, inputs, ew):
         :param inputs: an InputDefinition object
         :param ew: an object with methods to write events and log messages to Splunk
         """
-        return
diff --git a/splunklib/modularinput/validation_definition.py b/splunklib/modularinput/validation_definition.py
@@ -17,6 +17,7 @@
     import xml.etree.cElementTree as ET
 except ImportError as ie:
     import xml.etree.ElementTree as ET
+
 from utils import parse_xml_data
 
 class ValidationDefinition(object):
