fix: pydantic 1.10.15 compatibility (#530)

Author: maxdeichmann

langfuse/api/__init__.py

@@ -58,6 +58,7 @@
     Score,
     ScoreBody,
     ScoreEvent,
+    ScoreSource,
     Scores,
     SdkLogBody,
     SdkLogEvent,
@@ -95,6 +96,7 @@
     trace,
     utils,
 )
+from .version import __version__
 
 __all__ = [
     "AccessDeniedError",
@@ -154,6 +156,7 @@
     "Score",
     "ScoreBody",
     "ScoreEvent",
+    "ScoreSource",
     "Scores",
     "SdkLogBody",
     "SdkLogEvent",
@@ -176,6 +179,7 @@
     "UpdateSpanEvent",
     "Usage",
     "UsageByModel",
+    "__version__",
     "commons",
     "dataset_items",
     "dataset_run_items",

langfuse/api/client.py

@@ -23,6 +23,39 @@
 
 
 class FernLangfuse:
+    """Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propogate to these functions.
+
+    Parameters:
+        - base_url: str. The base url to use for requests from the client.
+
+        - x_langfuse_sdk_name: typing.Optional[str].
+
+        - x_langfuse_sdk_version: typing.Optional[str].
+
+        - x_langfuse_public_key: typing.Optional[str].
+
+        - username: typing.Optional[typing.Union[str, typing.Callable[[], str]]].
+
+        - password: typing.Optional[typing.Union[str, typing.Callable[[], str]]].
+
+        - timeout: typing.Optional[float]. The timeout to be used, in seconds, for requests by default the timeout is 60 seconds, unless a custom httpx client is used, in which case a default is not set.
+
+        - follow_redirects: typing.Optional[bool]. Whether the default httpx client follows redirects or not, this is irrelevant if a custom httpx client is passed in.
+
+        - httpx_client: typing.Optional[httpx.Client]. The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
+    ---
+    from finto.client import FernLangfuse
+
+    client = FernLangfuse(
+        x_langfuse_sdk_name="YOUR_X_LANGFUSE_SDK_NAME",
+        x_langfuse_sdk_version="YOUR_X_LANGFUSE_SDK_VERSION",
+        x_langfuse_public_key="YOUR_X_LANGFUSE_PUBLIC_KEY",
+        username="YOUR_USERNAME",
+        password="YOUR_PASSWORD",
+        base_url="https://yourhost.com/path/to/api",
+    )
+    """
+
     def __init__(
         self,
         *,
@@ -32,19 +65,28 @@ def __init__(
         x_langfuse_public_key: typing.Optional[str] = None,
         username: typing.Optional[typing.Union[str, typing.Callable[[], str]]] = None,
         password: typing.Optional[typing.Union[str, typing.Callable[[], str]]] = None,
-        timeout: typing.Optional[float] = 60,
+        timeout: typing.Optional[float] = None,
+        follow_redirects: typing.Optional[bool] = None,
         httpx_client: typing.Optional[httpx.Client] = None,
     ):
+        _defaulted_timeout = (
+            timeout if timeout is not None else 60 if httpx_client is None else None
+        )
         self._client_wrapper = SyncClientWrapper(
             base_url=base_url,
             x_langfuse_sdk_name=x_langfuse_sdk_name,
             x_langfuse_sdk_version=x_langfuse_sdk_version,
             x_langfuse_public_key=x_langfuse_public_key,
             username=username,
             password=password,
-            httpx_client=httpx.Client(timeout=timeout)
-            if httpx_client is None
-            else httpx_client,
+            httpx_client=httpx_client
+            if httpx_client is not None
+            else httpx.Client(
+                timeout=_defaulted_timeout, follow_redirects=follow_redirects
+            )
+            if follow_redirects is not None
+            else httpx.Client(timeout=_defaulted_timeout),
+            timeout=_defaulted_timeout,
         )
         self.dataset_items = DatasetItemsClient(client_wrapper=self._client_wrapper)
         self.dataset_run_items = DatasetRunItemsClient(
@@ -63,6 +105,39 @@ def __init__(
 
 
 class AsyncFernLangfuse:
+    """Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propogate to these functions.
+
+    Parameters:
+        - base_url: str. The base url to use for requests from the client.
+
+        - x_langfuse_sdk_name: typing.Optional[str].
+
+        - x_langfuse_sdk_version: typing.Optional[str].
+
+        - x_langfuse_public_key: typing.Optional[str].
+
+        - username: typing.Optional[typing.Union[str, typing.Callable[[], str]]].
+
+        - password: typing.Optional[typing.Union[str, typing.Callable[[], str]]].
+
+        - timeout: typing.Optional[float]. The timeout to be used, in seconds, for requests by default the timeout is 60 seconds, unless a custom httpx client is used, in which case a default is not set.
+
+        - follow_redirects: typing.Optional[bool]. Whether the default httpx client follows redirects or not, this is irrelevant if a custom httpx client is passed in.
+
+        - httpx_client: typing.Optional[httpx.AsyncClient]. The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
+    ---
+    from finto.client import AsyncFernLangfuse
+
+    client = AsyncFernLangfuse(
+        x_langfuse_sdk_name="YOUR_X_LANGFUSE_SDK_NAME",
+        x_langfuse_sdk_version="YOUR_X_LANGFUSE_SDK_VERSION",
+        x_langfuse_public_key="YOUR_X_LANGFUSE_PUBLIC_KEY",
+        username="YOUR_USERNAME",
+        password="YOUR_PASSWORD",
+        base_url="https://yourhost.com/path/to/api",
+    )
+    """
+
     def __init__(
         self,
         *,
@@ -72,19 +147,28 @@ def __init__(
         x_langfuse_public_key: typing.Optional[str] = None,
         username: typing.Optional[typing.Union[str, typing.Callable[[], str]]] = None,
         password: typing.Optional[typing.Union[str, typing.Callable[[], str]]] = None,
-        timeout: typing.Optional[float] = 60,
+        timeout: typing.Optional[float] = None,
+        follow_redirects: typing.Optional[bool] = None,
         httpx_client: typing.Optional[httpx.AsyncClient] = None,
     ):
+        _defaulted_timeout = (
+            timeout if timeout is not None else 60 if httpx_client is None else None
+        )
         self._client_wrapper = AsyncClientWrapper(
             base_url=base_url,
             x_langfuse_sdk_name=x_langfuse_sdk_name,
             x_langfuse_sdk_version=x_langfuse_sdk_version,
             x_langfuse_public_key=x_langfuse_public_key,
             username=username,
             password=password,
-            httpx_client=httpx.AsyncClient(timeout=timeout)
-            if httpx_client is None
-            else httpx_client,
+            httpx_client=httpx_client
+            if httpx_client is not None
+            else httpx.AsyncClient(
+                timeout=_defaulted_timeout, follow_redirects=follow_redirects
+            )
+            if follow_redirects is not None
+            else httpx.AsyncClient(timeout=_defaulted_timeout),
+            timeout=_defaulted_timeout,
         )
         self.dataset_items = AsyncDatasetItemsClient(
             client_wrapper=self._client_wrapper

langfuse/api/core/__init__.py

@@ -3,15 +3,25 @@
 from .api_error import ApiError
 from .client_wrapper import AsyncClientWrapper, BaseClientWrapper, SyncClientWrapper
 from .datetime_utils import serialize_datetime
+from .file import File, convert_file_dict_to_httpx_tuples
+from .http_client import AsyncHttpClient, HttpClient
 from .jsonable_encoder import jsonable_encoder
+from .pydantic_utilities import pydantic_v1
 from .remove_none_from_dict import remove_none_from_dict
+from .request_options import RequestOptions
 
 __all__ = [
     "ApiError",
     "AsyncClientWrapper",
+    "AsyncHttpClient",
     "BaseClientWrapper",
+    "File",
+    "HttpClient",
+    "RequestOptions",
     "SyncClientWrapper",
+    "convert_file_dict_to_httpx_tuples",
     "jsonable_encoder",
+    "pydantic_v1",
     "remove_none_from_dict",
     "serialize_datetime",
 ]

langfuse/api/core/api_error.py

@@ -7,9 +7,7 @@ class ApiError(Exception):
     status_code: typing.Optional[int]
     body: typing.Any
 
-    def __init__(
-        self, *, status_code: typing.Optional[int] = None, body: typing.Any = None
-    ):
+    def __init__(self, *, status_code: typing.Optional[int] = None, body: typing.Any = None):
         self.status_code = status_code
         self.body = body
 

langfuse/api/core/client_wrapper.py

@@ -4,6 +4,8 @@
 
 import httpx
 
+from .http_client import AsyncHttpClient, HttpClient
+
 
 class BaseClientWrapper:
     def __init__(
@@ -15,13 +17,15 @@ def __init__(
         username: typing.Optional[typing.Union[str, typing.Callable[[], str]]] = None,
         password: typing.Optional[typing.Union[str, typing.Callable[[], str]]] = None,
         base_url: str,
+        timeout: typing.Optional[float] = None
     ):
         self._x_langfuse_sdk_name = x_langfuse_sdk_name
         self._x_langfuse_sdk_version = x_langfuse_sdk_version
         self._x_langfuse_public_key = x_langfuse_public_key
         self._username = username
         self._password = password
         self._base_url = base_url
+        self._timeout = timeout
 
     def get_headers(self) -> typing.Dict[str, str]:
         headers: typing.Dict[str, str] = {"X-Fern-Language": "Python"}
@@ -52,6 +56,9 @@ def _get_password(self) -> typing.Optional[str]:
     def get_base_url(self) -> str:
         return self._base_url
 
+    def get_timeout(self) -> typing.Optional[float]:
+        return self._timeout
+
 
 class SyncClientWrapper(BaseClientWrapper):
     def __init__(
@@ -63,7 +70,8 @@ def __init__(
         username: typing.Optional[typing.Union[str, typing.Callable[[], str]]] = None,
         password: typing.Optional[typing.Union[str, typing.Callable[[], str]]] = None,
         base_url: str,
-        httpx_client: httpx.Client,
+        timeout: typing.Optional[float] = None,
+        httpx_client: httpx.Client
     ):
         super().__init__(
             x_langfuse_sdk_name=x_langfuse_sdk_name,
@@ -72,8 +80,9 @@ def __init__(
             username=username,
             password=password,
             base_url=base_url,
+            timeout=timeout,
         )
-        self.httpx_client = httpx_client
+        self.httpx_client = HttpClient(httpx_client=httpx_client)
 
 
 class AsyncClientWrapper(BaseClientWrapper):
@@ -86,7 +95,8 @@ def __init__(
         username: typing.Optional[typing.Union[str, typing.Callable[[], str]]] = None,
         password: typing.Optional[typing.Union[str, typing.Callable[[], str]]] = None,
         base_url: str,
-        httpx_client: httpx.AsyncClient,
+        timeout: typing.Optional[float] = None,
+        httpx_client: httpx.AsyncClient
     ):
         super().__init__(
             x_langfuse_sdk_name=x_langfuse_sdk_name,
@@ -95,5 +105,6 @@ def __init__(
             username=username,
             password=password,
             base_url=base_url,
+            timeout=timeout,
         )
-        self.httpx_client = httpx_client
+        self.httpx_client = AsyncHttpClient(httpx_client=httpx_client)

langfuse/api/core/datetime_utils.py

@@ -12,9 +12,7 @@ def serialize_datetime(v: dt.datetime) -> str:
     """
 
     def _serialize_zoned_datetime(v: dt.datetime) -> str:
-        if v.tzinfo is not None and v.tzinfo.tzname(None) == dt.timezone.utc.tzname(
-            None
-        ):
+        if v.tzinfo is not None and v.tzinfo.tzname(None) == dt.timezone.utc.tzname(None):
             # UTC is a special case where we use "Z" at the end instead of "+00:00"
             return v.isoformat().replace("+00:00", "Z")
         else:

langfuse/api/core/file.py

@@ -0,0 +1,36 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+# File typing inspired by the flexibility of types within the httpx library
+# https://github.com/encode/httpx/blob/master/httpx/_types.py
+FileContent = typing.Union[typing.IO[bytes], bytes, str]
+File = typing.Union[
+    # file (or bytes)
+    FileContent,
+    # (filename, file (or bytes))
+    typing.Tuple[typing.Optional[str], FileContent],
+    # (filename, file (or bytes), content_type)
+    typing.Tuple[typing.Optional[str], FileContent, typing.Optional[str]],
+    # (filename, file (or bytes), content_type, headers)
+    typing.Tuple[typing.Optional[str], FileContent, typing.Optional[str], typing.Mapping[str, str]],
+]
+
+
+def convert_file_dict_to_httpx_tuples(
+    d: typing.Dict[str, typing.Union[File, typing.List[File]]]
+) -> typing.List[typing.Tuple[str, File]]:
+    """The format we use is a list of tuples, where the first element is the
+    name of the file and the second is the file object. Typically HTTPX wants
+    a dict, but to be able to send lists of files, you have to use the list
+    approach (which also works for non-lists)
+    https://github.com/encode/httpx/pull/1032
+    """
+    httpx_tuples = []
+    for key, file_like in d.items():
+        if isinstance(file_like, list):
+            for file_like_item in file_like:
+                httpx_tuples.append((key, file_like_item))
+        else:
+            httpx_tuples.append((key, file_like))
+    return httpx_tuples