8000 The "preserve the type of the input whenever possible" union handling is inconsistent · Issue #7097 · pydantic/pydantic · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

The "preserve the type of the input whenever possible" union handling is inconsistent #7097

New issue
8000

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
1 task done
stevegoss-komodo opened this issue Aug 12, 2023 · 3 comments
Open
1 task done

The "preserve the type of the input whenever possible" union handling is inconsistent #7097

stevegoss-komodo opened this issue Aug 12, 2023 · 3 comments
Assignees
@dmontagu
Labels
bug V2 Bug related to Pydantic V2 pending Is unconfirmed v3 Under consideration for V3

Comments

@stevegoss-komodo
Copy link
stevegoss-komodo commented Aug 12, 2023 •
edited by pydantic-hooky bot
Loading

Initial Checks

  • I confirm that I'm using Pydantic V2

Description

Code that relies on the strict left-to-right behavior of union validation/parsing is broken in V2, with no available workaround. Not only that, but the subtle change creates inconsistencies where identical data in python or JSON form parses differently. In the example code, all of those would have parsed as UUIDs in V1 (behavior that our code relies on), but now, it parses as string in certain scenarios, but not in others.

It is difficult to migrate with this highly inconsistent and frankly baffling behavior. Using unions like the one in the example with FastAPI as path parameters or query parameters used to be a useful way to detect UUIDs, but now, FastAPI always returns a string.

Example Code

from uuid import UUID

from pydantic import TypeAdapter, BaseModel

IdOrSlug = UUID | str

print(type(TypeAdapter(IdOrSlug).validate_json("\"f4fe10b4-e0c8-4232-ba26-4acd491c2414\"")))
# <class 'uuid.UUID'>

print(type(TypeAdapter(IdOrSlug).validate_python("f4fe10b4-e0c8-4232-ba26-4acd491c2414")))
# <class 'str'>

class AModel(BaseModel):
    my_id: IdOrSlug

model = AModel.model_validate_json("""{"my_id":"f4fe10b4-e0c8-4232-ba26-4acd491c2414"}""")
print(type(model.my_id))
# <class 'uuid.UUID'>

model1 = AModel.model_validate({"my_id":"f4fe10b4-e0c8-4232-ba26-4acd491c2414"})
print(type(model1.my_id))
# <class 'str'>

Python, Pydantic & OS Version

pydantic version: 2.1.1
        pydantic-core version: 2.4.0
          pydantic-core build: profile=release pgo=false mimalloc=true
                 install path: /Users/redacted/projects/platform-orchestration/.venv/lib/python3.10/site-packages/pydantic
               python version: 3.10.10 (main, May  8 2023, 10:19:34) [Clang 14.0.3 (clang-1403.0.22.14.1)]
                     platform: macOS-13.4.1-arm64-arm-64bit
     optional deps. installed: ['typing-extensions']

Selected Assignee: @dmontagu
@stevegoss-komodo stevegoss-komodo added bug V2 Bug related to Pydantic V2 unconfirmed labels Aug 12, 2023
@davidhewitt
Copy link
Contributor

Possibly related: my work in pydantic/pydantic-core#867 will improve the smart unions a bit further. I'd propose that a better behaviour here with "smart unions" would be that this validates as a str in both cases , because the input is a str. I think this should be the case once my PR merges.

I would support adding a way to get back to "dumb" left-to-right validation, even if the smart behaviour remains the default. If there isn't a known way already (@samuelcolvin @dmontagu @adriangb ?), I'd be tempted to add smart_union back to Field, but give it a default of True this time.

@samuelcolvin
Copy link
Member

I agree with @davidhewitt, but I would suggest adding dumb_union (default False) since:

  1. Better to have False as the default
  2. The behavior will inevitably be somewhat different to v1, so a new name makes more sense.

@samuelcolvin samuelcolvin mentioned this issue Aug 14, 2023
Closed
1 task
This was referenced Aug 16, 2023
Merged
Merged
@davidhewitt
Copy link
Contributor

Pydantic 2.2 (releasing very soon) will include Field(union_mode='left_to_right') to opt out of the smart validation.

@davidhewitt davidhewitt mentioned this issue Aug 21, 2023
Merged
4 tasks
@ml-evs ml-evs mentioned this issue Nov 5, 2023
Closed
1 task
@davidhewitt davidhewitt added the v3 Under consideration for V3 label Jan 18, 2024
@Viicos Viicos added pending Is unconfirmed and removed unconfirmed labels Jan 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dmontagu dmontagu

Labels
bug V2 Bug related to Pydantic V2 pending Is unconfirmed v3 Under consideration for V3
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@davidhewitt @samuelcolvin @dmontagu @Viicos @stevegoss-komodo
0