refactoring

- rearranged imports
- refactored code based on Pylint recommendations

Author: ashah-splunk

CHANGELOG.md

@@ -1,5 +1,19 @@
 # Splunk Enterprise SDK for Python Changelog
 
+## Version 2.0.0-beta
+
+### Feature updates
+* `ensure_binary`, `ensure_str`, `ensure_text` and `assert_regex` utility methods have been migrated from `six.py` to `splunklib/__init__.py`
+
+### Major changes
+* Removed Code specific to Python2
+* Removed six.py dependency
+* Removed `__future__` imports
+* Refactored & Updated `splunklib` and `tests` to utilise Python3 features
+* Updated CI test matrix to run with Python versions - 3.7, 3.9 and 3.10.7
+* Refactored Code throwing `deprecation` warnings
+* Refactored Code violating Pylint rules
+
 ## Version 1.7.2
 
 ### Minor changes

splunklib/client.py

@@ -692,7 +692,7 @@ def splunk_version(self):
     @property
     def splunk_instance(self):
         if self._instance_type is None :
-            splunk_info = self.info;
+            splunk_info = self.info
             if hasattr(splunk_info, 'instance_type') :
                 self._instance_type = splunk_info['instance_type']
             else:
@@ -1823,7 +1823,7 @@ def __getitem__(self, key):
         # This screws up the default implementation of __getitem__ from Collection, which thinks
         # that multiple entities means a name collision, so we have to override it here.
         try:
-            response = self.get(key)
+            self.get(key)
             return ConfigurationFile(self.service, PATH_CONF % key, state={'title': key})
         except HTTPError as he:
             if he.status == 404:  # No entity matching key
@@ -1835,7 +1835,7 @@ def __contains__(self, key):
         # configs/conf-{name} never returns a 404. We have to post to properties/{name}
         # in order to find out if a configuration exists.
         try:
-            response = self.get(key)
+            self.get(key)
             return True
         except HTTPError as he:
             if he.status == 404:  # No entity matching key
@@ -3617,7 +3617,7 @@ class Roles(Collection):
     Retrieve this collection using :meth:`Service.roles`."""
 
     def __init__(self, service):
-        return Collection.__init__(self, service, PATH_ROLES, item=Role)
+        Collection.__init__(self, service, PATH_ROLES, item=Role)
 
     def __getitem__(self, key):
         return Collection.__getitem__(self, key.lower())

tests/modularinput/modularinput_testlib.py

@@ -14,10 +14,10 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
-# Utility file for unit tests, import common functions and modules
-import unittest
-import sys, os
 import io
+import os
+import sys
+import unittest
 
 sys.path.insert(0, os.path.join('../../splunklib', '..'))
 

tests/modularinput/test_input_definition.py

@@ -70,7 +70,7 @@ def test_attempt_to_parse_malformed_input_definition_will_throw_exception(self):
         """Does malformed XML cause the expected exception."""
 
         with self.assertRaises(ValueError):
-            found = InputDefinition.parse(data_open("data/conf_with_invalid_inputs.xml"))
+            InputDefinition.parse(data_open("data/conf_with_invalid_inputs.xml"))
 
 
 if __name__ == "__main__":

tests/searchcommands/test_decorators.py

@@ -283,7 +283,7 @@ def fix_up(cls, command_class):
 
                 setattr(settings_instance, name, value)
 
-                self.assertIn(backing_field_name, settings_instance.__dict__),
+                self.assertIn(backing_field_name, settings_instance.__dict__)
                 self.assertEqual(getattr(settings_instance, name), value)
                 self.assertEqual(settings_instance.__dict__[backing_field_name], value)
 

tests/searchcommands/test_internals_v1.py

@@ -17,18 +17,16 @@
 from contextlib import closing
 from unittest import main, TestCase
 import os
-import pytest
+from io import StringIO, BytesIO
 from functools import reduce
+import pytest
 
 from splunklib.searchcommands.internals import CommandLineParser, InputHeader, RecordWriterV1
 from splunklib.searchcommands.decorators import Configuration, Option
 from splunklib.searchcommands.validators import Boolean
 
 from splunklib.searchcommands.search_command import SearchCommand
 
-from io import StringIO, BytesIO
-
-
 
 @pytest.mark.smoke
 class TestInternals(TestCase):

tests/test_app.py

@@ -83,7 +83,7 @@ def test_update(self):
 
     def test_delete(self):
         name = testlib.tmpname()
-        app = self.service.apps.create(name)
+        self.service.apps.create(name)
         self.assertTrue(name in self.service.apps)
         self.service.apps.delete(name)
         self.assertFalse(name in self.service.apps)

tests/test_binding.py

@@ -501,7 +501,7 @@ def urllib2_insert_cookie_handler(url, message, **kwargs):
     # Mimic the insertion of 3rd party cookies into the response.
     # An example is "sticky session"/"insert cookie" persistence
     # of a load balancer for a SHC.
-    header_list = [(k, v) for k, v in response.info().items()]
+    header_list = list(response.info().items())
     header_list.append(("Set-Cookie", "BIGipServer_splunk-shc-8089=1234567890.12345.0000; path=/; Httponly; Secure"))
     header_list.append(("Set-Cookie", "home_made=yummy"))
 
@@ -633,7 +633,7 @@ def test_got_updated_cookie_with_get(self):
     def test_login_fails_with_bad_cookie(self):
         # We should get an error if using a bad cookie
         try:
-            new_context = binding.connect(**{"cookie": "bad=cookie"})
+            binding.connect(**{"cookie": "bad=cookie"})
             self.fail()
         except AuthenticationError as ae:
             self.assertEqual(str(ae), "Login failed.")

tests/test_kvstore_batch.py

@@ -16,8 +16,6 @@
 
 from tests import testlib
 
-from splunklib import client
-
 
 class KVStoreBatchTestCase(testlib.SDKTestCase):
     def setUp(self):
@@ -66,7 +64,7 @@ def test_insert_find_update_data(self):
 
     def tearDown(self):
         confs = self.service.kvstore
-        if ('test' in confs):
+        if 'test' in confs:
             confs['test'].delete()
 
 

tests/test_kvstore_conf.py

@@ -17,6 +17,7 @@
 from tests import testlib
 from splunklib import client
 
+
 class KVStoreConfTestCase(testlib.SDKTestCase):
     def setUp(self):
         super().setUp()
@@ -43,7 +44,6 @@ def test_update_collection(self):
         self.assertEqual(self.confs['test']['accelerated_fields.ind1'], '{"a": 1}')
         self.confs['test'].delete()
 
-
     def test_update_fields(self):
         self.confs.create('test')
         self.confs['test'].post(**{'field.a': 'number'})
@@ -52,7 +52,6 @@ def test_update_fields(self):
         self.assertEqual(self.confs['test']['field.a'], 'string')
         self.confs['test'].delete()
 
-
     def test_create_unique_collection(self):
         self.confs.create('test')
         self.assertTrue('test' in self.confs)
@@ -83,9 +82,11 @@ def test_create_accelerated_fields_fields(self):
     """
 
     def tearDown(self):
-        if ('test' in self.confs):
+        if 'test' in self.confs:
             self.confs['test'].delete()
 
+
 if __name__ == "__main__":
     import unittest
+
     unittest.main()