refractor changes

Author: ashah-splunk

splunklib/__init__.py

@@ -17,7 +17,7 @@
 import logging
 
 DEFAULT_LOG_FORMAT = '%(asctime)s, Level=%(levelname)s, Pid=%(process)s, Logger=%(name)s, File=%(filename)s, ' \
-                 'Line=%(lineno)s, %(message)s'
+                     'Line=%(lineno)s, %(message)s'
 DEFAULT_DATE_FORMAT = '%Y-%m-%d %H:%M:%S %Z'
 
 
@@ -58,6 +58,22 @@ def ensure_str(s, encoding='utf-8', errors='strict'):
     raise TypeError(f"not expecting type '{type(s)}'")
 
 
+def ensure_text(s, encoding='utf-8', errors='strict'):
+    """
+      - `str` -> `str`
+      - `bytes` -> decoded to `str`
+    """
+    if isinstance(s, bytes):
+        return s.decode(encoding, errors)
+    if isinstance(s, str):
+        return s
+    raise TypeError(f"not expecting type '{type(s)}'")
+
+
+def assertRegex(self, *args, **kwargs):
+    return getattr(self, "assertRegex")(*args, **kwargs)
+
+
 __version_info__ = (1, 6, 19)
 
 __version__ = ".".join(map(str, __version_info__))

splunklib/binding.py

@@ -169,15 +169,14 @@ def __new__(self, val='', skip_encode=False, encode_slash=False):
         if isinstance(val, UrlEncoded):
             # Don't urllib.quote something already URL encoded.
             return val
-        elif skip_encode:
+        if skip_encode:
             return str.__new__(self, val)
-        elif encode_slash:
+        if encode_slash:
             return str.__new__(self, parse.quote_plus(val))
-        else:
-            # When subclassing str, just call str.__new__ method
-            # with your class and the value you want to have in the
-            # new string.
-            return str.__new__(self, parse.quote(val))
+       # When subclassing str, just call str.__new__ method
+        # with your class and the value you want to have in the
+        # new string.
+        return str.__new__(self, parse.quote(val))
 
     def __add__(self, other):
         """self + other
@@ -236,8 +235,7 @@ def _handle_auth_error(msg):
     except HTTPError as he:
         if he.status == 401:
             raise AuthenticationError(msg, he)
-        else:
-            raise
+        raise
 
 
 def _authentication(request_fun):
@@ -305,8 +303,7 @@ def wrapper(self, *args, **kwargs):
             elif he.status == 401 and not self.autologin:
                 raise AuthenticationError(
                     "Request failed: Session is not logged in.", he)
-            else:
-                raise
+            raise
 
     return wrapper
 
@@ -533,14 +530,14 @@ def _auth_headers(self):
         """
         if self.has_cookies():
             return [("Cookie", _make_cookie_header(list(self.get_cookies().items())))]
-        elif self.basic and (self.username and self.password):
+        if self.basic and (self.username and self.password):
             encoded_username_password = b64encode(f"{self.username}:{self.password}".encode('utf-8')).decode('ascii')
             token = f'Basic {encoded_username_password}'
             return [("Authorization", token)]
-        elif self.bearerToken:
+        if self.bearerToken:
             token = f"Bearer {self.bearerToken}"
             return [("Authorization", token)]
-        elif self.token is _NoAuthenticationToken:
+        if self.token is _NoAuthenticationToken:
             return []
         else:
             # Ensure the token is properly formatted
@@ -925,8 +922,7 @@ def login(self):
         except HTTPError as he:
             if he.status == 401:
                 raise AuthenticationError("Login failed.", he)
-            else:
-                raise
+            raise
 
     def logout(self):
         """Forgets the current session token, and cookies."""
@@ -1304,9 +1300,8 @@ def request(self, url, message, **kwargs):
             except Exception:
                 if self.retries <= 0:
                     raise
-                else:
-                    time.sleep(self.retryDelay)
-                    self.retries -= 1
+                time.sleep(self.retryDelay)
+                self.retries -= 1
         response = record(response)
         if 400 <= response.status:
             raise HTTPError(response)

splunklib/client.py

@@ -212,10 +212,9 @@ def _load_atom_entries(response):
     # its state wrapped in another element, but at the top level.
     # For example, in XML, it returns <entry>...</entry> instead of
     # <feed><entry>...</entry></feed>.
-    else:
-        entries = r.get('entry', None)
-        if entries is None: return None
-        return entries if isinstance(entries, list) else [entries]
+    entries = r.get('entry', None)
+    if entries is None: return None
+    return entries if isinstance(entries, list) else [entries]
 
 
 # Load the sid from the body of the given response
@@ -530,8 +529,7 @@ def modular_input_kinds(self):
         """
         if self.splunk_version >= (5,):
             return ReadOnlyCollection(self, PATH_MODULAR_INPUTS, item=ModularInputKind)
-        else:
-            raise IllegalOperationException("Modular inputs are not supported before Splunk version 5.")
+        raise IllegalOperationException("Modular inputs are not supported before Splunk version 5.")
 
     @property
     def storage_passwords(self):
@@ -926,7 +924,6 @@ def __init__(self, service, path, **kwargs):
         self._state = None
         if not kwargs.get('skip_refresh', False):
             self.refresh(kwargs.get('state', None))  # "Prefresh"
-        return
 
     def __contains__(self, item):
         try:
@@ -963,10 +960,9 @@ def __getattr__(self, key):
         # case we try to find it in self.content and then self.defaults.
         if key in self.state.content:
             return self.state.content[key]
-        elif key in self.defaults:
+        if key in self.defaults:
             return self.defaults[key]
-        else:
-            raise AttributeError(key)
+        raise AttributeError(key)
 
     def __getitem__(self, key):
         # getattr attempts to find a field on the object in the normal way,
@@ -1022,8 +1018,7 @@ def _proper_namespace(self, owner=None, app=None, sharing=None):
                 return (self._state.access.owner,
                         self._state.access.app,
                         self._state.access.sharing)
-            else:
-                return (self.service.namespace['owner'],
+            return (self.service.namespace['owner'],
                         self.service.namespace['app'],
                         self.service.namespace['sharing'])
         else:
@@ -1272,15 +1267,13 @@ def __getitem__(self, key):
             if len(entries) > 1:
                 raise AmbiguousReferenceException(
                     f"Found multiple entities named '{key}'; please specify a namespace.")
-            elif len(entries) == 0:
+            if len(entries) == 0:
                 raise KeyError(key)
-            else:
-                return entries[0]
+            return entries[0]
         except HTTPError as he:
             if he.status == 404:  # No entity matching key and namespace.
                 raise KeyError(key)
-            else:
-                raise
+            raise
 
     def __iter__(self, **kwargs):
         """Iterate over the entities in the collection.
@@ -1344,10 +1337,9 @@ def _entity_path(self, state):
         raw_path = parse.unquote(state.links.alternate)
         if 'servicesNS/' in raw_path:
             return _trailing(raw_path, 'servicesNS/', '/', '/')
-        elif 'services/' in raw_path:
+        if 'services/' in raw_path:
             return _trailing(raw_path, 'services/')
-        else:
-            return raw_path
+        return raw_path
 
     def _load_list(self, response):
         """Converts *response* to a list of entities.
@@ -1596,14 +1588,13 @@ def create(self, name, **params):
             # This endpoint doesn't return the content of the new
             # item. We have to go fetch it ourselves.
             return self[name]
-        else:
-            entry = atom.entry
-            state = _parse_atom_entry(entry)
-            entity = self.item(
-                self.service,
-                self._entity_path(state),
-                state=state)
-            return entity
+        entry = atom.entry
+        state = _parse_atom_entry(entry)
+        entity = self.item(
+            self.service,
+            self._entity_path(state),
+            state=state)
+        return entity
 
     def delete(self, name, **params):
         """Deletes a specified entity from the collection.
@@ -1644,8 +1635,7 @@ def delete(self, name, **params):
             # KeyError.
             if he.status == 404:
                 raise KeyError(f"No such entity {name}")
-            else:
-                raise
+            raise
         return self
 
     def get(self, name="", owner=None, app=None, sharing=None, **query):
@@ -1749,8 +1739,7 @@ def __contains__(self, key):
         except HTTPError as he:
             if he.status == 404:  # No entity matching key
                 return False
-            else:
-                raise
+            raise
 
     def create(self, name):
         """ Creates a configuration file named *name*.
@@ -1771,10 +1760,9 @@ def create(self, name):
         response = self.post(__conf=name)
         if response.status == 303:
             return self[name]
-        elif response.status == 201:
+        if response.status == 201:
             return ConfigurationFile(self.service, PATH_CONF % name, item=Stanza, state={'title': name})
-        else:
-            raise ValueError(f"Unexpected status code {response.status} returned from creating a stanza")
+        raise ValueError(f"Unexpected status code {response.status} returned from creating a stanza")
 
     def delete(self, key):
         """Raises `IllegalOperationException`."""
@@ -2203,7 +2191,7 @@ def update(self, **kwargs):
 
             if 'restrictToHost' in kwargs:
                 raise IllegalOperationException("Cannot set restrictToHost on an existing input with the SDK.")
-            elif 'restrictToHost' in self._state.content and self.kind != 'udp':
+            if 'restrictToHost' in self._state.content and self.kind != 'udp':
                 to_update['restrictToHost'] = self._state.content['restrictToHost']
 
             # Do the actual update operation.
@@ -2235,10 +2223,9 @@ def __getitem__(self, key):
                 entries = self._load_list(response)
                 if len(entries) > 1:
                     raise AmbiguousReferenceException(f"Found multiple inputs of kind {kind} named {key}.")
-                elif len(entries) == 0:
+                if len(entries) == 0:
                     raise KeyError((key, kind))
-                else:
-                    return entries[0]
+                return entries[0]
             except HTTPError as he:
                 if he.status == 404:  # No entity matching kind and key
                     raise KeyError((key, kind))

splunklib/data.py

@@ -88,10 +88,9 @@ def load(text, match=None):
     count = len(items)
     if count == 0:
         return None
-    elif count == 1:
+    if count == 1:
         return load_root(items[0], nametable)
-    else:
-        return [load_root(item, nametable) for item in items]
+    return [load_root(item, nametable) for item in items]
 
 
 # Load the attributes of the given element.

splunklib/modularinput/argument.py

@@ -18,7 +18,7 @@ class Argument:
 
     """Class representing an argument to a modular input kind.
 
-    ``Argument`` is meant to be used with ``Scheme`` to generate an XML 
+    ``Argument`` is meant to be used with ``Scheme`` to generate an XML
     definition of the modular input kind that Splunk understands.
 
     ``name`` is the only required parameter for the constructor.

splunklib/modularinput/event.py

@@ -14,7 +14,8 @@
 
 from io import TextIOBase
 import xml.etree.ElementTree as ET
-from splunklib.six import ensure_text
+
+from splunklib import ensure_text
 
 
 class Event:

splunklib/modularinput/event_writer.py

@@ -14,7 +14,7 @@
 
 import sys
 
-from splunklib.six import ensure_str
+from splunklib import ensure_str
 from .event import ET
 
 

splunklib/modularinput/script.py

@@ -68,7 +68,7 @@ def run_script(self, args, event_writer, input_stream):
                 event_writer.close()
                 return 0
 
-            elif str(args[1]).lower() == "--scheme":
+            if str(args[1]).lower() == "--scheme":
                 # Splunk has requested XML specifying the scheme for this
                 # modular input Return it and exit.
                 scheme = self.get_scheme()
@@ -77,9 +77,8 @@ def run_script(self, args, event_writer, input_stream):
                         EventWriter.FATAL,
                         "Modular input script returned a null scheme.")
                     return 1
-                else:
-                    event_writer.write_xml_document(scheme.to_xml())
-                    return 0
+                event_writer.write_xml_document(scheme.to_xml())
+                return 0
 
             elif args[1].lower() == "--validate-arguments":
                 validation_definition = ValidationDefinition.parse(input_stream)

splunklib/modularinput/utils.py

@@ -45,14 +45,13 @@ def xml_compare(expected, found):
     if (expected.text is None or expected.text.strip() == "") \
         and (found.text is None or found.text.strip() == ""):
         return True
-    else:
-        return expected.tag == found.tag and expected.text == found.text \
+    return expected.tag == found.tag and expected.text == found.text \
             and expected.attrib == found.attrib
 
 def parse_parameters(param_node):
     if param_node.tag == "param":
         return param_node.text
-    elif param_node.tag == "param_list":
+    if param_node.tag == "param_list":
         parameters = []
         for mvp in param_node:
             parameters.append(mvp.text)