chore: update pre-commit hooks and modernize type hints to Python 3.9+

Author: wtobis-splunk

.pre-commit-config.yaml

@@ -3,16 +3,17 @@ repos:
     rev: v3.1.0
     hooks:
     -   id: pyupgrade
-        args: [--py37-plus]
+        args: [--py39-plus]
 -   repo: https://github.com/psf/black
     rev: 22.10.0
     hooks:
     -   id: black
--   repo: https://github.com/myint/docformatter
-    rev: v1.5.0
+-   repo: https://github.com/PyCQA/docformatter
+    rev: v1.7.7
     hooks:
       - id: docformatter
         args: [--in-place]
+        language_version: python3
 -   repo: https://github.com/PyCQA/flake8
     rev: 5.0.4
     hooks:

poetry.lock

@@ -13,7 +13,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 """The Splunk Software Development Kit for Solutions."""
 
 from . import (

solnlib/__init__.py

@@ -16,7 +16,7 @@
 """This module provide utils that are private to solnlib."""
 
 import re
-from typing import Any, Dict, Optional, Union
+from typing import Any, Optional, Union
 
 from splunklib import binding, client
 
@@ -33,7 +33,7 @@ def get_collection_data(
     scheme: Optional[str] = None,
     host: Optional[str] = None,
     port: Optional[Union[str, int]] = None,
-    fields: Optional[Dict] = None,
+    fields: Optional[dict] = None,
     **context: Any,
 ) -> client.KVStoreCollectionData:
     """Get collection data, if there is no such collection - creates one.

solnlib/_utils.py

@@ -13,11 +13,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 """This module contains interfaces that support CRUD operations on ACL."""
 
 import json
-from typing import List
 
 from splunklib import binding
 
@@ -108,8 +106,8 @@ def update(
         self,
         path: str,
         owner: str = None,
-        perms_read: List = None,
-        perms_write: List = None,
+        perms_read: list = None,
+        perms_write: list = None,
     ) -> dict:
         """Update ACL of /servicesNS/{`owner`}/{`app`}/{`path`}.
 

solnlib/acl.py

@@ -15,7 +15,7 @@
 #
 import json
 from enum import Enum
-from typing import Tuple, Union, Optional
+from typing import Union, Optional
 
 from solnlib import splunk_rest_client as rest_client
 
@@ -89,7 +89,7 @@ def create_search_alert(
         alert_condition: str = "",
         alert_comparator: AlertComparator = AlertComparator.GREATER_THAN,
         alert_threshold: Union[int, float, str] = 0,
-        time_window: Tuple[str, str] = ("-15m", "now"),
+        time_window: tuple[str, str] = ("-15m", "now"),
         alert_severity: AlertSeverity = AlertSeverity.WARN,
         cron_schedule: str = "* * * * *",
         expires: Union[int, str] = "24h",
@@ -188,7 +188,7 @@ def update_search_alert(
         alert_condition: Optional[str] = None,
         alert_comparator: Optional[AlertComparator] = None,
         alert_threshold: Optional[Union[int, float, str]] = None,
-        time_window: Optional[Tuple[str, str]] = None,
+        time_window: Optional[tuple[str, str]] = None,
         alert_severity: Optional[AlertSeverity] = None,
         cron_schedule: Optional[str] = None,
         expires: Optional[Union[int, str]] = None,

solnlib/alerts_rest_client.py

@@ -15,7 +15,7 @@
 #
 
 from solnlib import splunk_rest_client as rest_client
-from typing import Optional, List
+from typing import Optional
 import json
 
 __all__ = ["BulletinRestClient"]
@@ -40,18 +40,18 @@ def __init__(
         app: str,
         **context: dict,
     ):
-        """Initializes BulletinRestClient.
-            When creating a new bulletin message, you must provide a name, which is a kind of ID.
-            If you try to create another message with the same name (ID), the API will not add another message
-            to the bulletin, but it will overwrite the existing one. Similar behaviour applies to deletion.
-            To delete a message, you must indicate the name (ID) of the message.
-            To provide better and easier control over bulletin messages, this client works in such a way
-            that there is one instance responsible for handling one specific message.
-            If you need to add another message to bulletin create another instance
-            with a different 'message_name'
-            e.g.
-            msg_1 = BulletinRestClient("message_1", "<some session key>")
-            msg_2 = BulletinRestClient("message_2", "<some session key>")
+        """Initializes BulletinRestClient. When creating a new bulletin
+        message, you must provide a name, which is a kind of ID. If you try to
+        create another message with the same name (ID), the API will not add
+        another message to the bulletin, but it will overwrite the existing
+        one. Similar behaviour applies to deletion. To delete a message, you
+        must indicate the name (ID) of the message. To provide better and
+        easier control over bulletin messages, this client works in such a way
+        that there is one instance responsible for handling one specific
+        message. If you need to add another message to bulletin create another
+        instance with a different 'message_name' e.g. msg_1 =
+        BulletinRestClient("message_1", "<some session key>") msg_2 =
+        BulletinRestClient("message_2", "<some session key>")
 
         Arguments:
             message_name: Name of the message in the Splunk's bulletin.
@@ -72,8 +72,8 @@ def create_message(
         self,
         msg: str,
         severity: Severity = Severity.WARNING,
-        capabilities: Optional[List[str]] = None,
-        roles: Optional[List] = None,
+        capabilities: Optional[list[str]] = None,
+        roles: Optional[list] = None,
     ):
         """Creates a message in the Splunk's bulletin. Calling this method
         multiple times for the same instance will overwrite existing message.
@@ -144,7 +144,7 @@ def delete_message(self):
         self._rest_client.delete(endpoint)
 
     @staticmethod
-    def _validate_and_get_body_value(arg, error_msg) -> List:
+    def _validate_and_get_body_value(arg, error_msg) -> list:
         if type(arg) is list and (all(isinstance(el, str) for el in arg)):
             return [el for el in arg]
         else:

solnlib/bulletin_rest_client.py

@@ -13,7 +13,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 """Concurrent executor provides concurrent executing function either in a
 thread pool or a process pool."""
 
@@ -69,11 +68,11 @@ def run_io_func_async(self, func, args=(), kwargs=None, callback=None):
         return self._io_executor.apply_async(func, args, kwargs, callback)
 
     def enqueue_io_funcs(self, funcs, block=True):
-        """run jobs in a fire and forget way, no result will be handled over to
+        """Run jobs in a fire and forget way, no result will be handled over to
         clients.
 
-        :param funcs: tuple/list-like or generator like object, func shall be
-                      callable
+        :param funcs: tuple/list-like or generator like object, func
+            shall be callable
         """
 
         return self._io_executor.enqueue_funcs(funcs, block)

solnlib/concurrent/concurrent_executor.py

@@ -13,7 +13,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 """A wrapper of multiprocessing.pool."""
 
 import multiprocessing

solnlib/concurrent/process_pool.py

@@ -13,7 +13,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 """A simple thread pool implementation."""
 
 import multiprocessing
@@ -94,11 +93,11 @@ def tear_down(self):
         logging.info("ThreadPool stopped.")
 
     def enqueue_funcs(self, funcs, block=True):
-        """run jobs in a fire and forget way, no result will be handled over to
+        """Run jobs in a fire and forget way, no result will be handled over to
         clients.
 
-        :param funcs: tuple/list-like or generator like object, func shall be
-                      callable
+        :param funcs: tuple/list-like or generator like object, func
+            shall be callable
         """
 
         if not self._started: