Merge pull request #453 from splunk/py3-modularinput-refactor

Py3 modularinput refactor

Author: ashah-splunk

splunklib/modularinput/argument.py

@@ -12,13 +12,10 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
-from __future__ import absolute_import
-try:
-    import xml.etree.ElementTree as ET
-except ImportError:
-    import xml.etree.cElementTree as ET
+import xml.etree.ElementTree as ET
 
-class Argument(object):
+
+class Argument:
     """Class representing an argument to a modular input kind.
 
     ``Argument`` is meant to be used with ``Scheme`` to generate an XML 
@@ -100,4 +97,4 @@ def add_to_document(self, parent):
         for name, value in subelements:
             ET.SubElement(arg, name).text = str(value).lower()
 
-        return arg
+        return arg

splunklib/modularinput/event.py

@@ -12,16 +12,12 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
-from __future__ import absolute_import
 from io import TextIOBase
+import xml.etree.ElementTree as ET
 from splunklib.six import ensure_text
 
-try:
-    import xml.etree.cElementTree as ET
-except ImportError as ie:
-    import xml.etree.ElementTree as ET
 
-class Event(object):
+class Event:
     """Represents an event or fragment of an event to be written by this modular input to Splunk.
 
     To write an input to a stream, call the ``write_to`` function, passing in a stream.
@@ -111,4 +107,4 @@ def write_to(self, stream):
             stream.write(ensure_text(ET.tostring(event)))
         else:
             stream.write(ET.tostring(event))
-        stream.flush()
+        stream.flush()

splunklib/modularinput/event_writer.py

@@ -12,18 +12,13 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
-from __future__ import absolute_import
 import sys
 
 from splunklib.six import ensure_str
 from .event import ET
 
-try:
-    from splunklib.six.moves import cStringIO as StringIO
-except ImportError:
-    from splunklib.six import StringIO
 
-class EventWriter(object):
+class EventWriter:
     """``EventWriter`` writes events and error messages to Splunk from a modular input.
     Its two important methods are ``writeEvent``, which takes an ``Event`` object,
     and ``log``, which takes a severity and an error message.
@@ -68,7 +63,7 @@ def log(self, severity, message):
         :param message: ``string``, message to log.
         """
 
-        self._err.write("%s %s\n" % (severity, message))
+        self._err.write(f"{severity} {message}\n")
         self._err.flush()
 
     def write_xml_document(self, document):
@@ -83,5 +78,5 @@ def write_xml_document(self, document):
     def close(self):
         """Write the closing </stream> tag to make this XML well formed."""
         if self.header_written:
-          self._out.write("</stream>")
+            self._out.write("</stream>")
         self._out.flush()

splunklib/modularinput/input_definition.py

@@ -12,12 +12,7 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
-from __future__ import absolute_import
-try:
-    import xml.etree.cElementTree as ET
-except ImportError as ie:
-    import xml.etree.ElementTree as ET
-
+import xml.etree.ElementTree as ET
 from .utils import parse_xml_data
 
 class InputDefinition:
@@ -57,4 +52,4 @@ def parse(stream):
             else:
                 definition.metadata[node.tag] = node.text
 
-        return definition
+        return definition

splunklib/modularinput/scheme.py

@@ -12,13 +12,10 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
-from __future__ import absolute_import
-try:
-    import xml.etree.cElementTree as ET
-except ImportError:
-    import xml.etree.ElementTree as ET
+import xml.etree.ElementTree as ET
 
-class Scheme(object):
+
+class Scheme:
     """Class representing the metadata for a modular input kind.
 
     A ``Scheme`` specifies a title, description, several options of how Splunk should run modular inputs of this
@@ -82,4 +79,4 @@ def to_xml(self):
         for arg in self.arguments:
             arg.add_to_document(args)
 
-        return root
+        return root

splunklib/modularinput/script.py

@@ -12,24 +12,18 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
-from __future__ import absolute_import
 from abc import ABCMeta, abstractmethod
-from splunklib.six.moves.urllib.parse import urlsplit
 import sys
+import xml.etree.ElementTree as ET
+from urllib.parse import urlsplit
 
 from ..client import Service
 from .event_writer import EventWriter
 from .input_definition import InputDefinition
 from .validation_definition import ValidationDefinition
-from splunklib import six
 
-try:
-    import xml.etree.cElementTree as ET
-except ImportError:
-    import xml.etree.ElementTree as ET
 
-
-class Script(six.with_metaclass(ABCMeta, object)):
+class Script(metaclass=ABCMeta):
     """An abstract base class for implementing modular inputs.
 
     Subclasses should override ``get_scheme``, ``stream_events``,
@@ -165,7 +159,6 @@ def validate_input(self, definition):
 
         :param definition: The parameters for the proposed input passed by splunkd.
         """
-        pass
 
     @abstractmethod
     def stream_events(self, inputs, ew):

splunklib/modularinput/utils.py

@@ -14,8 +14,7 @@
 
 # File for utility functions
 
-from __future__ import absolute_import
-from splunklib.six.moves import zip
+
 def xml_compare(expected, found):
     """Checks equality of two ``ElementTree`` objects.
 
@@ -39,7 +38,7 @@ def xml_compare(expected, found):
         return False
 
     # compare children
-    if not all([xml_compare(a, b) for a, b in zip(expected_children, found_children)]):
+    if not all(xml_compare(a, b) for a, b in zip(expected_children, found_children)):
         return False
 
     # compare elements, if there is no text node, return True
@@ -59,7 +58,7 @@ def parse_parameters(param_node):
             parameters.append(mvp.text)
         return parameters
     else:
-        raise ValueError("Invalid configuration scheme, %s tag unexpected." % param_node.tag)
+        raise ValueError(f"Invalid configuration scheme, {param_node.tag} tag unexpected.")
 
 def parse_xml_data(parent_node, child_node_tag):
     data = {}

splunklib/modularinput/validation_definition.py

@@ -13,16 +13,12 @@
 # under the License.
 
 
-from __future__ import absolute_import
-try:
-    import xml.etree.cElementTree as ET
-except ImportError as ie:
-    import xml.etree.ElementTree as ET
+import xml.etree.ElementTree as ET
 
 from .utils import parse_xml_data
 
 
-class ValidationDefinition(object):
+class ValidationDefinition:
     """This class represents the XML sent by Splunk for external validation of a
     new modular input.
 
@@ -83,4 +79,4 @@ def parse(stream):
                 # Store anything else in metadata
                 definition.metadata[node.tag] = node.text
 
-        return definition
+        return definition