-
Notifications
You must be signed in to change notification settings - Fork 233
/
_pydantic_core.pyi
337 lines (309 loc) · 9.93 KB
/
_pydantic_core.pyi
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
from __future__ import annotations
import datetime
import decimal
import sys
from typing import Any, Callable, Generic, Optional, Type, TypeVar
from pydantic_core import ErrorDetails, ErrorTypeInfo, InitErrorDetails, MultiHostHost
from pydantic_core.core_schema import CoreConfig, CoreSchema, ErrorType
if sys.version_info < (3, 8):
from typing_extensions import final
else:
from typing import final
if sys.version_info < (3, 11):
from typing_extensions import Literal, LiteralString, Self, TypeAlias
else:
from typing import Literal, LiteralString, Self, TypeAlias
from _typeshed import SupportsAllComparisons
__all__ = [
'__version__',
'build_profile',
'build_info',
'_recursion_limit',
'ArgsKwargs',
'SchemaValidator',
'SchemaSerializer',
'Url',
'MultiHostUrl',
'SchemaError',
'ValidationError',
'PydanticCustomError',
'PydanticKnownError',
'PydanticOmit',
'PydanticUseDefault',
'PydanticSerializationError',
'PydanticSerializationUnexpectedValue',
'PydanticUndefined',
'PydanticUndefinedType',
'Some',
'to_json',
'to_jsonable_python',
'list_all_errors',
'TzInfo',
]
__version__: str
build_profile: str
build_info: str
_recursion_limit: int
_T = TypeVar('_T', default=Any, covariant=True)
@final
class Some(Generic[_T]):
__match_args__ = ('value',)
@property
def value(self) -> _T: ...
@classmethod
def __class_getitem__(cls, __item: Any) -> Type[Self]: ...
@final
class SchemaValidator:
def __new__(cls, schema: CoreSchema, config: CoreConfig | None = None) -> Self: ...
@property
def title(self) -> str: ...
def validate_python(
self,
input: Any,
*,
strict: bool | None = None,
from_attributes: bool | None = None,
context: 'dict[str, Any] | None' = None,
self_instance: Any | None = None,
) -> Any: ...
def isinstance_python(
self,
input: Any,
*,
strict: bool | None = None,
from_attributes: bool | None = None,
context: 'dict[str, Any] | None' = None,
self_instance: Any | None = None,
) -> bool: ...
def validate_json(
self,
input: str | bytes | bytearray,
*,
strict: bool | None = None,
context: 'dict[str, Any] | None' = None,
self_instance: Any | None = None,
) -> Any: ...
def validate_assignment(
self,
obj: Any,
field_name: str,
field_value: Any,
*,
strict: bool | None = None,
from_attributes: bool | None = None,
context: 'dict[str, Any] | None' = None,
) -> dict[str, Any] | tuple[dict[str, Any], dict[str, Any] | None, set[str]]:
"""
ModelValidator and ModelFieldsValidator will return a tuple of (fields data, extra data, fields set)
"""
def get_default_value(self, *, strict: bool | None = None, context: Any = None) -> Some | None: ...
_IncEx: TypeAlias = set[int] | set[str] | dict[int, _IncEx] | dict[str, _IncEx] | None
@final
class SchemaSerializer:
def __new__(cls, schema: CoreSchema, config: CoreConfig | None = None) -> Self: ...
def to_python(
self,
value: Any,
*,
mode: str | None = None,
include: _IncEx = None,
exclude: _IncEx = None,
by_alias: bool = True,
exclude_unset: bool = False,
exclude_defaults: bool = False,
exclude_none: bool = False,
round_trip: bool = False,
warnings: bool = True,
fallback: Callable[[Any], Any] | None = None,
) -> Any: ...
def to_json(
self,
value: Any,
*,
indent: int | None = None,
include: _IncEx = None,
exclude: _IncEx = None,
by_alias: bool = True,
exclude_unset: bool = False,
exclude_defaults: bool = False,
exclude_none: bool = False,
round_trip: bool = False,
warnings: bool = True,
fallback: Callable[[Any], Any] | None = None,
) -> bytes: ...
def to_json(
value: Any,
*,
indent: int | None = None,
include: _IncEx = None,
exclude: _IncEx = None,
by_alias: bool = True,
exclude_none: bool = False,
round_trip: bool = False,
timedelta_mode: Literal['iso8601', 'float'] = 'iso8601',
bytes_mode: Literal['utf8', 'base64'] = 'utf8',
serialize_unknown: bool = False,
fallback: Callable[[Any], Any] | None = None,
) -> bytes: ...
def to_jsonable_python(
value: Any,
*,
include: _IncEx = None,
exclude: _IncEx = None,
by_alias: bool = True,
exclude_none: bool = False,
round_trip: bool = False,
timedelta_mode: Literal['iso8601', 'float'] = 'iso8601',
bytes_mode: Literal['utf8', 'base64'] = 'utf8',
serialize_unknown: bool = False,
fallback: Callable[[Any], Any] | None = None,
) -> Any: ...
class Url(SupportsAllComparisons):
def __new__(cls, url: str) -> Self: ...
@property
def scheme(self) -> str: ...
@property
def username(self) -> str | None: ...
@property
def password(self) -> str | None: ...
@property
def host(self) -> str | None: ...
@property
def port(self) -> int | None: ...
@property
def path(self) -> str | None: ...
@property
def query(self) -> str | None: ...
@property
def fragment(self) -> str | None: ...
def unicode_host(self) -> str | None: ...
def query_params(self) -> list[tuple[str, str]]: ...
def unicode_string(self) -> str: ...
def __repr__(self) -> str: ...
def __str__(self) -> str: ...
def __deepcopy__(self, memo: dict) -> str: ...
@classmethod
def build(
cls,
*,
scheme: str,
username: Optional[str] = None,
password: Optional[str] = None,
host: str,
port: Optional[int] = None,
path: Optional[str] = None,
query: Optional[str] = None,
fragment: Optional[str] = None,
) -> Self: ...
class MultiHostUrl(SupportsAllComparisons):
def __new__(cls, url: str) -> Self: ...
@property
def scheme(self) -> str: ...
@property
def path(self) -> str | None: ...
@property
def query(self) -> str | None: ...
@property
def fragment(self) -> str | None: ...
def hosts(self) -> list[MultiHostHost]: ...
def query_params(self) -> list[tuple[str, str]]: ...
def unicode_string(self) -> str: ...
def __repr__(self) -> str: ...
def __str__(self) -> str: ...
def __deepcopy__(self, memo: dict) -> Self: ...
@classmethod
def build(
cls,
*,
scheme: str,
username: Optional[str] = None,
password: Optional[str] = None,
host: Optional[str] = None,
hosts: Optional[list[MultiHostHost]] = None,
port: Optional[int] = None,
path: Optional[str] = None,
query: Optional[str] = None,
fragment: Optional[str] = None,
) -> Self: ...
@final
class SchemaError(Exception):
def error_count(self) -> int: ...
def errors(self) -> list[ErrorDetails]: ...
@final
class ValidationError(ValueError):
@staticmethod
def from_exception_data(
title: str,
line_errors: list[InitErrorDetails],
error_mode: Literal['python', 'json'] = 'python',
hide_input: bool = False,
) -> ValidationError:
"""
Provisory constructor for a Validation Error.
This API will probably change and be deprecated in the the future; we will make it easier and more
powerful to construct and use ValidationErrors, but we cannot do that before our initial Pydantic V2 release.
So if you use this method please be aware that it may change or be removed before Pydantic V3.
"""
@property
def title(self) -> str: ...
def error_count(self) -> int: ...
def errors(self, *, include_url: bool = True, include_context: bool = True) -> list[ErrorDetails]: ...
def json(self, *, indent: int | None = None, include_url: bool = True, include_context: bool = True) -> str: ...
@final
class PydanticCustomError(ValueError):
def __new__(
cls, error_type: LiteralString, message_template: LiteralString, context: dict[str, Any] | None = None
) -> Self: ...
@property
def context(self) -> dict[str, Any] | None: ...
@property
def type(self) -> str: ...
@property
def message_template(self) -> str: ...
def message(self) -> str: ...
@final
class PydanticKnownError(ValueError):
def __new__(
cls, error_type: ErrorType, context: dict[str, str | int | float | decimal.Decimal] | None = None
) -> Self: ...
@property
def context(self) -> dict[str, str | int | float] | None: ...
@property
def type(self) -> ErrorType: ...
@property
def message_template(self) -> str: ...
def message(self) -> str: ...
@final
class PydanticOmit(Exception):
def __new__(cls) -> Self: ...
@final
class PydanticUseDefault(Exception):
def __new__(cls) -> Self: ...
@final
class PydanticSerializationError(ValueError):
def __new__(cls, message: str) -> Self: ...
@final
class PydanticSerializationUnexpectedValue(ValueError):
def __new__(cls, message: str | None = None) -> Self: ...
@final
class ArgsKwargs:
def __new__(cls, args: tuple[Any, ...], kwargs: dict[str, Any] | None = None) -> Self: ...
@property
def args(self) -> tuple[Any, ...]: ...
@property
def kwargs(self) -> dict[str, Any] | None: ...
@final
class PydanticUndefinedType:
def __copy__(self) -> Self: ...
def __deepcopy__(self, memo: Any) -> Self: ...
PydanticUndefined: PydanticUndefinedType
def list_all_errors() -> list[ErrorTypeInfo]:
"""
Get information about all built-in errors.
"""
@final
class TzInfo(datetime.tzinfo):
def tzname(self, _dt: datetime.datetime | None) -> str | None: ...
def utcoffset(self, _dt: datetime.datetime | None) -> datetime.timedelta: ...
def dst(self, _dt: datetime.datetime | None) -> datetime.timedelta: ...
def __deepcopy__(self, _memo: dict[Any, Any]) -> 'TzInfo': ...