lambdadb 0.3.5__py3-none-any.whl → 0.3.6__py3-none-any.whl

lambdadb/models/updatedocsop.py

@@ -4,25 +4,17 @@ from __future__ import annotations
 from lambdadb.types import BaseModel
 from lambdadb.utils import FieldMetadata, PathParamMetadata, RequestMetadata
 import pydantic
-from typing import List
+from typing import Any, Dict, List
 from typing_extensions import Annotated, TypedDict
 
 
-class UpdateDocsDocTypedDict(TypedDict):
-    pass
-
-
-class UpdateDocsDoc(BaseModel):
-    pass
-
-
 class UpdateDocsRequestBodyTypedDict(TypedDict):
-    docs: List[UpdateDocsDocTypedDict]
+    docs: List[Dict[str, Any]]
     r"""A list of documents to update. Each document must contain 'id' field to be updated."""
 
 
 class UpdateDocsRequestBody(BaseModel):
-    docs: List[UpdateDocsDoc]
+    docs: List[Dict[str, Any]]
     r"""A list of documents to update. Each document must contain 'id' field to be updated."""
 
 

lambdadb/models/upsertdocsop.py

@@ -4,25 +4,17 @@ from __future__ import annotations
 from lambdadb.types import BaseModel
 from lambdadb.utils import FieldMetadata, PathParamMetadata, RequestMetadata
 import pydantic
-from typing import List
+from typing import Any, Dict, List
 from typing_extensions import Annotated, TypedDict
 
 
-class UpsertDocsDocTypedDict(TypedDict):
-    pass
-
-
-class UpsertDocsDoc(BaseModel):
-    pass
-
-
 class UpsertDocsRequestBodyTypedDict(TypedDict):
-    docs: List[UpsertDocsDocTypedDict]
+    docs: List[Dict[str, Any]]
     r"""A list of documents to upsert."""
 
 
 class UpsertDocsRequestBody(BaseModel):
-    docs: List[UpsertDocsDoc]
+    docs: List[Dict[str, Any]]
     r"""A list of documents to upsert."""
 
 

lambdadb/utils/__init__.py

@@ -29,6 +29,7 @@ if TYPE_CHECKING:
         marshal_json,
         unmarshal,
         unmarshal_json,
+        unmarshal_json_response,
         serialize_decimal,
         serialize_float,
         serialize_int,
@@ -98,6 +99,7 @@ __all__ = [
     "template_url",
     "unmarshal",
     "unmarshal_json",
+    "unmarshal_json_response",
     "validate_decimal",
     "validate_const",
     "validate_float",
@@ -152,6 +154,7 @@ _dynamic_imports: dict[str, str] = {
     "template_url": ".url",
     "unmarshal": ".serializers",
     "unmarshal_json": ".serializers",
+    "unmarshal_json_response": ".serializers",
     "validate_decimal": ".serializers",
     "validate_const": ".serializers",
     "validate_float": ".serializers",

lambdadb/utils/serializers.py

@@ -4,7 +4,7 @@ from decimal import Decimal
 import functools
 import json
 import typing
-from typing import Any, Dict, List, Tuple, Union, get_args
+from typing import Any, Dict, List, Optional, Tuple, Union, get_args
 import typing_extensions
 from typing_extensions import get_origin
 
@@ -13,6 +13,7 @@ from pydantic import ConfigDict, create_model
 from pydantic_core import from_json
 
 from ..types.basemodel import BaseModel, Nullable, OptionalNullable, Unset
+from lambdadb import errors
 
 
 def serialize_decimal(as_str: bool):
@@ -140,6 +141,22 @@ def unmarshal_json(raw, typ: Any) -> Any:
     return unmarshal(from_json(raw), typ)
 
 
+def unmarshal_json_response(
+    typ: Any, http_res: httpx.Response, body: Optional[str] = None
+) -> Any:
+    if body is None:
+        body = http_res.text
+    try:
+        return unmarshal_json(body, typ)
+    except Exception as e:
+        raise errors.ResponseValidationError(
+            "Response validation failed",
+            http_res,
+            e,
+            body,
+        ) from e
+
+
 def unmarshal(val, typ: Any) -> Any:
     unmarshaller = create_model(
         "Unmarshaller",
@@ -192,7 +209,9 @@ def is_union(obj: object) -> bool:
     """
     Returns True if the given object is a typing.Union or typing_extensions.Union.
     """
-    return any(obj is typing_obj for typing_obj in _get_typing_objects_by_name_of("Union"))
+    return any(
+        obj is typing_obj for typing_obj in _get_typing_objects_by_name_of("Union")
+    )
 
 
 def stream_to_text(stream: httpx.Response) -> str:
@@ -245,4 +264,3 @@ def _get_typing_objects_by_name_of(name: str) -> Tuple[Any, ...]:
             f"Neither typing nor typing_extensions has an object called {name!r}"
         )
     return result
-

{lambdadb-0.3.5.dist-info → lambdadb-0.3.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: lambdadb
-Version: 0.3.5
+Version: 0.3.6
 Summary: Python Client SDK Generated by Speakeasy.
 Author: Speakeasy
 Requires-Python: >=3.9.2
@@ -265,29 +265,18 @@ with LambdaDB(
 <!-- Start Error Handling [errors] -->
 ## Error Handling
 
-Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.
+[`LambdaDBError`](https://github.com/lambdadb/lambdadb-python-client/blob/master/./src/lambdadb/errors/lambdadberror.py) is the base class for all HTTP error responses. It has the following properties:
 
-By default, an API error will raise a errors.APIError exception, which has the following properties:
-
-| Property        | Type             | Description           |
-|-----------------|------------------|-----------------------|
-| `.status_code`  | *int*            | The HTTP status code  |
-| `.message`      | *str*            | The error message     |
-| `.raw_response` | *httpx.Response* | The raw HTTP response |
-| `.body`         | *str*            | The response content  |
-
-When custom error responses are specified for an operation, the SDK may also raise their associated exceptions. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `list_async` method may raise the following exceptions:
-
-| Error Type                   | Status Code | Content Type     |
-| ---------------------------- | ----------- | ---------------- |
-| errors.UnauthenticatedError  | 401         | application/json |
-| errors.ResourceNotFoundError | 404         | application/json |
-| errors.TooManyRequestsError  | 429         | application/json |
-| errors.InternalServerError   | 500         | application/json |
-| errors.APIError              | 4XX, 5XX    | \*/\*            |
+| Property           | Type             | Description                                                                             |
+| ------------------ | ---------------- | --------------------------------------------------------------------------------------- |
+| `err.message`      | `str`            | Error message                                                                           |
+| `err.status_code`  | `int`            | HTTP response status code eg `404`                                                      |
+| `err.headers`      | `httpx.Headers`  | HTTP response headers                                                                   |
+| `err.body`         | `str`            | HTTP body. Can be empty string if no body is returned.                                  |
+| `err.raw_response` | `httpx.Response` | Raw HTTP response                                                                       |
+| `err.data`         |                  | Optional. Some errors may contain structured data. [See Error Classes](https://github.com/lambdadb/lambdadb-python-client/blob/master/#error-classes). |
 
 ### Example
-
 ```python
 from lambdadb import LambdaDB, errors
 
@@ -303,22 +292,46 @@ with LambdaDB(
         # Handle response
         print(res)
 
-    except errors.UnauthenticatedError as e:
-        # handle e.data: errors.UnauthenticatedErrorData
-        raise(e)
-    except errors.ResourceNotFoundError as e:
-        # handle e.data: errors.ResourceNotFoundErrorData
-        raise(e)
-    except errors.TooManyRequestsError as e:
-        # handle e.data: errors.TooManyRequestsErrorData
-        raise(e)
-    except errors.InternalServerError as e:
-        # handle e.data: errors.InternalServerErrorData
-        raise(e)
-    except errors.APIError as e:
-        # handle exception
-        raise(e)
+
+    except errors.LambdaDBError as e:
+        # The base class for HTTP error responses
+        print(e.message)
+        print(e.status_code)
+        print(e.body)
+        print(e.headers)
+        print(e.raw_response)
+
+        # Depending on the method different errors may be thrown
+        if isinstance(e, errors.UnauthenticatedError):
+            print(e.data.message)  # Optional[str]
 ```
+
+### Error Classes
+**Primary errors:**
+* [`LambdaDBError`](https://github.com/lambdadb/lambdadb-python-client/blob/master/./src/lambdadb/errors/lambdadberror.py): The base class for HTTP error responses.
+  * [`UnauthenticatedError`](https://github.com/lambdadb/lambdadb-python-client/blob/master/./src/lambdadb/errors/unauthenticatederror.py): Unauthenticated. Status code `401`.
+  * [`TooManyRequestsError`](https://github.com/lambdadb/lambdadb-python-client/blob/master/./src/lambdadb/errors/toomanyrequestserror.py): Too many requests. Status code `429`.
+  * [`InternalServerError`](https://github.com/lambdadb/lambdadb-python-client/blob/master/./src/lambdadb/errors/internalservererror.py): Internal server error. Status code `500`.
+  * [`ResourceNotFoundError`](https://github.com/lambdadb/lambdadb-python-client/blob/master/./src/lambdadb/errors/resourcenotfounderror.py): Resource not found. Status code `404`. *
+
+<details><summary>Less common errors (7)</summary>
+
+<br />
+
+**Network errors:**
+* [`httpx.RequestError`](https://www.python-httpx.org/exceptions/#httpx.RequestError): Base class for request errors.
+    * [`httpx.ConnectError`](https://www.python-httpx.org/exceptions/#httpx.ConnectError): HTTP client was unable to make a request to a server.
+    * [`httpx.TimeoutException`](https://www.python-httpx.org/exceptions/#httpx.TimeoutException): HTTP request timed out.
+
+
+**Inherit from [`LambdaDBError`](https://github.com/lambdadb/lambdadb-python-client/blob/master/./src/lambdadb/errors/lambdadberror.py)**:
+* [`BadRequestError`](https://github.com/lambdadb/lambdadb-python-client/blob/master/./src/lambdadb/errors/badrequesterror.py): Bad request. Status code `400`. Applicable to 8 of 12 methods.*
+* [`ResourceAlreadyExistsError`](https://github.com/lambdadb/lambdadb-python-client/blob/master/./src/lambdadb/errors/resourcealreadyexistserror.py): Resource already exists. Status code `409`. Applicable to 1 of 12 methods.*
+* [`ResponseValidationError`](https://github.com/lambdadb/lambdadb-python-client/blob/master/./src/lambdadb/errors/responsevalidationerror.py): Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the `cause` attribute.
+
+</details>
+
+\* Check [the method documentation](https://github.com/lambdadb/lambdadb-python-client/blob/master/#available-resources-and-operations) to see if the error is applicable.
 <!-- End Error Handling [errors] -->
 
 <!-- Start Server Selection [server] -->

{lambdadb-0.3.5.dist-info → lambdadb-0.3.6.dist-info}/RECORD

@@ -3,43 +3,46 @@ lambdadb/_hooks/__init__.py,sha256=p5J13DeYuISQyQWirjJAObHIf2VtIlOtFqnIpvjjVwk,1
 lambdadb/_hooks/registration.py,sha256=1QZB41w6If7I9dXiOSQx6dhSc6BPWrnI5Q5bMOr4iVA,624
 lambdadb/_hooks/sdkhooks.py,sha256=KGhPvIuUjurDBQOT6t-aWgiu1YDRXpn-OMz6_PkUdFk,2463
 lambdadb/_hooks/types.py,sha256=09dUW5q4HN9aVFAhskDLQqjxLPBfDD97uuucmdcBa6Q,2987
-lambdadb/_version.py,sha256=mUNQT60-6bl5j9CY2piPzK71WbiJ0yB9aEx7uEANrlM,458
-lambdadb/basesdk.py,sha256=Uo8ZEdXVHmS_j1F9on47XeJD6sj9plIrna_6Oo_1I-I,11853
-lambdadb/collections.py,sha256=FJN_V6_q05oplCvCvwHB04IXtUbW9vwSk3v29_r1Ab8,69031
-lambdadb/docs.py,sha256=pUv9XW8Xdk3y2TJxekbaSYlnSboU3fU0TxFts7uY_CY,69126
-lambdadb/errors/__init__.py,sha256=V406LU9TLJQ0eocD79_PpsCjOmH6DAUnBTKd0Ra23uQ,2637
-lambdadb/errors/apierror.py,sha256=9mTyJSyvUAOnSfW_1HWt9dGl8IDlpQ68DebwYsDNdug,528
-lambdadb/errors/badrequest_error.py,sha256=OX1fo-ja-N-zqV4opH_LXnz_vwa2gZbgDx0aAeNMYL0,514
-lambdadb/errors/internalservererror.py,sha256=O0VPyz_TliHsqNzAVRLirKSME4vry_PK3gqWXwod9kM,534
-lambdadb/errors/resourcealreadyexists_error.py,sha256=5NV-yict5rCGXeP9X2P-DjjPB57hRAOavs340v8wXb8,569
-lambdadb/errors/resourcenotfound_error.py,sha256=VfsNJ9xJjMzZFoQGt5wu6JkUpRzFhrPn79Z_4jBmUY0,544
-lambdadb/errors/toomanyrequests_error.py,sha256=yHFjs27JCb5mVmOZZqKmA4IG1ONs6FVERWIK_Gwgqwo,539
-lambdadb/errors/unauthenticated_error.py,sha256=HD2a2JwLcIDefnkDLdbHJCbkY28u2cmAGOI8S6Q5m48,539
+lambdadb/_version.py,sha256=hEqkhi_r43UUrFatU2fOhQMkFz0vavozAHPDcH_8dlI,458
+lambdadb/basesdk.py,sha256=wu3Ri2Po6LxhBngXYkD4-Grlxa0DX9I18cPH2vme-uI,11887
+lambdadb/collections.py,sha256=bc30Eq_PAJ9uuigEoXhcdUBlnSmmxRAeBNpqZSWBEpA,64975
+lambdadb/docs.py,sha256=ACGOOteLtbXbR1hW5HzbhTs487P6prshFBwvx42y4P8,64677
+lambdadb/errors/__init__.py,sha256=9_lvXJNi04FsujmLRi4BbOUtWA0L2ob2BJRBnXT5Kpg,3016
+lambdadb/errors/apierror.py,sha256=OBYy3l8_qBC4OXKwl_OwY5ko4klJvjd0j9bqy1C_VZo,1224
+lambdadb/errors/badrequest_error.py,sha256=0n_4BpubMGSKYHyJuvZnXGYRbDKs9G0QN6sm6xZLDeI,693
+lambdadb/errors/internalservererror.py,sha256=OKDYpPakOeRV8ADPvLTbX_3G892dt60l4VHWb3S506c,709
+lambdadb/errors/lambdadberror.py,sha256=dqU0ytEest7WABRR1JeYEA-dekHn7SiWisH1PZg065Y,715
+lambdadb/errors/no_response_error.py,sha256=FQG44Lq6uF7uUlzbUYfM3dJon6sbqXzJ0Ri6YrDdsEs,380
+lambdadb/errors/resourcealreadyexists_error.py,sha256=ioNmtUZCronzxmkesMH6Ht5QsP3irVYq1L6H7iNMPcQ,737
+lambdadb/errors/resourcenotfound_error.py,sha256=k7v-OzJm95p11rzFYnzpkkCq2i_lx9pT9bjovU9Z2Dg,717
+lambdadb/errors/responsevalidationerror.py,sha256=o_l_D3Z_Npl_BDprawTNU3df7xdoREAWx2GjVGP0eOA,691
+lambdadb/errors/toomanyrequests_error.py,sha256=yLIb-NT2tf7qJglHxleMUDNGnGSP2-_3CGzqiXIHtLE,713
+lambdadb/errors/unauthenticated_error.py,sha256=Ha7K1fbnx53nTxy8hRr1BW1qOEbtsJa3RjJWR9rPhsM,713
 lambdadb/httpclient.py,sha256=Eu73urOAiZQtdUIyOUnPccxCiBbWEKrXG-JrRG3SLM4,3946
-lambdadb/models/__init__.py,sha256=WSl2r1PGIVHgCHxnfOFF_uulLqpyUqSVGNgzM9eSvPM,12134
+lambdadb/models/__init__.py,sha256=2omt5SgoTlRQyQEB85qp4w0BBTPJaNQP_gA0PdsnBV8,10853
 lambdadb/models/bulkupsertdocsop.py,sha256=wjADqZrC71TNmyGUWhuQ5ZVibZc4dL9SACLdWHumToo,1390
 lambdadb/models/collectionresponse.py,sha256=ZIF-GLeOV8RS-7MBSXGQuOjzOqeqCoTV_a5cndfnpug,1943
 lambdadb/models/createcollectionop.py,sha256=KoQlGTr3eYr8GINmlslL8DDf5dCY97hliVuevtD_Fr8,2518
 lambdadb/models/deletecollectionop.py,sha256=fy4Y0dGAB8AJbGxryKnE6xOCj_QTi9R4SzkcYwY74WY,871
-lambdadb/models/deletedocsop.py,sha256=aPWHLQZyBtPsC-eVSt9GUEpEAfqhFmOvjkVmWmql_is,1635
-lambdadb/models/fetchdocsop.py,sha256=LV8raabA2ZyFvPsW_-5nmczsegj-H4cTF-AWHdZo4kw,3133
+lambdadb/models/deletedocsop.py,sha256=IjCVQO6IH3w_RyVe24vpuwZ2fTfKVEUxrQfNkyTtL1o,1540
+lambdadb/models/fetchdocsop.py,sha256=I73mh1eDC_1hOaDYuxP88HgHjMJqG3qdHjjCMsKotLA,3034
 lambdadb/models/getbulkupsertdocsop.py,sha256=S67W9IBoGXP8EVEGc6PfKkJgmOydzBhkzu6f6g2eGOU,2526
 lambdadb/models/getcollectionop.py,sha256=Ef5uUwNHfnzU8Ij_E_8j1s4qYDy36C7mXiQZ8LY8VME,1199
 lambdadb/models/indexconfigs_union.py,sha256=LW0afqNPHxSd7PVyhi9bWALLkofPpewIzWCH5hlghkI,2055
 lambdadb/models/listcollectionsop.py,sha256=pfBvxfnsFwgsxPUg0Dkl1WeMOcsjvdOTcfx1iPUktEM,1028
 lambdadb/models/messageresponse.py,sha256=0QI5LuyZVLh0Z6Jytwlo2ebAZ6x1bw5TVe7zvzQCEnM,300
-lambdadb/models/querycollectionop.py,sha256=_Vn7cEMKXhH58nygR7zxzenB6V8EKeI7-K23g33H0jQ,4275
+lambdadb/models/querycollectionop.py,sha256=UBhzSLT5PNJYCAmkITbh-II0nLZJkR1NzEWhv_JtgVE,3984
 lambdadb/models/security.py,sha256=nP-VTWFY6O-UPNPsWcsg38JcXr2zSy_m7qieDix6SxA,698
 lambdadb/models/status.py,sha256=pl66KcDT9ao6yLXXXOBqerh_StjpNiJb34Yf7VoijEI,250
 lambdadb/models/updatecollectionop.py,sha256=oj-BlL3i-o_9WETep10kOQfAIEfO73FgJ2XR4QT_5JI,1790
-lambdadb/models/updatedocsop.py,sha256=mtrU_5vNSzI90cprqb4IttiHVknCclcTnVWrv9GQ2tA,1542
-lambdadb/models/upsertdocsop.py,sha256=aLj0ohOrwEVNOXLZI8DuIK-Z0xWdC-SBi6vDmUoH54I,1436
+lambdadb/models/updatedocsop.py,sha256=u2YYXaJlEp9M-eu3vue6YTun-Vs8yDHn_NNZgKlTIvQ,1451
+lambdadb/models/upsertdocsop.py,sha256=LjR_BbUgOwfPffpZ3N_MK0U60CL4izQl85zOWbHfNSM,1345
 lambdadb/py.typed,sha256=zrp19r0G21lr2yRiMC0f8MFkQFGj9wMpSbboePMg8KM,59
 lambdadb/sdk.py,sha256=r_MR7eLbat4LunLaRLw3GdkxXubZ6hEn0kegigYJ3vk,6097
 lambdadb/sdkconfiguration.py,sha256=-sHtaoBluBcNOYRTKxLMnovJazRm3ZWV9VOYCSS0UNY,1589
 lambdadb/types/__init__.py,sha256=RArOwSgeeTIva6h-4ttjXwMUeCkz10nAFBL9D-QljI4,377
 lambdadb/types/basemodel.py,sha256=L79WXvTECbSqaJzs8D3ud_KdIWkU7Cx2wbohDAktE9E,1127
-lambdadb/utils/__init__.py,sha256=BQt6xIdX86A6mOHAnxAXBXaPgdUJtDy2-_4ymAsII_Y,5436
+lambdadb/utils/__init__.py,sha256=7PZhKrdGnbPpXnPNaJR8C8QXpKC-mkyaJA_zglZUDLc,5547
 lambdadb/utils/annotations.py,sha256=aR7mZG34FzgRdew7WZPYEu9QGBerpuKxCF4sek5Z_5Y,1699
 lambdadb/utils/datetimes.py,sha256=oppAA5e3V35pQov1-FNLKxAaNF1_XWi-bQtyjjql3H8,855
 lambdadb/utils/enums.py,sha256=REU6ydF8gsVL3xaeGX4sMNyiL3q5P9h29-f6Sa6luAE,2633
@@ -52,10 +55,10 @@ lambdadb/utils/queryparams.py,sha256=MTK6inMS1_WwjmMJEJmAn67tSHHJyarpdGRlorRHEtI
 lambdadb/utils/requestbodies.py,sha256=ySjEyjcLi731LNUahWvLOrES2HihuA8VrOJx4eQ7Qzg,2101
 lambdadb/utils/retries.py,sha256=6yhfZifqIat9i76xF0lTR2jLj1IN9BNGyqqxATlEFPU,6348
 lambdadb/utils/security.py,sha256=Dq3M6Ee_x_uWRPZ7vvM4XQNxjCMSlphrRn6qVs1pljU,6034
-lambdadb/utils/serializers.py,sha256=hiHBXM1AY8_N2Z_rvFfNSYwvLBkSQlPGFp8poasdU4s,5986
+lambdadb/utils/serializers.py,sha256=MMoIZJlmaQleupttusWZC6JUi-sRJEpEMGmdBpnRo4Y,6432
 lambdadb/utils/url.py,sha256=BgGPgcTA6MRK4bF8fjP2dUopN3NzEzxWMXPBVg8NQUA,5254
 lambdadb/utils/values.py,sha256=CcaCXEa3xHhkUDROyXZocN8f0bdITftv9Y0P9lTf0YM,3517
-lambdadb-0.3.5.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-lambdadb-0.3.5.dist-info/METADATA,sha256=DxE-j47yJgrDit8bfjgBqFttks75vowhJukdUHObkqQ,18689
-lambdadb-0.3.5.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-lambdadb-0.3.5.dist-info/RECORD,,
+lambdadb-0.3.6.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+lambdadb-0.3.6.dist-info/METADATA,sha256=7agoTL_4vw71fkDRNF_Hoha7TkdB8s4HLhSblcbANn4,20891
+lambdadb-0.3.6.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+lambdadb-0.3.6.dist-info/RECORD,,