fix(api-client): code hygiene

api_client/python/timesketch_api_client/aggregation.py

@@ -45,6 +45,11 @@ class Aggregation(resource.SketchResource):
     resource_data: dict[str, Any]
 
     def __init__(self, sketch):
+        """Initializes the Aggregation object.
+
+        Args:
+            sketch (Sketch): An instance of Sketch object.
+        """
         self._created_at = ""
         self._name = ""
         self._parameters = {}
@@ -288,7 +293,11 @@ def title(self):
 
     @title.setter
     def title(self, new_title):
-        """Set the chart title of an aggregation."""
+        """Set the chart title of an aggregation.
+
+        Args:
+            new_title (str): Chart title.
+        """
         self.chart_title = new_title
 
     @property
@@ -307,7 +316,11 @@ def description(self):
 
     @description.setter
     def description(self, description):
-        """Set the description of an aggregation."""
+        """Set the description of an aggregation.
+
+        Args:
+            description (str): Description string.
+        """
         if "meta" not in self.resource_data:
             return
         meta = self.resource_data.get("meta", {})
@@ -320,7 +333,11 @@ def name(self):
 
     @name.setter
     def name(self, name):
-        """Set the name of the aggregation."""
+        """Set the name of the aggregation.
+
+        Args:
+            name (str): Name of the aggregation.
+        """
         if "meta" not in self.resource_data:
             return
         meta = self.resource_data.get("meta")
@@ -447,7 +464,11 @@ class AggregationGroup(resource.SketchResource):
     """Aggregation Group object."""
 
     def __init__(self, sketch):
-        """Initialize the aggregation group."""
+        """Initialize the aggregation group.
+
+        Args:
+            sketch (Sketch): An instance of Sketch object.
+        """
         resource_uri = "sketches/{0:d}/aggregation/group/".format(sketch.id)
         super().__init__(resource_uri=resource_uri, sketch=sketch)
 
@@ -499,7 +520,11 @@ def description(self):
 
     @description.setter
     def description(self, description):
-        """Sets the description of the aggregation group."""
+        """Sets the description of the aggregation group.
+
+        Args:
+            description (str): Description of the aggregation group.
+        """
         self._description = description
         self.save()
 
@@ -510,7 +535,11 @@ def name(self):
 
     @name.setter
     def name(self, name):
-        """Sets the name of the aggregation group."""
+        """Sets the name of the aggregation group.
+
+        Args:
+            name (str): Name of the aggregation group.
+        """
         self._name = name
         self.save()
 
@@ -521,7 +550,11 @@ def orientation(self):
 
     @orientation.setter
     def orientation(self, orientation):
-        """Sets the chart orientation."""
+        """Sets the chart orientation.
+
+        Args:
+            orientation (str): Chart orientation.
+        """
         self._orientation = orientation
         self.save()
 
@@ -532,7 +565,11 @@ def parameters(self):
 
     @parameters.setter
     def parameters(self, parameters):
-        """Sets the group parameters."""
+        """Sets the group parameters.
+
+        Args:
+            parameters (dict): Aggregation group parameters.
+        """
         self._parameters = parameters
         self.save()
 

api_client/python/timesketch_api_client/aggregation_test.py

@@ -14,7 +14,7 @@
 """Tests for the Timesketch API aggregation object."""
 
 import unittest
-import mock
+from unittest import mock
 
 import altair as alt
 

api_client/python/timesketch_api_client/analyzer.py

@@ -13,7 +13,6 @@
 # limitations under the License.
 """Timesketch API analyzer result object."""
 
-from __future__ import unicode_literals
 
 import datetime
 import json
@@ -29,7 +28,14 @@ class AnalyzerResult(resource.BaseResource):
     """Class to store and retrieve session information for an analyzer."""
 
     def __init__(self, timeline_id, session_id, sketch_id, api):
-        """Initialize the class."""
+        """Initialize the class.
+
+        Args:
+            timeline_id (int): The ID of the timeline.
+            session_id (int): The ID of the analyzer session.
+            sketch_id (int): The ID of the sketch.
+            api (TimesketchApi): An instance of TimesketchApi.
+        """
         self._session_id = session_id
         self._sketch_id = sketch_id
         self._timeline_id = timeline_id

api_client/python/timesketch_api_client/cli_input.py

@@ -32,7 +32,7 @@ def ask_question(
     Args:
         question (str): the text that the user will be prompted.
         input_type (type): the type of the input data.
-        default (object): default value for the question, optional.
+        default: default value for the question, optional.
         hide_input (bool): whether the input should be hidden, eg. when asking
             for a password.
 

api_client/python/timesketch_api_client/client.py

@@ -13,7 +13,6 @@
 # limitations under the License.
 """Timesketch API client."""
 
-from __future__ import unicode_literals
 
 
 import os
@@ -100,23 +99,24 @@ def __init__(
         """Initializes the TimesketchApi object.
 
         Args:
-            host_uri: URI to the Timesketch server (https://<server>/).
-            username: User username.
-            password: User password.
-            verify: Verify server SSL certificate.
-            client_id: The client ID if OAUTH auth is used.
-            client_secret: The OAUTH client secret if OAUTH is used.
-            auth_mode: The authentication mode to use. Defaults to 'userpass'
+            host_uri (str): URI to the Timesketch server (https://<server>/).
+            username (str): User username.
+            password (str): User password.
+            verify (bool): Verify server SSL certificate.
+            client_id (int): The client ID if OAUTH auth is used.
+            client_secret (str): The OAUTH client secret if OAUTH is used.
+            auth_mode (str): The authentication mode to use. Defaults to 'userpass'
                 Supported values are 'userpass' (username/password combo),
                 'http-basic' (HTTP Basic authentication) and oauth.
-            create_session: Boolean indicating whether the client object
+            create_session (bool): Boolean indicating whether the client object
                 should create a session object. If set to False the
                 function "set_session" needs to be called before proceeding.
-            retry_count: Number of retries for HTTP requests and internal API
+            retry_count (int): Number of retries for HTTP requests and internal API
                 request retries. Defaults to DEFAULT_RETRY_COUNT.
-            backoff_factor: The backoff factor to use for retries. Defaults to 0.5.
+            backoff_factor (float): The backoff factor to use for retries. Defaults to 0.5.
             auth_timeout: Optional timeout in seconds for the authentication.
 
+
         Raises:
             ConnectionError: If the Timesketch server is unreachable.
             RuntimeError: If the client is unable to authenticate to the
@@ -184,11 +184,19 @@ def session(self):
         return self._session
 
     def set_credentials(self, credential_object):
-        """Sets the credential object."""
+        """Sets the credential object.
+
+        Args:
+            credential_object (credentials.AuthCredentials): Credential object.
+        """
         self.credentials = credential_object
 
     def set_session(self, session_object):
-        """Sets the session object."""
+        """Sets the session object.
+
+        Args:
+            session_object (requests.Session): Instance of requests.Session.
+        """
         self._session = session_object
 
     def _authenticate_session(self, session, username, password):
@@ -482,7 +490,7 @@ def _send_request_with_retry(self, method, resource_uri, **kwargs):
         Args:
             method (str): HTTP method (e.g., 'GET', 'POST').
             resource_uri (str): The URI for the resource.
-            **kwargs: Keyword arguments passed to the request.
+            **kwargs: Optional arguments to send with the request.
 
         Returns:
             dict: The JSON response data.
@@ -661,7 +669,7 @@ def get_user(self, user_id):
         """Get a user.
 
         Args:
-            user_id: Primary key ID of the user.
+            user_id (int): Primary key ID of the user.
 
         Returns:
             Instance of a User object.
@@ -681,7 +689,7 @@ def get_sketch(self, sketch_id):
         """Get a sketch.
 
         Args:
-            sketch_id: Primary key ID of the sketch.
+            sketch_id (int): Primary key ID of the sketch.
 
         Returns:
             Instance of a Sketch object.
@@ -782,7 +790,7 @@ def get_searchindex(self, searchindex_id):
         """Get a searchindex.
 
         Args:
-            searchindex_id: Primary key ID of the searchindex.
+            searchindex_id (int): Primary key ID of the searchindex.
 
         Returns:
             Instance of a SearchIndex object.
@@ -966,7 +974,7 @@ def get_sigmarule(self, rule_uuid):
         Fetches a single Sigma rule selected by the `UUID`
 
         Args:
-            rule_uuid: UUID of the Sigma rule.
+            rule_uuid (str): UUID of the Sigma rule.
 
         Returns:
             Instance of a SigmaRule object.
@@ -1015,6 +1023,10 @@ def increment(self, *args, **kwargs):
         This method is called by urllib3 before each retry attempt. It's overridden
         here to add custom logging for 5xx errors and to enhance the final
         MaxRetryError message with server response details and attempt count.
+
+        Args:
+            *args: Variable length argument list.
+            **kwargs: Arbitrary keyword arguments.
         """
         response = kwargs.get("response")
         decoded_body = None

api_client/python/timesketch_api_client/client_test.py

@@ -13,7 +13,6 @@
 # limitations under the License.
 """Tests for the Timesketch API client"""
 
-from __future__ import unicode_literals
 
 import unittest
 from unittest import mock

api_client/python/timesketch_api_client/config.py

@@ -31,6 +31,7 @@
 from . import cli_input
 from . import credentials as ts_credentials
 from . import crypto
+from . import definitions
 
 logger = logging.getLogger("timesketch_api.config_assistance")
 
@@ -221,7 +222,7 @@ def has_config(self, name: Text) -> bool:
     def load_config_file(
         self,
         config_file_path: Optional[Text] = "",
-        section: Optional[Text] = "timesketch",
+        section: Optional[Text] = definitions.DEFAULT_CONFIG_SECTION,
         load_cli_config: Optional[bool] = False,
     ):
         """Load the config from file.
@@ -271,7 +272,7 @@ def load_config_file(
             return
 
         if not section:
-            section = "timesketch"
+            section = definitions.DEFAULT_CONFIG_SECTION
 
         if section not in config.sections():
             logger.warning("No %s section in the config", section)
@@ -322,7 +323,7 @@ def load_config_dict(self, config_dict: Dict[Text, Text]):
     def save_config(
         self,
         file_path: Optional[Text] = "",
-        section: Optional[Text] = "timesketch",
+        section: Optional[Text] = definitions.DEFAULT_CONFIG_SECTION,
         token_file_path: Optional[Text] = "",
     ):
         """Save the current config to a file.
@@ -364,7 +365,7 @@ def save_config(
             auth_mode = "userpass"
 
         if not section:
-            section = "timesketch"
+            section = definitions.DEFAULT_CONFIG_SECTION
 
         config[section] = {
             "host_uri": self._config.get("host_uri"),
@@ -404,15 +405,15 @@ def set_config(self, name: Text, value: Any):
 
         Args:
           name (str): the name of the configuration value to be set.
-          value (object): the value of the configuration object.
+          value: the value of the configuration object.
         """
         self._config[name.lower()] = value
 
 
 def get_client(
     config_dict: Optional[Dict[Text, Any]] = None,
     config_path: Optional[Text] = "",
-    config_section: Optional[Text] = "timesketch",
+    config_section: Optional[Text] = definitions.DEFAULT_CONFIG_SECTION,
     token_password: Optional[Text] = "",
     confirm_choices: Optional[bool] = False,
     load_cli_config: Optional[bool] = False,
@@ -487,7 +488,7 @@ def configure_missing_parameters(
     config_assistant: ConfigAssistant,
     token_password: Optional[Text] = "",
     confirm_choices: Optional[bool] = False,
-    config_section: Optional[Text] = "timesketch",
+    config_section: Optional[Text] = definitions.DEFAULT_CONFIG_SECTION,
 ):
     """Fill in missing configuration for a config assistant.
 

api_client/python/timesketch_api_client/config_test.py

@@ -13,7 +13,6 @@
 # limitations under the License.
 """Tests for the Timesketch config library for the API client."""
 
-from __future__ import unicode_literals
 
 import unittest
 import tempfile

api_client/python/timesketch_api_client/credentials.py

@@ -17,7 +17,6 @@
 credential objects Timesketch supports.
 """
 
-from __future__ import unicode_literals
 
 import json
 
@@ -41,7 +40,11 @@ def credential(self):
 
     @credential.setter
     def credential(self, credential_obj):
-        """Sets the credential object."""
+        """Sets the credential object.
+
+        Args:
+            credential_obj (object): The credential object.
+        """
         self._credential = credential_obj
 
     def serialize(self):