Serialize unsubstituted type vars as Any #7606
Conversation
Deploying with
|
| Latest commit: |
8aa4039
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://24a51c27.pydantic-docs2.pages.dev |
| Branch Preview URL: | https://serialize-unsubstituted-type.pydantic-docs2.pages.dev |
tests/test_generics.py
Outdated
| def test_serialize_unsubstituted_typevars_default() -> None: | ||
| from typing_extensions import TypeVar | ||
|
|
||
| class ErrorDetails(BaseModel): | ||
| foo: str | ||
|
|
||
| DataT = TypeVar('DataT', default=ErrorDetails) |
docs/concepts/models.md
Outdated
| } | ||
| ``` | ||
|
|
||
| If you use a `default=...` for a `TypeVar` (available in Python >= 3.13 or via `typing-extensions`) the default value will be used for both validation and serialization if the type variable is not parametrized. You can override this behavior using `pydantic.SerializeAsAny`: |
There was a problem hiding this comment.
@dmontagu I think this is perhaps the controversial part of this PR. My reasoning was that a bound and default are different semantically and this distinction led me to implement other behavior. This is also an opportunity to preserve the SerializeAsAny example that was here before. Let me know what you think.
There was a problem hiding this comment.
I agree with your interpretation of the semantics. (And in particular, this choice.)
pydantic/types.py
Outdated
| from pydantic import BaseModel, UUID3 | ||
| from pydantic import UUID3, BaseModel |
There was a problem hiding this comment.
I reverted this change but looks like something in our docstring formatting stuff is sorting in reverse
| schema = self.generate_schema(typevar.__bound__) | ||
| elif typevar.__constraints__: | ||
| return self._union_schema(typing.Union[typevar.__constraints__]) # type: ignore | ||
| schema = self._union_schema(typing.Union[typevar.__constraints__]) # type: ignore |
There was a problem hiding this comment.
Constraints feel closer to default than to a bound to me, I would personally make them function the old way. I’ll leave it up to you though.
Fixes #7562