aboutsummaryrefslogtreecommitdiff
path: root/.venv/lib/python3.12/site-packages/pydantic/deprecated/tools.py
diff options
context:
space:
mode:
Diffstat (limited to '.venv/lib/python3.12/site-packages/pydantic/deprecated/tools.py')
-rw-r--r--.venv/lib/python3.12/site-packages/pydantic/deprecated/tools.py103
1 files changed, 103 insertions, 0 deletions
diff --git a/.venv/lib/python3.12/site-packages/pydantic/deprecated/tools.py b/.venv/lib/python3.12/site-packages/pydantic/deprecated/tools.py
new file mode 100644
index 00000000..b04eae40
--- /dev/null
+++ b/.venv/lib/python3.12/site-packages/pydantic/deprecated/tools.py
@@ -0,0 +1,103 @@
+from __future__ import annotations
+
+import json
+import warnings
+from typing import TYPE_CHECKING, Any, Callable, Type, TypeVar, Union
+
+from typing_extensions import deprecated
+
+from ..json_schema import DEFAULT_REF_TEMPLATE, GenerateJsonSchema
+from ..type_adapter import TypeAdapter
+from ..warnings import PydanticDeprecatedSince20
+
+if not TYPE_CHECKING:
+ # See PyCharm issues https://youtrack.jetbrains.com/issue/PY-21915
+ # and https://youtrack.jetbrains.com/issue/PY-51428
+ DeprecationWarning = PydanticDeprecatedSince20
+
+__all__ = 'parse_obj_as', 'schema_of', 'schema_json_of'
+
+NameFactory = Union[str, Callable[[Type[Any]], str]]
+
+
+T = TypeVar('T')
+
+
+@deprecated(
+ '`parse_obj_as` is deprecated. Use `pydantic.TypeAdapter.validate_python` instead.',
+ category=None,
+)
+def parse_obj_as(type_: type[T], obj: Any, type_name: NameFactory | None = None) -> T:
+ warnings.warn(
+ '`parse_obj_as` is deprecated. Use `pydantic.TypeAdapter.validate_python` instead.',
+ category=PydanticDeprecatedSince20,
+ stacklevel=2,
+ )
+ if type_name is not None: # pragma: no cover
+ warnings.warn(
+ 'The type_name parameter is deprecated. parse_obj_as no longer creates temporary models',
+ DeprecationWarning,
+ stacklevel=2,
+ )
+ return TypeAdapter(type_).validate_python(obj)
+
+
+@deprecated(
+ '`schema_of` is deprecated. Use `pydantic.TypeAdapter.json_schema` instead.',
+ category=None,
+)
+def schema_of(
+ type_: Any,
+ *,
+ title: NameFactory | None = None,
+ by_alias: bool = True,
+ ref_template: str = DEFAULT_REF_TEMPLATE,
+ schema_generator: type[GenerateJsonSchema] = GenerateJsonSchema,
+) -> dict[str, Any]:
+ """Generate a JSON schema (as dict) for the passed model or dynamically generated one."""
+ warnings.warn(
+ '`schema_of` is deprecated. Use `pydantic.TypeAdapter.json_schema` instead.',
+ category=PydanticDeprecatedSince20,
+ stacklevel=2,
+ )
+ res = TypeAdapter(type_).json_schema(
+ by_alias=by_alias,
+ schema_generator=schema_generator,
+ ref_template=ref_template,
+ )
+ if title is not None:
+ if isinstance(title, str):
+ res['title'] = title
+ else:
+ warnings.warn(
+ 'Passing a callable for the `title` parameter is deprecated and no longer supported',
+ DeprecationWarning,
+ stacklevel=2,
+ )
+ res['title'] = title(type_)
+ return res
+
+
+@deprecated(
+ '`schema_json_of` is deprecated. Use `pydantic.TypeAdapter.json_schema` instead.',
+ category=None,
+)
+def schema_json_of(
+ type_: Any,
+ *,
+ title: NameFactory | None = None,
+ by_alias: bool = True,
+ ref_template: str = DEFAULT_REF_TEMPLATE,
+ schema_generator: type[GenerateJsonSchema] = GenerateJsonSchema,
+ **dumps_kwargs: Any,
+) -> str:
+ """Generate a JSON schema (as JSON) for the passed model or dynamically generated one."""
+ warnings.warn(
+ '`schema_json_of` is deprecated. Use `pydantic.TypeAdapter.json_schema` instead.',
+ category=PydanticDeprecatedSince20,
+ stacklevel=2,
+ )
+ return json.dumps(
+ schema_of(type_, title=title, by_alias=by_alias, ref_template=ref_template, schema_generator=schema_generator),
+ **dumps_kwargs,
+ )