mixpeek 0.18.6__py3-none-any.whl → 0.18.7__py3-none-any.whl

mixpeek/_version.py

@@ -3,10 +3,10 @@
 import importlib.metadata
 
 __title__: str = "mixpeek"
-__version__: str = "0.18.6"
+__version__: str = "0.18.7"
 __openapi_doc_version__: str = "0.81"
-__gen_version__: str = "2.495.0"
-__user_agent__: str = "speakeasy-sdk/python 0.18.6 2.495.0 0.81 mixpeek"
+__gen_version__: str = "2.496.0"
+__user_agent__: str = "speakeasy-sdk/python 0.18.7 2.496.0 0.81 mixpeek"
 
 try:
     if __package__ is not None:

mixpeek/httpclient.py

@@ -1,6 +1,8 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 # pyright: reportReturnType = false
+import asyncio
+from concurrent.futures import ThreadPoolExecutor
 from typing_extensions import Protocol, runtime_checkable
 import httpx
 from typing import Any, Optional, Union
@@ -82,3 +84,51 @@ class AsyncHttpClient(Protocol):
 
     async def aclose(self) -> None:
         pass
+
+
+class ClientOwner(Protocol):
+    client: Union[HttpClient, None]
+    async_client: Union[AsyncHttpClient, None]
+
+
+def close_clients(
+    owner: ClientOwner,
+    sync_client: Union[HttpClient, None],
+    async_client: Union[AsyncHttpClient, None],
+) -> None:
+    """
+    A finalizer function that is meant to be used with weakref.finalize to close
+    httpx clients used by an SDK so that underlying resources can be garbage
+    collected.
+    """
+
+    # Unset the client/async_client properties so there are no more references
+    # to them from the owning SDK instance and they can be reaped.
+    owner.client = None
+    owner.async_client = None
+
+    if sync_client is not None:
+        try:
+            sync_client.close()
+        except Exception:
+            pass
+
+    if async_client is not None:
+        is_async = False
+        try:
+            asyncio.get_running_loop()
+            is_async = True
+        except RuntimeError:
+            pass
+
+        try:
+            # If this function is called in an async loop then start another
+            # loop in a separate thread to close the async http client.
+            if is_async:
+                with ThreadPoolExecutor(max_workers=1) as executor:
+                    future = executor.submit(asyncio.run, async_client.aclose())
+                    future.result()
+            else:
+                asyncio.run(async_client.aclose())
+        except Exception:
+            pass

mixpeek/sdk.py

@@ -1,7 +1,7 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from .basesdk import BaseSDK
-from .httpclient import AsyncHttpClient, HttpClient
+from .httpclient import AsyncHttpClient, ClientOwner, HttpClient, close_clients
 from .sdkconfiguration import SDKConfiguration
 from .utils.logger import Logger, get_default_logger
 from .utils.retries import RetryConfig
@@ -22,7 +22,8 @@ from mixpeek.taxonomies import Taxonomies
 from mixpeek.taxonomyentities import TaxonomyEntities
 from mixpeek.types import OptionalNullable, UNSET
 from mixpeek.users import Users
-from typing import Any, Callable, Dict, Optional, Union
+from typing import Any, Callable, Dict, Optional, Union, cast
+import weakref
 
 
 class Mixpeek(BaseSDK):
@@ -127,6 +128,14 @@ class Mixpeek(BaseSDK):
         # pylint: disable=protected-access
         self.sdk_configuration.__dict__["_hooks"] = hooks
 
+        weakref.finalize(
+            self,
+            close_clients,
+            cast(ClientOwner, self.sdk_configuration),
+            self.sdk_configuration.client,
+            self.sdk_configuration.async_client,
+        )
+
         self._init_sdks()
 
     def _init_sdks(self):

{mixpeek-0.18.6.dist-info → mixpeek-0.18.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: mixpeek
-Version: 0.18.6
+Version: 0.18.7
 Summary: Python Client SDK Generated by Speakeasy.
 Author: Speakeasy
 Requires-Python: >=3.9
@@ -42,6 +42,7 @@ Mixpeek API: This is the Mixpeek API, providing access to various endpoints for
   * [Error Handling](https://github.com/mixpeek/python-sdk/blob/master/#error-handling)
   * [Server Selection](https://github.com/mixpeek/python-sdk/blob/master/#server-selection)
   * [Custom HTTP Client](https://github.com/mixpeek/python-sdk/blob/master/#custom-http-client)
+  * [Resource Management](https://github.com/mixpeek/python-sdk/blob/master/#resource-management)
   * [Debugging](https://github.com/mixpeek/python-sdk/blob/master/#debugging)
 * [Development](https://github.com/mixpeek/python-sdk/blob/master/#development)
   * [Maturity](https://github.com/mixpeek/python-sdk/blob/master/#maturity)
@@ -453,6 +454,32 @@ s = Mixpeek(async_client=CustomClient(httpx.AsyncClient()))
 ```
 <!-- End Custom HTTP Client [http-client] -->
 
+<!-- Start Resource Management [resource-management] -->
+## Resource Management
+
+The `Mixpeek` class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a [context manager][context-manager] and reuse it across the application.
+
+[context-manager]: https://docs.python.org/3/reference/datamodel.html#context-managers
+
+```python
+from mixpeek import Mixpeek
+import os
+def main():
+    with Mixpeek(
+        token=os.getenv("MIXPEEK_TOKEN", ""),
+    ) as mixpeek:
+        # Rest of application here...
+
+
+# Or when using async:
+async def amain():
+    async with Mixpeek(
+        token=os.getenv("MIXPEEK_TOKEN", ""),
+    ) as mixpeek:
+        # Rest of application here...
+```
+<!-- End Resource Management [resource-management] -->
+
 <!-- Start Debugging [debug] -->
 ## Debugging
 

{mixpeek-0.18.6.dist-info → mixpeek-0.18.7.dist-info}/RECORD

@@ -3,14 +3,14 @@ mixpeek/_hooks/__init__.py,sha256=p5J13DeYuISQyQWirjJAObHIf2VtIlOtFqnIpvjjVwk,11
 mixpeek/_hooks/registration.py,sha256=1QZB41w6If7I9dXiOSQx6dhSc6BPWrnI5Q5bMOr4iVA,624
 mixpeek/_hooks/sdkhooks.py,sha256=T0xbVPw8mvvFszHZlrZdtFrJBovAqE-JQfw4dS9Xi7Y,2495
 mixpeek/_hooks/types.py,sha256=Qh9pO5ndynMrWpMLPkJUsOmAJ1AJHntJAXb5Yxe_a4o,2568
-mixpeek/_version.py,sha256=TOn3-PgNetSFWC3MAOZzDvmmyDMHysjGS_27JNLnqA8,456
+mixpeek/_version.py,sha256=3v1c4xHsX9ZFegoIHIUnqg9ZtsVhX9Quh4BKwhwMNmo,456
 mixpeek/assets.py,sha256=cggTlrFg6BAlddsB3TJS67XAO7oaaEZxuXE7rac6ASw,75414
 mixpeek/basesdk.py,sha256=j_PZqE6WgIfx1cPCK5gAVn-rgPy9iLhUN5ELtefoEU0,11976
 mixpeek/collections.py,sha256=mh0ypu89kY78Lnfal7OdBrHsCpJ3O54DVR3ejhD5oSo,49021
 mixpeek/featureextractors.py,sha256=uMZncapRYj7dM_qAJ5hbT86Uyb9x1N1IraNMupGp7UE,9598
 mixpeek/features.py,sha256=z_JoaD_k_HNcHLrRpdOxcbnNLUjVljZmpnsbiZLHy3I,58748
 mixpeek/health.py,sha256=4i7KHGS2bYHCAE0nyHDw5g24MXcTZYVaTviQNKPW5o0,6742
-mixpeek/httpclient.py,sha256=WDbLpMzo7qmWki_ryOJcCAYNI1T4uyWKV08rRuCdNII,2688
+mixpeek/httpclient.py,sha256=N-D-srtDBykpfyVKacTY4upDGvNLqdWlEYqhJvta99E,4194
 mixpeek/ingestassets.py,sha256=yW6eDg9JpSQzWM1Zl-GqDIpacKrUItXBL6LOOaDo8q8,40442
 mixpeek/models/__init__.py,sha256=tA15wFp9zSk7e76MF48-to5yygR17id6EGWQjXnQ6W4,31191
 mixpeek/models/actionusage.py,sha256=WAnnBVTeQ9j0dtIrubfyyJQwbBamxManfS8fc2OFNyo,324
@@ -170,7 +170,7 @@ mixpeek/models/videotranscriptionsettings.py,sha256=70EN-PX2QiQAQjDLYaV2coUCnVjR
 mixpeek/namespaces.py,sha256=ED42wsbEksGpW61sUvtnjJPl8O6ktVE7R7K5ZTHiZko,53848
 mixpeek/organizations.py,sha256=Q0Nu_eg7bXCZniB0a8Gj7Kt8kRkVLzs5h_-T5w4c1Ic,44795
 mixpeek/py.typed,sha256=zrp19r0G21lr2yRiMC0f8MFkQFGj9wMpSbboePMg8KM,59
-mixpeek/sdk.py,sha256=GfRtkLl__iaA04EY_E9_-ASxvY1Fp2ejYiKBZBARlnc,6071
+mixpeek/sdk.py,sha256=qGyoPseO0ijF5NEWKaXaDRJWtQJ97EHhLYiGmHpsbkI,6349
 mixpeek/sdkconfiguration.py,sha256=WDFDVblhsi547ZxDPEPR243zKLM1shTDSt9w3nporHc,1703
 mixpeek/tasks.py,sha256=tQMg5XUINdXAjbTVbJP63zLfRs5eNl5Fk46onDo5yFo,27602
 mixpeek/taxonomies.py,sha256=M3q8g39M6VK3saT0sIgjsV5vs-4NO7iKdCJ894VxnLk,29553
@@ -193,6 +193,6 @@ mixpeek/utils/security.py,sha256=XoK-R2YMyZtVWQte7FoezfGJS-dea9jz4qQ7w5dwNWc,600
 mixpeek/utils/serializers.py,sha256=BSJT7kBOkNBFyP7KREyMoe14JGbgijD1M6AXFMbdmco,4924
 mixpeek/utils/url.py,sha256=BgGPgcTA6MRK4bF8fjP2dUopN3NzEzxWMXPBVg8NQUA,5254
 mixpeek/utils/values.py,sha256=_89YXPTI_BU6SXJBzFR4pIzTCBPQW9tsOTN1jeBBIDs,3428
-mixpeek-0.18.6.dist-info/METADATA,sha256=T2ABMGKmGYxesHmPO_-r9UB_dMW3FI3X1uzhn7h_KiE,20959
-mixpeek-0.18.6.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
-mixpeek-0.18.6.dist-info/RECORD,,
+mixpeek-0.18.7.dist-info/METADATA,sha256=Kgb3pwHsbmsEiTcwXchpGfsxh5k7SDWZ8WC843K55H0,22186
+mixpeek-0.18.7.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
+mixpeek-0.18.7.dist-info/RECORD,,