feat(api): OpenAPI spec update via Stainless API (#104)

Author: stainless-app[bot]

.gitignore

@@ -1,3 +1,4 @@
+.prism.log
 .vscode
 _dev
 

.stats.yml

@@ -1,2 +1,2 @@
 configured_endpoints: 21
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/prompt-foundry%2Fprompt-foundry-sdk-d9b855455d537bcf385efd28281b3ec5d7a7169fca24bf1961e9b58fb8202b7c.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/prompt-foundry%2Fprompt-foundry-sdk-34a4feda5ed017fa6e768340bc744158d41437857466ad44d553ec4a5c1083d9.yml

README.md

@@ -214,7 +214,7 @@ response = client.prompts.with_raw_response.get_parameters(
 print(response.headers.get('X-My-Header'))
 
 prompt = response.parse()  # get the object that `prompts.get_parameters()` would have returned
-print(prompt.provider)
+print(prompt)
 ```
 
 These methods return an [`APIResponse`](https://github.com/prompt-foundry/python-sdk/tree/main/src/prompt_foundry_python_sdk/_response.py) object.

src/prompt_foundry_python_sdk/_utils/__init__.py

@@ -49,4 +49,7 @@
     maybe_transform as maybe_transform,
     async_maybe_transform as async_maybe_transform,
 )
-from ._reflection import function_has_argument as function_has_argument
+from ._reflection import (
+    function_has_argument as function_has_argument,
+    assert_signatures_in_sync as assert_signatures_in_sync,
+)

src/prompt_foundry_python_sdk/_utils/_reflection.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import inspect
 from typing import Any, Callable
 
@@ -6,3 +8,35 @@ def function_has_argument(func: Callable[..., Any], arg_name: str) -> bool:
     """Returns whether or not the given function has a specific parameter"""
     sig = inspect.signature(func)
     return arg_name in sig.parameters
+
+
+def assert_signatures_in_sync(
+    source_func: Callable[..., Any],
+    check_func: Callable[..., Any],
+    *,
+    exclude_params: set[str] = set(),
+) -> None:
+    """Ensure that the signature of the second function matches the first."""
+
+    check_sig = inspect.signature(check_func)
+    source_sig = inspect.signature(source_func)
+
+    errors: list[str] = []
+
+    for name, source_param in source_sig.parameters.items():
+        if name in exclude_params:
+            continue
+
+        custom_param = check_sig.parameters.get(name)
+        if not custom_param:
+            errors.append(f"the `{name}` param is missing")
+            continue
+
+        if custom_param.annotation != source_param.annotation:
+            errors.append(
+                f"types for the `{name}` param are do not match; source={repr(source_param.annotation)} checking={repr(source_param.annotation)}"
+            )
+            continue
+
+    if errors:
+        raise AssertionError(f"{len(errors)} errors encountered when comparing signatures:\n\n" + "\n\n".join(errors))

src/prompt_foundry_python_sdk/resources/prompts.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Dict, Iterable, Optional
+from typing import Any, Dict, Iterable, Optional, cast
 
 import httpx
 
@@ -257,21 +257,24 @@ def get_parameters(
         """
         if not id:
             raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
-        return self._post(
-            f"/sdk/v1/prompts/{id}",
-            body=maybe_transform(
-                {
-                    "append_messages": append_messages,
-                    "override_messages": override_messages,
-                    "user": user,
-                    "variables": variables,
-                },
-                prompt_get_parameters_params.PromptGetParametersParams,
-            ),
-            options=make_request_options(
-                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+        return cast(
+            ModelParameters,
+            self._post(
+                f"/sdk/v1/prompts/{id}",
+                body=maybe_transform(
+                    {
+                        "append_messages": append_messages,
+                        "override_messages": override_messages,
+                        "user": user,
+                        "variables": variables,
+                    },
+                    prompt_get_parameters_params.PromptGetParametersParams,
+                ),
+                options=make_request_options(
+                    extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+                ),
+                cast_to=cast(Any, ModelParameters),  # Union types cannot be passed in as arguments in the type system
             ),
-            cast_to=ModelParameters,
         )
 
 
@@ -501,21 +504,24 @@ async def get_parameters(
         """
         if not id:
             raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
-        return await self._post(
-            f"/sdk/v1/prompts/{id}",
-            body=await async_maybe_transform(
-                {
-                    "append_messages": append_messages,
-                    "override_messages": override_messages,
-                    "user": user,
-                    "variables": variables,
-                },
-                prompt_get_parameters_params.PromptGetParametersParams,
-            ),
-            options=make_request_options(
-                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+        return cast(
+            ModelParameters,
+            await self._post(
+                f"/sdk/v1/prompts/{id}",
+                body=await async_maybe_transform(
+                    {
+                        "append_messages": append_messages,
+                        "override_messages": override_messages,
+                        "user": user,
+                        "variables": variables,
+                    },
+                    prompt_get_parameters_params.PromptGetParametersParams,
+                ),
+                options=make_request_options(
+                    extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+                ),
+                cast_to=cast(Any, ModelParameters),  # Union types cannot be passed in as arguments in the type system
             ),
-            cast_to=ModelParameters,
         )