Add some typings into SDK

Author: Ickerday

splunklib/binding.py

@@ -34,14 +34,16 @@
 from contextlib import contextmanager
 from datetime import datetime
 from functools import wraps
-from io import BytesIO
-from urllib import parse
 from http import client
 from http.cookies import SimpleCookie
+from io import BytesIO
+from urllib import parse
 from xml.etree.ElementTree import XML, ParseError
-from .data import record
-from . import __version__
 
+from splunklib.data import Record
+
+from . import __version__
+from .data import record
 
 logger = logging.getLogger(__name__)
 
@@ -511,7 +513,7 @@ class Context:
     :param headers: List of extra HTTP headers to send (optional).
     :type headers: ``list`` of 2-tuples.
     :param retries: Number of retries for each HTTP connection (optional, the default is 0).
-                    NOTE: THIS MAY INCREASE THE NUMBER OF ROUNDTRIP CONNECTIONS 
+                    NOTE: THIS MAY INCREASE THE NUMBER OF ROUNDTRIP CONNECTIONS
                     TO THE SPLUNK SERVER AND BLOCK THE CURRENT THREAD WHILE RETRYING.
     :type retries: ``int``
     :param retryDelay: How long to wait between connection attempts if `retries` > 0 (optional, defaults to 10s).
@@ -653,7 +655,9 @@ def connect(self):
 
     @_authentication
     @_log_duration
-    def delete(self, path_segment, owner=None, app=None, sharing=None, **query):
+    def delete(
+        self, path_segment, owner=None, app=None, sharing=None, **query
+    ) -> Record:
         """Performs a DELETE operation at the REST path segment with the given
         namespace and query.
 
@@ -716,7 +720,7 @@ def delete(self, path_segment, owner=None, app=None, sharing=None, **query):
     @_log_duration
     def get(
         self, path_segment, owner=None, app=None, headers=None, sharing=None, **query
-    ):
+    ) -> Record:
         """Performs a GET operation from the REST path segment with the given
         namespace and query.
 
@@ -783,7 +787,7 @@ def get(
     @_log_duration
     def post(
         self, path_segment, owner=None, app=None, sharing=None, headers=None, **query
-    ):
+    ) -> Record:
         """Performs a POST operation from the REST path segment with the given
         namespace and query.
 
@@ -1357,7 +1361,7 @@ def get(self, url, headers=None, **kwargs):
             url = url + UrlEncoded("?" + _encode(**kwargs), skip_encode=True)
         return self.request(url, {"method": "GET", "headers": headers})
 
-    def post(self, url, headers=None, **kwargs):
+    def post(self, url, headers=None, **kwargs) -> Record:
         """Sends a POST request to a URL.
 
         :param url: The URL.

splunklib/client.py

@@ -59,7 +59,6 @@
 """
 
 import contextlib
-import datetime
 import json
 import logging
 import re
@@ -68,8 +67,9 @@
 from time import sleep
 from urllib import parse
 
+from splunklib.data import Record
+
 from . import data
-from .data import record
 from .binding import (
     AuthenticationError,
     Context,
@@ -80,6 +80,7 @@
     _NoAuthenticationToken,
     namespace,
 )
+from .data import record
 
 logger = logging.getLogger(__name__)
 
@@ -808,7 +809,7 @@ class Endpoint:
     :class:`Entity` (essentially HTTP GET and POST methods).
     """
 
-    def __init__(self, service, path):
+    def __init__(self, service: Service, path):
         self.service = service
         self.path = path
 
@@ -833,7 +834,9 @@ def get_api_version(self, path):
 
         return api_version
 
-    def get(self, path_segment="", owner=None, app=None, sharing=None, **query):
+    def get(
+        self, path_segment="", owner=None, app=None, sharing=None, **query
+    ) -> Record:
         """Performs a GET operation on the path segment relative to this endpoint.
 
         This method is named to match the HTTP method. This method makes at least
@@ -916,7 +919,9 @@ def get(self, path_segment="", owner=None, app=None, sharing=None, **query):
 
         return self.service.get(path, owner=owner, app=app, sharing=sharing, **query)
 
-    def post(self, path_segment="", owner=None, app=None, sharing=None, **query):
+    def post(
+        self, path_segment="", owner=None, app=None, sharing=None, **query
+    ) -> Record:
         """Performs a POST operation on the path segment relative to this endpoint.
 
         This method is named to match the HTTP method. This method makes at least

splunklib/data.py

@@ -16,6 +16,7 @@
 format, which is the format used by most of the REST API.
 """
 
+from typing import Any
 from xml.etree.ElementTree import XML
 
 __all__ = ["load", "record"]
@@ -201,7 +202,7 @@ def load_value(element, nametable=None):
 
 
 # A generic utility that enables "dot" access to dicts
-class Record(dict):
+class Record(dict[Any, Any]):  # pyright: ignore[reportExplicitAny]
     """This generic utility class enables dot access to members of a Python
     dictionary.