skyflow-flowvault-python 1.0.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (202) hide show
  1. common/.coveragerc +4 -0
  2. common/__init__.py +3 -0
  3. common/client/__init__.py +0 -0
  4. common/client/base_skyflow.py +345 -0
  5. common/client/utils/__init__.py +1 -0
  6. common/client/utils/_utils.py +127 -0
  7. common/errors/__init__.py +1 -0
  8. common/errors/_skyflow_error.py +17 -0
  9. common/generated/__init__.py +0 -0
  10. common/generated/rest/__init__.py +24 -0
  11. common/generated/rest/authentication/__init__.py +4 -0
  12. common/generated/rest/authentication/client.py +181 -0
  13. common/generated/rest/authentication/raw_client.py +241 -0
  14. common/generated/rest/client.py +153 -0
  15. common/generated/rest/core/__init__.py +52 -0
  16. common/generated/rest/core/api_error.py +23 -0
  17. common/generated/rest/core/client_wrapper.py +86 -0
  18. common/generated/rest/core/datetime_utils.py +28 -0
  19. common/generated/rest/core/file.py +67 -0
  20. common/generated/rest/core/force_multipart.py +16 -0
  21. common/generated/rest/core/http_client.py +543 -0
  22. common/generated/rest/core/http_response.py +55 -0
  23. common/generated/rest/core/jsonable_encoder.py +100 -0
  24. common/generated/rest/core/pydantic_utilities.py +255 -0
  25. common/generated/rest/core/query_encoder.py +58 -0
  26. common/generated/rest/core/remove_none_from_dict.py +11 -0
  27. common/generated/rest/core/request_options.py +35 -0
  28. common/generated/rest/core/serialization.py +276 -0
  29. common/generated/rest/environment.py +8 -0
  30. common/generated/rest/errors/__init__.py +9 -0
  31. common/generated/rest/errors/bad_request_error.py +14 -0
  32. common/generated/rest/errors/not_found_error.py +14 -0
  33. common/generated/rest/errors/unauthorized_error.py +14 -0
  34. common/generated/rest/py.typed +0 -0
  35. common/generated/rest/types/__init__.py +9 -0
  36. common/generated/rest/types/googlerpc_status.py +22 -0
  37. common/generated/rest/types/protobuf_any.py +21 -0
  38. common/generated/rest/types/v_1_get_auth_token_response.py +33 -0
  39. common/generated/rest/version.py +6 -0
  40. common/service_account/__init__.py +1 -0
  41. common/service_account/_utils.py +248 -0
  42. common/service_account/client/__init__.py +0 -0
  43. common/service_account/client/auth_client.py +13 -0
  44. common/utils/__init__.py +4 -0
  45. common/utils/_helpers.py +18 -0
  46. common/utils/_skyflow_messages.py +445 -0
  47. common/utils/_utils.py +50 -0
  48. common/utils/constants.py +291 -0
  49. common/utils/enums/__init__.py +12 -0
  50. common/utils/enums/content_types.py +9 -0
  51. common/utils/enums/detect_entities.py +73 -0
  52. common/utils/enums/detect_output_transcriptions.py +8 -0
  53. common/utils/enums/env.py +13 -0
  54. common/utils/enums/log_level.py +8 -0
  55. common/utils/enums/masking_method.py +5 -0
  56. common/utils/enums/redaction_type.py +7 -0
  57. common/utils/enums/request_method.py +8 -0
  58. common/utils/enums/token_mode.py +6 -0
  59. common/utils/enums/token_type.py +6 -0
  60. common/utils/logger/__init__.py +2 -0
  61. common/utils/logger/_log_helpers.py +47 -0
  62. common/utils/logger/_logger.py +50 -0
  63. common/utils/validations/__init__.py +11 -0
  64. common/utils/validations/_validations.py +267 -0
  65. common/vault/base_vault_client.py +122 -0
  66. common/vault/base_vault_controller.py +58 -0
  67. common/vault/data/__init__.py +2 -0
  68. common/vault/data/_base_insert_request.py +7 -0
  69. common/vault/data/_base_insert_response.py +11 -0
  70. skyflow/__init__.py +2 -0
  71. skyflow/client/__init__.py +1 -0
  72. skyflow/client/_http_config_builder.py +45 -0
  73. skyflow/client/skyflow.py +15 -0
  74. skyflow/error/__init__.py +3 -0
  75. skyflow/generated/__init__.py +0 -0
  76. skyflow/generated/rest/__init__.py +164 -0
  77. skyflow/generated/rest/_default_clients.py +32 -0
  78. skyflow/generated/rest/client.py +385 -0
  79. skyflow/generated/rest/core/__init__.py +127 -0
  80. skyflow/generated/rest/core/api_error.py +23 -0
  81. skyflow/generated/rest/core/client_wrapper.py +148 -0
  82. skyflow/generated/rest/core/datetime_utils.py +70 -0
  83. skyflow/generated/rest/core/file.py +67 -0
  84. skyflow/generated/rest/core/force_multipart.py +18 -0
  85. skyflow/generated/rest/core/http_client.py +940 -0
  86. skyflow/generated/rest/core/http_response.py +63 -0
  87. skyflow/generated/rest/core/http_sse/__init__.py +42 -0
  88. skyflow/generated/rest/core/http_sse/_api.py +455 -0
  89. skyflow/generated/rest/core/http_sse/_decoders.py +74 -0
  90. skyflow/generated/rest/core/http_sse/_exceptions.py +7 -0
  91. skyflow/generated/rest/core/http_sse/_models.py +17 -0
  92. skyflow/generated/rest/core/jsonable_encoder.py +133 -0
  93. skyflow/generated/rest/core/logging.py +107 -0
  94. skyflow/generated/rest/core/parse_error.py +36 -0
  95. skyflow/generated/rest/core/pydantic_utilities.py +486 -0
  96. skyflow/generated/rest/core/query_encoder.py +58 -0
  97. skyflow/generated/rest/core/remove_none_from_dict.py +11 -0
  98. skyflow/generated/rest/core/request_options.py +40 -0
  99. skyflow/generated/rest/core/serialization.py +347 -0
  100. skyflow/generated/rest/environment.py +8 -0
  101. skyflow/generated/rest/errors/__init__.py +53 -0
  102. skyflow/generated/rest/errors/bad_request_error.py +11 -0
  103. skyflow/generated/rest/errors/forbidden_error.py +11 -0
  104. skyflow/generated/rest/errors/internal_server_error.py +11 -0
  105. skyflow/generated/rest/errors/not_found_error.py +11 -0
  106. skyflow/generated/rest/errors/too_many_requests_error.py +11 -0
  107. skyflow/generated/rest/errors/unauthorized_error.py +11 -0
  108. skyflow/generated/rest/py.typed +0 -0
  109. skyflow/generated/rest/query/__init__.py +4 -0
  110. skyflow/generated/rest/query/client.py +139 -0
  111. skyflow/generated/rest/query/raw_client.py +239 -0
  112. skyflow/generated/rest/raw_client.py +86 -0
  113. skyflow/generated/rest/records/__init__.py +34 -0
  114. skyflow/generated/rest/records/client.py +685 -0
  115. skyflow/generated/rest/records/raw_client.py +988 -0
  116. skyflow/generated/rest/records/types/__init__.py +34 -0
  117. skyflow/generated/rest/records/types/update_request_update_type.py +5 -0
  118. skyflow/generated/rest/tokens/__init__.py +4 -0
  119. skyflow/generated/rest/tokens/client.py +246 -0
  120. skyflow/generated/rest/tokens/raw_client.py +507 -0
  121. skyflow/generated/rest/types/__init__.py +116 -0
  122. skyflow/generated/rest/types/column_redactions.py +33 -0
  123. skyflow/generated/rest/types/delete_response.py +23 -0
  124. skyflow/generated/rest/types/delete_response_object.py +42 -0
  125. skyflow/generated/rest/types/detokenize_response.py +23 -0
  126. skyflow/generated/rest/types/detokenize_response_object.py +54 -0
  127. skyflow/generated/rest/types/error_response.py +20 -0
  128. skyflow/generated/rest/types/error_response_error.py +28 -0
  129. skyflow/generated/rest/types/execute_query_record_response.py +22 -0
  130. skyflow/generated/rest/types/execute_query_response.py +26 -0
  131. skyflow/generated/rest/types/execute_query_response_metadata.py +26 -0
  132. skyflow/generated/rest/types/get_request_data.py +60 -0
  133. skyflow/generated/rest/types/get_response.py +23 -0
  134. skyflow/generated/rest/types/get_tokens_from_values_request_object.py +30 -0
  135. skyflow/generated/rest/types/get_tokens_from_values_response.py +23 -0
  136. skyflow/generated/rest/types/google_protobuf_value.py +8 -0
  137. skyflow/generated/rest/types/http_code.py +6 -0
  138. skyflow/generated/rest/types/insert_record_data.py +36 -0
  139. skyflow/generated/rest/types/insert_response.py +23 -0
  140. skyflow/generated/rest/types/record_response_object.py +70 -0
  141. skyflow/generated/rest/types/token_group_redactions.py +33 -0
  142. skyflow/generated/rest/types/tokenize_response_object.py +49 -0
  143. skyflow/generated/rest/types/unique_value.py +22 -0
  144. skyflow/generated/rest/types/update_record_data.py +52 -0
  145. skyflow/generated/rest/types/update_record_data_update_type.py +5 -0
  146. skyflow/generated/rest/types/update_response.py +23 -0
  147. skyflow/generated/rest/types/upsert.py +45 -0
  148. skyflow/generated/rest/types/upsert_update_type.py +5 -0
  149. skyflow/generated/rest/version.py +6 -0
  150. skyflow/service_account/__init__.py +15 -0
  151. skyflow/utils/__init__.py +9 -0
  152. skyflow/utils/_http_config.py +36 -0
  153. skyflow/utils/_response_parsing.py +66 -0
  154. skyflow/utils/_retry.py +97 -0
  155. skyflow/utils/_skyflow_messages.py +114 -0
  156. skyflow/utils/_utils.py +54 -0
  157. skyflow/utils/_version.py +1 -0
  158. skyflow/utils/enums/__init__.py +3 -0
  159. skyflow/utils/enums/_custom_header_key.py +10 -0
  160. skyflow/utils/enums/_env_urls.py +9 -0
  161. skyflow/utils/enums/_upsert_type.py +7 -0
  162. skyflow/utils/validations/__init__.py +9 -0
  163. skyflow/utils/validations/_validations.py +195 -0
  164. skyflow/vault/__init__.py +0 -0
  165. skyflow/vault/client/__init__.py +0 -0
  166. skyflow/vault/client/client.py +102 -0
  167. skyflow/vault/controller/__init__.py +1 -0
  168. skyflow/vault/controller/_vault.py +475 -0
  169. skyflow/vault/data/__init__.py +30 -0
  170. skyflow/vault/data/_column_redactions.py +4 -0
  171. skyflow/vault/data/_delete_options.py +8 -0
  172. skyflow/vault/data/_delete_request.py +5 -0
  173. skyflow/vault/data/_delete_response.py +9 -0
  174. skyflow/vault/data/_delete_response_record.py +9 -0
  175. skyflow/vault/data/_detokenize_options.py +8 -0
  176. skyflow/vault/data/_detokenize_request.py +9 -0
  177. skyflow/vault/data/_detokenize_response.py +9 -0
  178. skyflow/vault/data/_detokenize_response_record.py +16 -0
  179. skyflow/vault/data/_detokenize_response_record_metadata.py +10 -0
  180. skyflow/vault/data/_get_options.py +8 -0
  181. skyflow/vault/data/_get_request.py +17 -0
  182. skyflow/vault/data/_get_request_record.py +13 -0
  183. skyflow/vault/data/_get_response.py +9 -0
  184. skyflow/vault/data/_get_response_record.py +17 -0
  185. skyflow/vault/data/_insert_options.py +8 -0
  186. skyflow/vault/data/_insert_request.py +11 -0
  187. skyflow/vault/data/_insert_request_record.py +9 -0
  188. skyflow/vault/data/_insert_response.py +9 -0
  189. skyflow/vault/data/_insert_response_record.py +17 -0
  190. skyflow/vault/data/_request_context.py +16 -0
  191. skyflow/vault/data/_token.py +8 -0
  192. skyflow/vault/data/_token_group_redactions.py +4 -0
  193. skyflow/vault/data/_update_options.py +8 -0
  194. skyflow/vault/data/_update_request.py +11 -0
  195. skyflow/vault/data/_update_request_record.py +6 -0
  196. skyflow/vault/data/_update_response.py +9 -0
  197. skyflow/vault/data/_update_response_record.py +17 -0
  198. skyflow/vault/data/_upsert_options.py +7 -0
  199. skyflow_flowvault_python-1.0.0.dist-info/METADATA +896 -0
  200. skyflow_flowvault_python-1.0.0.dist-info/RECORD +202 -0
  201. skyflow_flowvault_python-1.0.0.dist-info/WHEEL +5 -0
  202. skyflow_flowvault_python-1.0.0.dist-info/top_level.txt +1 -0
@@ -0,0 +1,486 @@
1
+ # This file was auto-generated by Fern from our API Definition.
2
+
3
+ # nopycln: file
4
+ import datetime as dt
5
+ import inspect
6
+ import json
7
+ import logging
8
+ import weakref
9
+ from collections import defaultdict
10
+ from dataclasses import asdict
11
+ from typing import (
12
+ TYPE_CHECKING,
13
+ Any,
14
+ Callable,
15
+ ClassVar,
16
+ Dict,
17
+ List,
18
+ Mapping,
19
+ Optional,
20
+ Set,
21
+ Tuple,
22
+ Type,
23
+ TypeVar,
24
+ Union,
25
+ cast,
26
+ )
27
+
28
+ import pydantic
29
+ import typing_extensions
30
+ from pydantic.fields import FieldInfo as _FieldInfo
31
+
32
+ _logger = logging.getLogger(__name__)
33
+
34
+ if TYPE_CHECKING:
35
+ from .http_sse._models import ServerSentEvent
36
+
37
+ IS_PYDANTIC_V2 = pydantic.VERSION.startswith("2.")
38
+
39
+ if IS_PYDANTIC_V2:
40
+ _datetime_adapter = pydantic.TypeAdapter(dt.datetime) # type: ignore[attr-defined]
41
+ _date_adapter = pydantic.TypeAdapter(dt.date) # type: ignore[attr-defined]
42
+
43
+ def parse_datetime(value: Any) -> dt.datetime: # type: ignore[misc]
44
+ if isinstance(value, dt.datetime):
45
+ return value
46
+ return _datetime_adapter.validate_python(value)
47
+
48
+ def parse_date(value: Any) -> dt.date: # type: ignore[misc]
49
+ if isinstance(value, dt.datetime):
50
+ return value.date()
51
+ if isinstance(value, dt.date):
52
+ return value
53
+ return _date_adapter.validate_python(value)
54
+
55
+ # Avoid importing from pydantic.v1 to maintain Python 3.14 compatibility.
56
+ from typing import get_args as get_args # type: ignore[assignment]
57
+ from typing import get_origin as get_origin # type: ignore[assignment]
58
+
59
+ def is_literal_type(tp: Optional[Type[Any]]) -> bool: # type: ignore[misc]
60
+ return typing_extensions.get_origin(tp) is typing_extensions.Literal
61
+
62
+ def is_union(tp: Optional[Type[Any]]) -> bool: # type: ignore[misc]
63
+ return tp is Union or typing_extensions.get_origin(tp) is Union # type: ignore[comparison-overlap]
64
+
65
+ # Inline encoders_by_type to avoid importing from pydantic.v1.json
66
+ import re as _re
67
+ from collections import deque as _deque
68
+ from decimal import Decimal as _Decimal
69
+ from enum import Enum as _Enum
70
+ from ipaddress import (
71
+ IPv4Address as _IPv4Address,
72
+ )
73
+ from ipaddress import (
74
+ IPv4Interface as _IPv4Interface,
75
+ )
76
+ from ipaddress import (
77
+ IPv4Network as _IPv4Network,
78
+ )
79
+ from ipaddress import (
80
+ IPv6Address as _IPv6Address,
81
+ )
82
+ from ipaddress import (
83
+ IPv6Interface as _IPv6Interface,
84
+ )
85
+ from ipaddress import (
86
+ IPv6Network as _IPv6Network,
87
+ )
88
+ from pathlib import Path as _Path
89
+ from types import GeneratorType as _GeneratorType
90
+ from uuid import UUID as _UUID
91
+
92
+ from pydantic.fields import FieldInfo as ModelField # type: ignore[no-redef, assignment]
93
+
94
+ def _decimal_encoder(dec_value: Any) -> Any:
95
+ if dec_value.as_tuple().exponent >= 0:
96
+ return int(dec_value)
97
+ return float(dec_value)
98
+
99
+ encoders_by_type: Dict[Type[Any], Callable[[Any], Any]] = { # type: ignore[no-redef]
100
+ bytes: lambda o: o.decode(),
101
+ dt.date: lambda o: o.isoformat(),
102
+ dt.datetime: lambda o: o.isoformat(),
103
+ dt.time: lambda o: o.isoformat(),
104
+ dt.timedelta: lambda td: td.total_seconds(),
105
+ _Decimal: _decimal_encoder,
106
+ _Enum: lambda o: o.value,
107
+ frozenset: list,
108
+ _deque: list,
109
+ _GeneratorType: list,
110
+ _IPv4Address: str,
111
+ _IPv4Interface: str,
112
+ _IPv4Network: str,
113
+ _IPv6Address: str,
114
+ _IPv6Interface: str,
115
+ _IPv6Network: str,
116
+ _Path: str,
117
+ _re.Pattern: lambda o: o.pattern,
118
+ set: list,
119
+ _UUID: str,
120
+ }
121
+ else:
122
+ from pydantic.datetime_parse import parse_date as parse_date # type: ignore[no-redef]
123
+ from pydantic.datetime_parse import parse_datetime as parse_datetime # type: ignore[no-redef]
124
+ from pydantic.fields import ModelField as ModelField # type: ignore[attr-defined, no-redef, assignment]
125
+ from pydantic.json import ENCODERS_BY_TYPE as encoders_by_type # type: ignore[no-redef]
126
+ from pydantic.typing import get_args as get_args # type: ignore[no-redef]
127
+ from pydantic.typing import get_origin as get_origin # type: ignore[no-redef]
128
+ from pydantic.typing import is_literal_type as is_literal_type # type: ignore[no-redef, assignment]
129
+ from pydantic.typing import is_union as is_union # type: ignore[no-redef]
130
+
131
+ from .datetime_utils import serialize_datetime
132
+ from .serialization import convert_and_respect_annotation_metadata
133
+ from typing_extensions import TypeAlias
134
+
135
+ T = TypeVar("T")
136
+ Model = TypeVar("Model", bound=pydantic.BaseModel)
137
+
138
+
139
+ def parse_sse_obj(sse: "ServerSentEvent", type_: Type[T]) -> T:
140
+ """
141
+ Parse a ServerSentEvent into the appropriate type.
142
+
143
+ This function handles data-level discrimination where the discriminator
144
+ (e.g., 'type') is inside the 'data' payload. It parses the SSE data field
145
+ as JSON and deserializes it into the target type.
146
+
147
+ Note: Protocol-level discrimination (where the discriminator comes from
148
+ the SSE event: field) is handled at code-generation time and does not
149
+ use this function.
150
+
151
+ Args:
152
+ sse: The ServerSentEvent object to parse
153
+ type_: The target type to deserialize into
154
+
155
+ Returns:
156
+ The parsed object of type T
157
+
158
+ Note:
159
+ This function is only available in SDK contexts where http_sse module exists.
160
+ """
161
+ sse_event = asdict(sse)
162
+ data_value = sse_event.get("data")
163
+ if isinstance(data_value, str) and data_value:
164
+ try:
165
+ parsed_data = json.loads(data_value)
166
+ return parse_obj_as(type_, parsed_data)
167
+ except json.JSONDecodeError as e:
168
+ _logger.warning(
169
+ "Failed to parse SSE data field as JSON: %s, data: %s",
170
+ e,
171
+ data_value[:100] if len(data_value) > 100 else data_value,
172
+ )
173
+ return parse_obj_as(type_, sse_event)
174
+
175
+
176
+ _type_adapter_cache: Dict[int, Any] = {}
177
+
178
+
179
+ def _get_type_adapter(type_: Type[Any]) -> Any:
180
+ key = id(type_)
181
+ adapter = _type_adapter_cache.get(key)
182
+ if adapter is None:
183
+ adapter = pydantic.TypeAdapter(type_) # type: ignore[attr-defined]
184
+ _type_adapter_cache[key] = adapter
185
+ return adapter
186
+
187
+
188
+ _field_alias_cache: "weakref.WeakKeyDictionary[type, Tuple[Dict[str, str], Tuple[str, ...]]]" = (
189
+ weakref.WeakKeyDictionary()
190
+ )
191
+
192
+
193
+ def _get_field_aliases(model: type) -> Tuple[Dict[str, str], Tuple[str, ...]]:
194
+ """
195
+ Map of field name to Pydantic alias for the fields whose alias differs from their name, together with the
196
+ keys that are ambiguous (an alias of one field and the name of another). Computed once per model class.
197
+ """
198
+ cached = _field_alias_cache.get(model)
199
+ if cached is None:
200
+ fields: Mapping[str, Any] = (
201
+ getattr(model, "model_fields", {}) if IS_PYDANTIC_V2 else getattr(model, "__fields__", {})
202
+ )
203
+ name_to_alias: Dict[str, str] = {}
204
+ for name, field in fields.items():
205
+ alias = getattr(field, "alias", None)
206
+ if alias is not None and alias != name:
207
+ name_to_alias[name] = alias
208
+ cached = (name_to_alias, tuple(alias for alias in name_to_alias.values() if alias in fields))
209
+ _field_alias_cache[model] = cached
210
+ return cached
211
+
212
+
213
+ def _coerce_keys_to_aliases(model: type, data: Any) -> Any:
214
+ """
215
+ Accept Python field names in input by rewriting them to their Pydantic aliases,
216
+ while avoiding silent collisions when a key could refer to multiple fields.
217
+ """
218
+ if not isinstance(data, Mapping):
219
+ return data
220
+
221
+ name_to_alias, ambiguous_keys = _get_field_aliases(model)
222
+ for key in ambiguous_keys:
223
+ if key in data and name_to_alias.get(key, key) not in data:
224
+ raise ValueError(
225
+ f"Ambiguous input key '{key}': it is both a field name and an alias. "
226
+ "Provide the explicit alias key to disambiguate."
227
+ )
228
+
229
+ if not name_to_alias or not any(name in data for name in name_to_alias):
230
+ return data if isinstance(data, dict) else dict(data)
231
+
232
+ rewritten: Dict[str, Any] = dict(data)
233
+ for name, alias in name_to_alias.items():
234
+ if name in data and alias not in rewritten:
235
+ rewritten[alias] = rewritten.pop(name)
236
+
237
+ return rewritten
238
+
239
+
240
+ def parse_obj_as(type_: Type[T], object_: Any) -> T:
241
+ # convert_and_respect_annotation_metadata is required for TypedDict aliasing.
242
+ #
243
+ # For Pydantic models, whether we should pre-dealias depends on how the model encodes aliasing:
244
+ # - If the model uses real Pydantic aliases (pydantic.Field(alias=...)), then we must pass wire keys through
245
+ # unchanged so Pydantic can validate them.
246
+ # - If the model encodes aliasing only via FieldMetadata annotations, then we MUST pre-dealias because Pydantic
247
+ # will not recognize those aliases during validation.
248
+ if inspect.isclass(type_) and issubclass(type_, pydantic.BaseModel):
249
+ has_pydantic_aliases = bool(_get_field_aliases(type_)[0])
250
+
251
+ dealiased_object = (
252
+ object_
253
+ if has_pydantic_aliases
254
+ else convert_and_respect_annotation_metadata(object_=object_, annotation=type_, direction="read")
255
+ )
256
+ else:
257
+ dealiased_object = convert_and_respect_annotation_metadata(object_=object_, annotation=type_, direction="read")
258
+ if IS_PYDANTIC_V2:
259
+ adapter = _get_type_adapter(type_)
260
+ return adapter.validate_python(dealiased_object) # type: ignore[no-any-return]
261
+ return pydantic.parse_obj_as(type_, dealiased_object)
262
+
263
+
264
+ def to_jsonable_with_fallback(obj: Any, fallback_serializer: Callable[[Any], Any]) -> Any:
265
+ if IS_PYDANTIC_V2:
266
+ from pydantic_core import to_jsonable_python
267
+
268
+ return to_jsonable_python(obj, fallback=fallback_serializer)
269
+ return fallback_serializer(obj)
270
+
271
+
272
+ class UniversalBaseModel(pydantic.BaseModel):
273
+ if IS_PYDANTIC_V2:
274
+ model_config: ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict( # type: ignore[typeddict-unknown-key]
275
+ # Allow fields beginning with `model_` to be used in the model
276
+ protected_namespaces=(),
277
+ )
278
+
279
+ @pydantic.model_validator(mode="before") # type: ignore[attr-defined]
280
+ @classmethod
281
+ def _coerce_field_names_to_aliases(cls, data: Any) -> Any:
282
+ return _coerce_keys_to_aliases(cls, data)
283
+
284
+ @pydantic.model_serializer(mode="plain", when_used="json") # type: ignore[attr-defined]
285
+ def serialize_model(self) -> Any: # type: ignore[name-defined]
286
+ serialized = self.dict() # type: ignore[attr-defined]
287
+ data = {k: serialize_datetime(v) if isinstance(v, dt.datetime) else v for k, v in serialized.items()}
288
+ return data
289
+
290
+ else:
291
+
292
+ class Config:
293
+ smart_union = True
294
+ json_encoders = {dt.datetime: serialize_datetime}
295
+
296
+ @pydantic.root_validator(pre=True)
297
+ def _coerce_field_names_to_aliases(cls, values: Any) -> Any:
298
+ return _coerce_keys_to_aliases(cls, values) # type: ignore[arg-type]
299
+
300
+ @classmethod
301
+ def model_construct(cls: Type["Model"], _fields_set: Optional[Set[str]] = None, **values: Any) -> "Model":
302
+ dealiased_object = convert_and_respect_annotation_metadata(object_=values, annotation=cls, direction="read")
303
+ return cls.construct(_fields_set, **dealiased_object)
304
+
305
+ @classmethod
306
+ def construct(cls: Type["Model"], _fields_set: Optional[Set[str]] = None, **values: Any) -> "Model":
307
+ dealiased_object = convert_and_respect_annotation_metadata(object_=values, annotation=cls, direction="read")
308
+ if IS_PYDANTIC_V2:
309
+ return super().model_construct(_fields_set, **dealiased_object) # type: ignore[misc]
310
+ return super().construct(_fields_set, **dealiased_object)
311
+
312
+ def json(self, **kwargs: Any) -> str:
313
+ kwargs_with_defaults = {
314
+ "by_alias": True,
315
+ "exclude_unset": True,
316
+ **kwargs,
317
+ }
318
+ if IS_PYDANTIC_V2:
319
+ return super().model_dump_json(**kwargs_with_defaults) # type: ignore[misc]
320
+ return super().json(**kwargs_with_defaults)
321
+
322
+ def dict(self, **kwargs: Any) -> Dict[str, Any]:
323
+ """
324
+ Override the default dict method to `exclude_unset` by default. This function patches
325
+ `exclude_unset` to work include fields within non-None default values.
326
+ """
327
+ # Note: the logic here is multiplexed given the levers exposed in Pydantic V1 vs V2
328
+ # Pydantic V1's .dict can be extremely slow, so we do not want to call it twice.
329
+ #
330
+ # We'd ideally do the same for Pydantic V2, but it shells out to a library to serialize models
331
+ # that we have less control over, and this is less intrusive than custom serializers for now.
332
+ if IS_PYDANTIC_V2:
333
+ kwargs_with_defaults_exclude_unset = {
334
+ **kwargs,
335
+ "by_alias": True,
336
+ "exclude_unset": True,
337
+ "exclude_none": False,
338
+ }
339
+ kwargs_with_defaults_exclude_none = {
340
+ **kwargs,
341
+ "by_alias": True,
342
+ "exclude_none": True,
343
+ "exclude_unset": False,
344
+ }
345
+ dict_dump = deep_union_pydantic_dicts(
346
+ super().model_dump(**kwargs_with_defaults_exclude_unset), # type: ignore[misc]
347
+ super().model_dump(**kwargs_with_defaults_exclude_none), # type: ignore[misc]
348
+ )
349
+
350
+ else:
351
+ _fields_set = self.__fields_set__.copy()
352
+
353
+ fields = _get_model_fields(self.__class__)
354
+ for name, field in fields.items():
355
+ if name not in _fields_set:
356
+ default = _get_field_default(field)
357
+
358
+ # If the default values are non-null act like they've been set
359
+ # This effectively allows exclude_unset to work like exclude_none where
360
+ # the latter passes through intentionally set none values.
361
+ if default is not None or ("exclude_unset" in kwargs and not kwargs["exclude_unset"]):
362
+ _fields_set.add(name)
363
+
364
+ if default is not None:
365
+ self.__fields_set__.add(name)
366
+
367
+ kwargs_with_defaults_exclude_unset_include_fields = {
368
+ "by_alias": True,
369
+ "exclude_unset": True,
370
+ "include": _fields_set,
371
+ **kwargs,
372
+ }
373
+
374
+ dict_dump = super().dict(**kwargs_with_defaults_exclude_unset_include_fields)
375
+
376
+ return cast(
377
+ Dict[str, Any],
378
+ convert_and_respect_annotation_metadata(object_=dict_dump, annotation=self.__class__, direction="write"),
379
+ )
380
+
381
+
382
+ def _union_list_of_pydantic_dicts(source: List[Any], destination: List[Any]) -> List[Any]:
383
+ converted_list: List[Any] = []
384
+ for i, item in enumerate(source):
385
+ destination_value = destination[i]
386
+ if isinstance(item, dict):
387
+ converted_list.append(deep_union_pydantic_dicts(item, destination_value))
388
+ elif isinstance(item, list):
389
+ converted_list.append(_union_list_of_pydantic_dicts(item, destination_value))
390
+ else:
391
+ converted_list.append(item)
392
+ return converted_list
393
+
394
+
395
+ def deep_union_pydantic_dicts(source: Dict[str, Any], destination: Dict[str, Any]) -> Dict[str, Any]:
396
+ for key, value in source.items():
397
+ node = destination.setdefault(key, {})
398
+ if isinstance(value, dict):
399
+ deep_union_pydantic_dicts(value, node)
400
+ # Note: we do not do this same processing for sets given we do not have sets of models
401
+ # and given the sets are unordered, the processing of the set and matching objects would
402
+ # be non-trivial.
403
+ elif isinstance(value, list):
404
+ destination[key] = _union_list_of_pydantic_dicts(value, node)
405
+ else:
406
+ destination[key] = value
407
+
408
+ return destination
409
+
410
+
411
+ if IS_PYDANTIC_V2:
412
+
413
+ class V2RootModel(UniversalBaseModel, pydantic.RootModel): # type: ignore[misc, name-defined, type-arg]
414
+ pass
415
+
416
+ UniversalRootModel: TypeAlias = V2RootModel # type: ignore[misc]
417
+ else:
418
+ UniversalRootModel: TypeAlias = UniversalBaseModel # type: ignore[misc, no-redef]
419
+
420
+
421
+ def encode_by_type(o: Any) -> Any:
422
+ encoders_by_class_tuples: Dict[Callable[[Any], Any], Tuple[Any, ...]] = defaultdict(tuple)
423
+ for type_, encoder in encoders_by_type.items():
424
+ encoders_by_class_tuples[encoder] += (type_,)
425
+
426
+ if type(o) in encoders_by_type:
427
+ return encoders_by_type[type(o)](o)
428
+ for encoder, classes_tuple in encoders_by_class_tuples.items():
429
+ if isinstance(o, classes_tuple):
430
+ return encoder(o)
431
+
432
+
433
+ def update_forward_refs(model: Type["Model"], **localns: Any) -> None:
434
+ if IS_PYDANTIC_V2:
435
+ model.model_rebuild(raise_errors=False) # type: ignore[attr-defined]
436
+ else:
437
+ model.update_forward_refs(**localns)
438
+
439
+
440
+ # Mirrors Pydantic's internal typing
441
+ AnyCallable = Callable[..., Any]
442
+
443
+
444
+ def universal_root_validator(
445
+ pre: bool = False,
446
+ ) -> Callable[[AnyCallable], AnyCallable]:
447
+ def decorator(func: AnyCallable) -> AnyCallable:
448
+ if IS_PYDANTIC_V2:
449
+ # In Pydantic v2, for RootModel we always use "before" mode
450
+ # The custom validators transform the input value before the model is created
451
+ return cast(AnyCallable, pydantic.model_validator(mode="before")(func)) # type: ignore[attr-defined]
452
+ return cast(AnyCallable, pydantic.root_validator(pre=pre)(func)) # type: ignore[call-overload]
453
+
454
+ return decorator
455
+
456
+
457
+ def universal_field_validator(field_name: str, pre: bool = False) -> Callable[[AnyCallable], AnyCallable]:
458
+ def decorator(func: AnyCallable) -> AnyCallable:
459
+ if IS_PYDANTIC_V2:
460
+ return cast(AnyCallable, pydantic.field_validator(field_name, mode="before" if pre else "after")(func)) # type: ignore[attr-defined]
461
+ return cast(AnyCallable, pydantic.validator(field_name, pre=pre)(func))
462
+
463
+ return decorator
464
+
465
+
466
+ PydanticField = Union[ModelField, _FieldInfo]
467
+
468
+
469
+ def _get_model_fields(model: Type["Model"]) -> Mapping[str, PydanticField]:
470
+ if IS_PYDANTIC_V2:
471
+ return cast(Mapping[str, PydanticField], model.model_fields) # type: ignore[attr-defined]
472
+ return cast(Mapping[str, PydanticField], model.__fields__)
473
+
474
+
475
+ def _get_field_default(field: PydanticField) -> Any:
476
+ try:
477
+ value = field.get_default() # type: ignore[union-attr]
478
+ except:
479
+ value = field.default
480
+ if IS_PYDANTIC_V2:
481
+ from pydantic_core import PydanticUndefined
482
+
483
+ if value == PydanticUndefined:
484
+ return None
485
+ return value
486
+ return value
@@ -0,0 +1,58 @@
1
+ # This file was auto-generated by Fern from our API Definition.
2
+
3
+ from typing import Any, Dict, List, Optional, Tuple
4
+
5
+ import pydantic
6
+
7
+
8
+ # Flattens dicts to be of the form {"key[subkey][subkey2]": value} where value is not a dict
9
+ def traverse_query_dict(dict_flat: Dict[str, Any], key_prefix: Optional[str] = None) -> List[Tuple[str, Any]]:
10
+ result = []
11
+ for k, v in dict_flat.items():
12
+ key = f"{key_prefix}[{k}]" if key_prefix is not None else k
13
+ if isinstance(v, dict):
14
+ result.extend(traverse_query_dict(v, key))
15
+ elif isinstance(v, list):
16
+ for arr_v in v:
17
+ if isinstance(arr_v, dict):
18
+ result.extend(traverse_query_dict(arr_v, key))
19
+ else:
20
+ result.append((key, arr_v))
21
+ else:
22
+ result.append((key, v))
23
+ return result
24
+
25
+
26
+ def single_query_encoder(query_key: str, query_value: Any) -> List[Tuple[str, Any]]:
27
+ if isinstance(query_value, pydantic.BaseModel) or isinstance(query_value, dict):
28
+ if isinstance(query_value, pydantic.BaseModel):
29
+ obj_dict = query_value.dict(by_alias=True)
30
+ else:
31
+ obj_dict = query_value
32
+ return traverse_query_dict(obj_dict, query_key)
33
+ elif isinstance(query_value, list):
34
+ encoded_values: List[Tuple[str, Any]] = []
35
+ for value in query_value:
36
+ if isinstance(value, pydantic.BaseModel) or isinstance(value, dict):
37
+ if isinstance(value, pydantic.BaseModel):
38
+ obj_dict = value.dict(by_alias=True)
39
+ elif isinstance(value, dict):
40
+ obj_dict = value
41
+
42
+ encoded_values.extend(single_query_encoder(query_key, obj_dict))
43
+ else:
44
+ encoded_values.append((query_key, value))
45
+
46
+ return encoded_values
47
+
48
+ return [(query_key, query_value)]
49
+
50
+
51
+ def encode_query(query: Optional[Dict[str, Any]]) -> Optional[List[Tuple[str, Any]]]:
52
+ if query is None:
53
+ return None
54
+
55
+ encoded_query = []
56
+ for k, v in query.items():
57
+ encoded_query.extend(single_query_encoder(k, v))
58
+ return encoded_query
@@ -0,0 +1,11 @@
1
+ # This file was auto-generated by Fern from our API Definition.
2
+
3
+ from typing import Any, Dict, Mapping, Optional
4
+
5
+
6
+ def remove_none_from_dict(original: Mapping[str, Optional[Any]]) -> Dict[str, Any]:
7
+ new: Dict[str, Any] = {}
8
+ for key, value in original.items():
9
+ if value is not None:
10
+ new[key] = value
11
+ return new
@@ -0,0 +1,40 @@
1
+ # This file was auto-generated by Fern from our API Definition.
2
+
3
+ import typing
4
+
5
+ try:
6
+ from typing import NotRequired # type: ignore
7
+ except ImportError:
8
+ from typing_extensions import NotRequired
9
+
10
+
11
+ class RequestOptions(typing.TypedDict, total=False):
12
+ """
13
+ Additional options for request-specific configuration when calling APIs via the SDK.
14
+ This is used primarily as an optional final parameter for service functions.
15
+
16
+ Attributes:
17
+ - timeout: float. The number of seconds to await an API call before timing out.
18
+
19
+ - timeout_in_seconds: int. Deprecated alias for `timeout`; both are in seconds. Prefer `timeout`.
20
+
21
+ - max_retries: int. The max number of retries to attempt if the API call fails.
22
+
23
+ - additional_headers: typing.Dict[str, typing.Any]. A dictionary containing additional parameters to spread into the request's header dict
24
+
25
+ - additional_query_parameters: typing.Dict[str, typing.Any]. A dictionary containing additional parameters to spread into the request's query parameters dict
26
+
27
+ - additional_body_parameters: typing.Dict[str, typing.Any]. A dictionary containing additional parameters to spread into the request's body parameters dict
28
+
29
+ - chunk_size: int. The size, in bytes, to process each chunk of data being streamed back within the response. This equates to leveraging `chunk_size` within `requests` or `httpx`, and is only leveraged for file downloads.
30
+ """
31
+
32
+ timeout: NotRequired[float]
33
+ timeout_in_seconds: NotRequired[int]
34
+ max_retries: NotRequired[int]
35
+ additional_headers: NotRequired[typing.Dict[str, typing.Any]]
36
+ additional_query_parameters: NotRequired[typing.Dict[str, typing.Any]]
37
+ additional_body_parameters: NotRequired[typing.Dict[str, typing.Any]]
38
+ chunk_size: NotRequired[int]
39
+ stream_reconnection_enabled: NotRequired[bool]
40
+ max_stream_reconnection_attempts: NotRequired[int]