ci: regenerated with OpenAPI Doc 1.0.0, Speakeasy CLI 1.476.0

epilot-dev · github-actions · Aug 8, 2024 · Aug 9, 2024 · Aug 15, 2024 · Aug 20, 2024
commit ad548d022ed78e1493f6a46ce89d87c455b4dd4c
diff --git a/submission/.speakeasy/gen.lock b/submission/.speakeasy/gen.lock
@@ -3,18 +3,18 @@ id: 33caae79-0482-46e7-9dea-4e7a337d182e
 management:
   docChecksum: d4af78e6c6d718d7121f5ce9edb789ef
   docVersion: 1.0.0
-  speakeasyVersion: 1.474.0
-  generationVersion: 2.495.0
-  releaseVersion: 1.13.6
-  configChecksum: cde6d9c66fcdd6923fef72fbf965c859
+  speakeasyVersion: 1.476.0
+  generationVersion: 2.496.0
+  releaseVersion: 1.13.7
+  configChecksum: b44435745cd889b77b88dc377739bc4e
   repoURL: https://github.com/epilot-dev/sdk-python.git
   repoSubDirectory: submission
   installationURL: https://github.com/epilot-dev/sdk-python.git#subdirectory=submission
 features:
   python:
     additionalDependencies: 1.0.0
     additionalProperties: 1.0.1
-    core: 5.10.4
+    core: 5.10.5
     defaultEnabledRetries: 0.2.0
     deprecations: 3.0.2
     enumUnions: 0.1.0

diff --git a/submission/README.md b/submission/README.md
@@ -512,6 +512,27 @@ with Epilot(
 ```
 <!-- End Authentication [security] -->
 
+<!-- Start Resource Management [resource-management] -->
+## Resource Management
+
+The `Epilot` 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 epilot_submission import Epilot
+def main():
+    with Epilot() as epilot:
+        # Rest of application here...
+
+
+# Or when using async:
+async def amain():
+    async with Epilot() as epilot:
+        # Rest of application here...
+```
+<!-- End Resource Management [resource-management] -->
+
 <!-- Start Debugging [debug] -->
 ## Debugging
 
@@ -555,6 +576,7 @@ Submission API: Use this API to handle submissions entities from external source
   * [Server Selection](#server-selection)
   * [Custom HTTP Client](#custom-http-client)
   * [Authentication](#authentication)
+  * [Resource Management](#resource-management)
   * [Debugging](#debugging)
   * [IDE Support](#ide-support)
 

diff --git a/submission/RELEASES.md b/submission/RELEASES.md
@@ -306,4 +306,12 @@ Based on:
 - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/submission-api.yaml
 - Speakeasy CLI 1.474.0 (2.495.0) https://github.com/speakeasy-api/speakeasy
 ### Generated
-- [python v1.13.6] submission
+- [python v1.13.6] submission
+
+## 2025-01-25 00:25:21
+### Changes
+Based on:
+- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/submission-api.yaml
+- Speakeasy CLI 1.476.0 (2.496.0) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [python v1.13.7] submission
diff --git a/submission/gen.yaml b/submission/gen.yaml
@@ -13,7 +13,7 @@ generation:
   sdkFlattening: true
   telemetryEnabled: false
 python:
-  version: 1.13.6
+  version: 1.13.7
   additionalDependencies:
     dev: {}
     main: {}

diff --git a/submission/pyproject.toml b/submission/pyproject.toml
@@ -1,6 +1,6 @@
 [project]
 name = "epilot-submission"
-version = "1.13.6"
+version = "1.13.7"
 description = "Python Client SDK for Epilot"
 authors = [{ name = "Speakeasy" },]
 readme = "README-PYPI.md"

diff --git a/submission/src/epilot_submission/_version.py b/submission/src/epilot_submission/_version.py
@@ -3,10 +3,10 @@
 import importlib.metadata
 
 __title__: str = "epilot-submission"
-__version__: str = "1.13.6"
+__version__: str = "1.13.7"
 __openapi_doc_version__: str = "1.0.0"
-__gen_version__: str = "2.495.0"
-__user_agent__: str = "speakeasy-sdk/python 1.13.6 2.495.0 1.0.0 epilot-submission"
+__gen_version__: str = "2.496.0"
+__user_agent__: str = "speakeasy-sdk/python 1.13.7 2.496.0 1.0.0 epilot-submission"
 
 try:
     if __package__ is not None:

diff --git a/submission/src/epilot_submission/httpclient.py b/submission/src/epilot_submission/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 @@ def build_request(
 
     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
diff --git a/submission/src/epilot_submission/sdk.py b/submission/src/epilot_submission/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
@@ -10,7 +10,8 @@
 from epilot_submission.submissions import Submissions
 from epilot_submission.types import OptionalNullable, UNSET
 import httpx
-from typing import Any, Callable, Dict, Optional, Union
+from typing import Any, Callable, Dict, Optional, Union, cast
+import weakref
 
 
 class Epilot(BaseSDK):
@@ -96,6 +97,14 @@ def __init__(
         # 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):