fix memory safety issues, simplify all http calls, allow non-client creation

Author: sebastianMindee

mindee/error/mindee_http_error.py

@@ -1,5 +1,5 @@
 from mindee.error.mindee_error import MindeeError
-from mindee.parsing.common import StringDict
+from mindee.parsing.common.string_dict import StringDict
 
 
 class MindeeHTTPError(RuntimeError):

mindee/input/url_input_source.py

@@ -10,6 +10,7 @@
 from mindee.error.mindee_error import MindeeSourceError
 from mindee.input.bytes_input import BytesInput
 from mindee.logger import logger
+from mindee.parsing.common.string_dict import StringDict
 
 
 class URLInputSource:
@@ -192,10 +193,16 @@ def __make_request(
         :return: The content of the response.
         :raises MindeeSourceError: If max redirects are exceeded or the request fails.
         """
-        http_client = http_client or httpx.Client()
-        result = http_client.get(
-            url, headers=headers, timeout=120, auth=auth, follow_redirects=True
-        )
+        get_kwargs: StringDict = {
+            "headers": headers,
+            "timeout": 120,
+            "auth": auth,
+            "follow_redirects": True,
+        }
+        if http_client is None:
+            result = httpx.get(url, **get_kwargs)
+        else:
+            result = http_client.get(url, **get_kwargs)
         if 299 < result.status_code < 400:
             if redirects == max_redirects:
                 raise MindeeSourceError(
@@ -204,13 +211,18 @@ def __make_request(
                     f"aborting operation."
                 )
             return URLInputSource.__make_request(
-                result.headers["Location"], auth, headers, redirects + 1, max_redirects
+                result.headers["Location"],
+                auth,
+                headers,
+                redirects + 1,
+                max_redirects,
+                http_client,
             )
 
         if result.status_code >= 400 or result.status_code < 200:
             raise MindeeSourceError(
                 f"Couldn't retrieve file from server, error code {result.status_code}."
             )
-
-        http_client.close()
+        if http_client is not None and not http_client.is_closed:
+            http_client.close()
         return result.content

mindee/mindee_http/response_validation.py

@@ -2,7 +2,7 @@
 
 import httpx
 
-from mindee.parsing.common import StringDict
+from mindee.parsing.common.string_dict import StringDict
 
 
 def is_valid_sync_response(response: httpx.Response) -> bool:

mindee/v1/client.py

@@ -62,7 +62,7 @@ class Client(ClientMixin):
 
     api_key: str
     """API key for all endpoints."""
-    http_client: httpx.Client
+    http_client: httpx.Client | None
     """HTTP client for making requests."""
 
     def __init__(
@@ -75,7 +75,7 @@ def __init__(
         :param http_client: HTTP client for making requests.
         """
         self.api_key = api_key
-        self.http_client = http_client or httpx.Client()
+        self.http_client = http_client
 
     def parse(
         self,
@@ -597,3 +597,20 @@ def create_endpoint(
             )
             version = "1"
         return self._build_endpoint(endpoint_name, account_name, version)
+
+    def close(self):
+        """Close the HTTP client."""
+        if self.http_client and not self.http_client.is_closed:
+            self.http_client.close()
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        self.close()
+
+    def __del__(self):
+        """Ensure the HTTP client is closed when the object is garbage collected."""
+        if self.http_client and self.http_client and not self.http_client.is_closed:
+            logger.info("Force-closing unclosed Mindee Client (V1) %s.", str(self))
+            self.close()

mindee/v1/mindee_http/base_endpoint.py

@@ -7,7 +7,9 @@ class BaseEndpoint:
     """Base endpoint class for the Mindee API."""
 
     settings: BaseSettings
-    http_client: httpx.Client
+    """Settings relating to all endpoints."""
+    http_client: httpx.Client | None
+    """HTTP client for making requests."""
 
     def __init__(
         self, settings: BaseSettings, http_client: httpx.Client | None = None
@@ -19,14 +21,4 @@ def __init__(
         :param http_client: HTTP client for making requests.
         """
         self.settings = settings
-        self.http_client = http_client or httpx.Client()
-
-    def close(self) -> None:
-        """Closes the underlying HTTP client."""
-        self.http_client.close()
-
-    def __enter__(self):
-        return self
-
-    def __exit__(self, exc_type, exc_val, exc_tb):
-        self.close()
+        self.http_client = http_client