style: add pyupgrade and isort to pre-commit (#552)

* style: pre-commit update

* style: apply pyupgrade

* style: apply isort

Author: artemrys

.pre-commit-config.yaml

@@ -19,7 +19,17 @@ repos:
     hooks:
     -   id: check-merge-conflict
     -   id: debug-statements
+-   repo: https://github.com/asottile/pyupgrade
+    rev: v2.31.0
+    hooks:
+    -   id: pyupgrade
+        args:
+        - --py37-plus
 -   repo: https://github.com/psf/black
-    rev: 21.12b0
+    rev: 22.1.0
     hooks:
     -   id: black
+-   repo: https://github.com/PyCQA/isort
+    rev: 5.10.1
+    hooks:
+    -   id: isort

docs/conf.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 #
 # Configuration file for the Sphinx documentation builder.
 #
@@ -14,21 +13,22 @@
 #
 import os
 import sys
+
 import sphinx_rtd_theme
 
 sys.path.insert(0, os.path.abspath("../pytest_splunk_addon"))
 
 
 # -- Project information -----------------------------------------------------
 
-project = u"pytest-splunk-addon"
-copyright = u"2021, Splunk, Inc."
-author = u"Splunk, Inc."
+project = "pytest-splunk-addon"
+copyright = "2021, Splunk, Inc."
+author = "Splunk, Inc."
 
 # The short X.Y version
-version = u""
+version = ""
 # The full version, including alpha/beta/rc tags
-release = u""
+release = ""
 
 
 # -- General configuration ---------------------------------------------------
@@ -134,8 +134,8 @@
     (
         master_doc,
         "pytest-splunk-addon.tex",
-        u"pytest-splunk-addon Documentation",
-        u"Splunk, Inc.",
+        "pytest-splunk-addon Documentation",
+        "Splunk, Inc.",
         "manual",
     ),
 ]
@@ -149,7 +149,7 @@
     (
         master_doc,
         "pytest-splunk-addon",
-        u"pytest-splunk-addon Documentation",
+        "pytest-splunk-addon Documentation",
         [author],
         1,
     )
@@ -165,7 +165,7 @@
     (
         master_doc,
         "pytest-splunk-addon",
-        u"pytest-splunk-addon Documentation",
+        "pytest-splunk-addon Documentation",
         author,
         "pytest-splunk-addon",
         "One line description of project.",

pyproject.toml

@@ -59,6 +59,9 @@ pytz = "^2021.1"
 sphinx-rtd-theme = "^1.0.0"
 sphinx-panels = "^0.6.0"
 
+[tool.isort]
+profile = "black"
+
 [tool.poetry.plugins]
 pytest11 = { plugin = "pytest_splunk_addon.plugin", "splunk" = "pytest_splunk_addon.splunk" }
 

pytest_splunk_addon/helmut/connector/sdk.py

@@ -16,8 +16,8 @@
 import logging
 import time
 
-from splunklib.binding import _NoAuthenticationToken, AuthenticationError
-from splunklib.client import Service, Endpoint
+from splunklib.binding import AuthenticationError, _NoAuthenticationToken
+from splunklib.client import Endpoint, Service
 
 LOGGER = logging.getLogger("helmut")
 
@@ -265,13 +265,11 @@ def is_logged_in(self):
             # FAST-8222
         except AuthenticationError as err:
             LOGGER.debug(
-                "SDKconnector %s:%s is NOT logged in" % (self.username, self.password)
+                f"SDKconnector {self.username}:{self.password} is NOT logged in"
             )
             return False
         else:
-            LOGGER.debug(
-                "SDKconnector %s:%s is logged in" % (self.username, self.password)
-            )
+            LOGGER.debug(f"SDKconnector {self.username}:{self.password} is logged in")
             return True
 
     def _was_logged_in(self):

pytest_splunk_addon/helmut/exceptions/job.py

@@ -16,8 +16,8 @@
 class JobNotFound(RuntimeError):
     def __init__(self, sid):
         self.sid = sid
-        super(JobNotFound, self).__init__(self._error_message)
+        super().__init__(self._error_message)
 
     @property
     def _error_message(self):
-        return "Could not find a job with SID {sid}".format(sid=self.sid)
+        return f"Could not find a job with SID {self.sid}"

pytest_splunk_addon/helmut/exceptions/search.py

@@ -20,7 +20,7 @@ class SearchFailure(RuntimeError):
 
     def __init__(self, search_message):
         self.search_message = search_message
-        super(SearchFailure, self).__init__(self._error_message)
+        super().__init__(self._error_message)
 
     @property
     def _error_message(self):

pytest_splunk_addon/helmut/exceptions/wait.py

@@ -20,7 +20,7 @@ class WaitTimedOut(RuntimeError):
 
     def __init__(self, seconds_waited):
         self.seconds_waited = seconds_waited
-        super(WaitTimedOut, self).__init__(self._error_message)
+        super().__init__(self._error_message)
 
     @property
     def _error_message(self):

pytest_splunk_addon/helmut/manager/jobs/results.py

@@ -16,7 +16,7 @@
 import copy
 
 
-class Results(object):
+class Results:
     """
     A class that represents a result set.
 
@@ -61,7 +61,7 @@ def __init__(self, results_):
         @param results_: The raw results as returned by ResultReader
         @type results_: list
         """
-        super(Results, self).__init__()
+        super().__init__()
 
         self._list = results_
         self._dict_cache = None
@@ -73,7 +73,7 @@ def __repr__(self):
         @return: The representation
         @rtype: str
         """
-        return "Results set with {count} result(s)".format(count=len(self))
+        return f"Results set with {len(self)} result(s)"
 
     def get_field(self, field):
         """

pytest_splunk_addon/helmut/manager/jobs/sdk/__init__.py

@@ -41,8 +41,7 @@ def __len__(self):
         return len(list(self.items()))
 
     def __iter__(self):
-        for item in list(self.items()):
-            yield item
+        yield from list(self.items())
 
     def __contains__(self, sid):
         for job in self:

pytest_splunk_addon/helmut/manager/jobs/sdk/job.py

@@ -18,9 +18,9 @@
 
 import splunklib.results as results
 
-from pytest_splunk_addon.helmut.manager.jobs.results import Results
 from pytest_splunk_addon.helmut.exceptions.search import SearchFailure
 from pytest_splunk_addon.helmut.exceptions.wait import WaitTimedOut
+from pytest_splunk_addon.helmut.manager.jobs.results import Results
 
 LOGGER = logging.getLogger("helmut")
 
@@ -49,7 +49,7 @@ def sid(self):
         return self.raw_sdk_job.sid
 
     def __str__(self):
-        return "SDK Job with SID {sid}".format(sid=self.sid)
+        return f"SDK Job with SID {self.sid}"
 
     def get_event_count(self):
         return int(self.raw_sdk_job.refresh().content.eventCount)