code changes based on Pylint and 2to3 tool suggestions

Author: ashah-splunk

tests/modularinput/modularinput_testlib.py

@@ -15,11 +15,7 @@
 # under the License.
 
 # Utility file for unit tests, import common functions and modules
-from __future__ import absolute_import
-try:
-    import unittest2 as unittest
-except ImportError:
-    import unittest
+import unittest
 import sys, os
 import io
 

tests/modularinput/test_event.py

@@ -14,13 +14,12 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
-from __future__ import absolute_import
 
 import sys
 
 import pytest
 
-from tests.modularinput.modularinput_testlib import unittest, xml_compare, data_open
+from tests.modularinput.modularinput_testlib import xml_compare, data_open
 from splunklib.modularinput.event import Event, ET
 from splunklib.modularinput.event_writer import EventWriter
 
@@ -99,7 +98,7 @@ def test_writing_events_on_event_writer(capsys):
     first_out_part = captured.out
 
     with data_open("data/stream_with_one_event.xml") as data:
-        found = ET.fromstring("%s</stream>" % first_out_part)
+        found = ET.fromstring(f"{first_out_part}</stream>")
         expected = ET.parse(data).getroot()
 
         assert xml_compare(expected, found)

tests/modularinput/test_input_definition.py

@@ -14,10 +14,10 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
-from __future__ import absolute_import
 from tests.modularinput.modularinput_testlib import unittest, data_open
 from splunklib.modularinput.input_definition import InputDefinition
 
+
 class InputDefinitionTestCase(unittest.TestCase):
 
     def test_parse_inputdef_with_zero_inputs(self):
@@ -72,5 +72,6 @@ def test_attempt_to_parse_malformed_input_definition_will_throw_exception(self):
         with self.assertRaises(ValueError):
             found = InputDefinition.parse(data_open("data/conf_with_invalid_inputs.xml"))
 
+
 if __name__ == "__main__":
-    unittest.main()
+    unittest.main()

tests/modularinput/test_scheme.py

@@ -13,15 +13,11 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
-from __future__ import absolute_import
+import xml.etree.ElementTree as ET
 from tests.modularinput.modularinput_testlib import unittest, xml_compare, data_open
 from splunklib.modularinput.scheme import Scheme
 from splunklib.modularinput.argument import Argument
 
-try:
-    import xml.etree.cElementTree as ET
-except ImportError:
-    import xml.etree.ElementTree as ET
 
 class SchemeTest(unittest.TestCase):
     def test_generate_xml_from_scheme_with_default_values(self):
@@ -40,7 +36,7 @@ def test_generate_xml_from_scheme(self):
         some arguments added matches what we expect."""
 
         scheme = Scheme("abcd")
-        scheme.description = u"쎼 and 쎶 and <&> für"
+        scheme.description = "쎼 and 쎶 and <&> für"
         scheme.streaming_mode = Scheme.streaming_mode_simple
         scheme.use_external_validation = "false"
         scheme.use_single_instance = "true"
@@ -50,7 +46,7 @@ def test_generate_xml_from_scheme(self):
 
         arg2 = Argument(
             name="arg2",
-            description=u"쎼 and 쎶 and <&> für",
+            description="쎼 and 쎶 and <&> für",
             validation="is_pos_int('some_name')",
             data_type=Argument.data_type_number,
             required_on_edit=True,
@@ -69,7 +65,7 @@ def test_generate_xml_from_scheme_with_arg_title(self):
         some arguments added matches what we expect. Also sets the title on an argument."""
 
         scheme = Scheme("abcd")
-        scheme.description = u"쎼 and 쎶 and <&> für"
+        scheme.description = "쎼 and 쎶 and <&> für"
         scheme.streaming_mode = Scheme.streaming_mode_simple
         scheme.use_external_validation = "false"
         scheme.use_single_instance = "true"
@@ -79,7 +75,7 @@ def test_generate_xml_from_scheme_with_arg_title(self):
 
         arg2 = Argument(
             name="arg2",
-            description=u"쎼 and 쎶 and <&> für",
+            description="쎼 and 쎶 and <&> für",
             validation="is_pos_int('some_name')",
             data_type=Argument.data_type_number,
             required_on_edit=True,
@@ -113,7 +109,7 @@ def test_generate_xml_from_argument(self):
 
         argument = Argument(
             name="some_name",
-            description=u"쎼 and 쎶 and <&> für",
+            description="쎼 and 쎶 and <&> für",
             validation="is_pos_int('some_name')",
             data_type=Argument.data_type_boolean,
             required_on_edit="true",

tests/modularinput/test_script.py

@@ -1,16 +1,13 @@
 import sys
 
+import io
+import xml.etree.ElementTree as ET
 from splunklib.client import Service
 from splunklib.modularinput import Script, EventWriter, Scheme, Argument, Event
-import io
 
 from splunklib.modularinput.utils import xml_compare
 from tests.modularinput.modularinput_testlib import data_open
 
-try:
-    import xml.etree.cElementTree as ET
-except ImportError:
-    import xml.etree.ElementTree as ET
 
 TEST_SCRIPT_PATH = "__IGNORED_SCRIPT_PATH__"
 
@@ -51,7 +48,7 @@ def test_scheme_properly_generated_by_script(capsys):
     class NewScript(Script):
         def get_scheme(self):
             scheme = Scheme("abcd")
-            scheme.description = u"\uC3BC and \uC3B6 and <&> f\u00FCr"
+            scheme.description = "\uC3BC and \uC3B6 and <&> f\u00FCr"
             scheme.streaming_mode = scheme.streaming_mode_simple
             scheme.use_external_validation = False
             scheme.use_single_instance = True
@@ -60,7 +57,7 @@ def get_scheme(self):
             scheme.add_argument(arg1)
 
             arg2 = Argument("arg2")
-            arg2.description = u"\uC3BC and \uC3B6 and <&> f\u00FCr"
+            arg2.description = "\uC3BC and \uC3B6 and <&> f\u00FCr"
             arg2.data_type = Argument.data_type_number
             arg2.required_on_create = True
             arg2.required_on_edit = True
@@ -208,7 +205,7 @@ def test_service_property(capsys):
     # Override abstract methods
     class NewScript(Script):
         def __init__(self):
-            super(NewScript, self).__init__()
+            super().__init__()
             self.authority_uri = None
 
         def get_scheme(self):

tests/modularinput/test_validation_definition.py

@@ -14,10 +14,11 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
-from __future__ import absolute_import
+
 from tests.modularinput.modularinput_testlib import unittest, data_open
 from splunklib.modularinput.validation_definition import ValidationDefinition
 
+
 class ValidationDefinitionTestCase(unittest.TestCase):
     def test_validation_definition_parse(self):
         """Check that parsing produces expected result"""
@@ -42,5 +43,6 @@ def test_validation_definition_parse(self):
 
         self.assertEqual(expected, found)
 
+
 if __name__ == "__main__":
-    unittest.main()
+    unittest.main()

tests/searchcommands/__init__.py

@@ -15,10 +15,6 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
-from __future__ import absolute_import, division, print_function, unicode_literals
-
-from sys import version_info as python_version
-
 from os import path
 import logging
 

tests/searchcommands/chunked_data_stream.py

@@ -7,7 +7,7 @@
 from splunklib import six
 
 
-class Chunk(object):
+class Chunk:
     def __init__(self, version, meta, data):
         self.version = six.ensure_str(version)
         self.meta = json.loads(meta)
@@ -21,9 +21,9 @@ def __init__(self, chunk_stream):
         self.chunk_stream = chunk_stream
 
     def __next__(self):
-        return self.next()
+        return next(self)
 
-    def next(self):
+    def __next__(self):
         try:
             return self.chunk_stream.read_chunk()
         except EOFError:
@@ -91,7 +91,7 @@ def _build_data_csv(data):
 
     headers = set()
     for datum in data:
-        headers.update(datum.keys())
+        headers.update(list(datum.keys()))
     writer = csv.DictWriter(csvout, headers,
                             dialect=splunklib.searchcommands.internals.CsvDialect)
     writer.writeheader()

tests/searchcommands/test_builtin_options.py

@@ -15,19 +15,15 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
-from __future__ import absolute_import, division, print_function, unicode_literals
-
-from splunklib.six.moves import cStringIO as StringIO
-try:
-    from unittest2 import main, TestCase
-except ImportError:
-    from unittest import main, TestCase
 
 import os
 import sys
 import logging
 
 import pytest
+from unittest import main, TestCase
+from splunklib.six.moves import cStringIO as StringIO
+
 
 from splunklib.searchcommands import environment
 from splunklib.searchcommands.decorators import Configuration
@@ -117,18 +113,18 @@ def test_logging_configuration(self):
         except ValueError:
             pass
         except BaseException as e:
-            self.fail('Expected ValueError, but {} was raised'.format(type(e)))
+            self.fail(f'Expected ValueError, but {type(e)} was raised')
         else:
-            self.fail('Expected ValueError, but logging_configuration={}'.format(command.logging_configuration))
+            self.fail(f'Expected ValueError, but logging_configuration={command.logging_configuration}')
 
         try:
             command.logging_configuration = os.path.join(package_directory, 'non-existent.logging.conf')
         except ValueError:
             pass
         except BaseException as e:
-            self.fail('Expected ValueError, but {} was raised'.format(type(e)))
+            self.fail(f'Expected ValueError, but {type(e)} was raised')
         else:
-            self.fail('Expected ValueError, but logging_configuration={}'.format(command.logging_configuration))
+            self.fail(f'Expected ValueError, but logging_configuration={command.logging_configuration}')
 
     def test_logging_level(self):
 
@@ -146,7 +142,7 @@ def test_logging_level(self):
         self.assertEqual(warning, command.logging_level)
 
         for level in level_names():
-            if type(level) is int:
+            if isinstance(level, int):
                 command.logging_level = level
                 level_name = logging.getLevelName(level)
                 self.assertEqual(command.logging_level, warning if level_name == notset else level_name)
@@ -171,9 +167,9 @@ def test_logging_level(self):
         except ValueError:
             pass
         except BaseException as e:
-            self.fail('Expected ValueError, but {} was raised'.format(type(e)))
+            self.fail(f'Expected ValueError, but {type(e)} was raised')
         else:
-            self.fail('Expected ValueError, but logging_level={}'.format(command.logging_level))
+            self.fail(f'Expected ValueError, but logging_level={command.logging_level}')
 
         self.assertEqual(command.logging_level, current_value)
 
@@ -211,13 +207,9 @@ def _test_boolean_option(self, option):
             except ValueError:
                 pass
             except BaseException as error:
-                self.fail('Expected ValueError when setting {}={}, but {} was raised'.format(
-                    option.name, repr(value), type(error)))
+                self.fail(f'Expected ValueError when setting {option.name}={repr(value)}, but {type(error)} was raised')
             else:
-                self.fail('Expected ValueError, but {}={} was accepted.'.format(
-                    option.name, repr(option.fget(command))))
-
-        return
+                self.fail(f'Expected ValueError, but {option.name}={repr(option.fget(command))} was accepted.')
 
 
 if __name__ == "__main__":