Add Deprecated

pydantic · Nov 28, 2023 · dbb3d2e · dbb3d2e
1 parent a64f7e0
commit dbb3d2e
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/pydantic/types.py b/pydantic/types.py
@@ -2822,3 +2822,17 @@ def __get_pydantic_core_schema__(cls, source_type: Any, handler: GetCoreSchemaHa
 That is, instead of a [`ValidationError`][pydantic_core.ValidationError] being propagated up and the entire iterable being discarded
 any invalid items are discarded and the valid ones are returned.
 """
+
+
+# Can't use `Field(deprecated=True)` because of a circular import
+Deprecated = Annotated[T, deprecated("")]
+"""
+Mark a field as being deprecated.
+
+```py
+from pydantic import Deprecated, TypeAdapter
+
+
+print(TypeAdapter(Deprecated[int]).json_schema())
+#> {'type': 'integer', 'deprecated': True}
+"""