Skip to content
New issue

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

(🐞) Enum with multiple values (tuple) can't be round tripped through json #10629

Open
1 task done
KotlinIsland opened this issue Oct 15, 2024 · 1 comment · May be fixed by pydantic/pydantic-core#1502
Open
1 task done

(🐞) Enum with multiple values (tuple) can't be round tripped through json #10629

KotlinIsland opened this issue Oct 15, 2024 · 1 comment · May be fixed by pydantic/pydantic-core#1502
Labels
bug V2 Bug related to Pydantic V2 help wanted Pull Request welcome

Comments

@KotlinIsland
Copy link
Contributor

KotlinIsland commented Oct 15, 2024 •
edited
Loading

Initial Checks

  • I confirm that I'm using Pydantic V2

Description

pydantic_core._pydantic_core.ValidationError: 1 validation error for RootModel[A]
a
  Input should be (1, 2) [type=enum, input_value=[1, 2], input_type=list]
    For further information visit https://errors.pydantic.dev/2.9/v/enum

Enums support functionality where a tuple ("multiple values") is assigned to the member

here, we see that pydantic does not support serialising and parsing of this type of Enum value

Workaround

add a core schema to the class:

    @classmethod
    def __get_pydantic_core_schema__(cls, source_type, handler):
        return core_schema.no_info_before_validator_function(
            lambda data: data if isinstance(data, cls) else tuple(data), handler(source_type)
        )

Example Code

from enum import Enum

from pydantic import RootModel


class A(Enum):
    a = 1, 2


serialised = RootModel[A](A.a).model_dump_json()
parsed = RootModel[A].model_validate_json(serialised)

Python, Pydantic & OS Version

pydantic version: 2.9.2
        pydantic-core version: 2.23.4
          pydantic-core build: profile=release pgo=false
                 install path: C:\Users\AMONGUS\projects\test\.venv\Lib\site-packages\pydantic
               python version: 3.12.2 (tags/v3.12.2:6abddd9, Feb  6 2024, 21:26:36) [MSC v.1937 64 bit (AMD64)]
                     platform: Windows-10-10.0.19045-SP0
             related packages: typing_extensions-4.12.2
                       commit: unknown
@KotlinIsland KotlinIsland added bug V2 Bug related to Pydantic V2 pending Awaiting a response / confirmation labels Oct 15, 2024
@sydney-runkle
Copy link
Member

sydney-runkle commented Oct 24, 2024 •
edited
Loading

Indeed, this is a bug, but a pretty far out edge case. Happy to consider PRs with a fix in pydantic-core for enum validators...

Thanks for reporting this issue.

@sydney-runkle sydney-runkle added help wanted Pull Request welcome and removed pending Awaiting a response / confirmation labels Oct 24, 2024
@changhc changhc linked a pull request Oct 25, 2024 that will close this issue
Open
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug V2 Bug related to Pydantic V2 help wanted Pull Request welcome
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Validate enum values against other possible forms of expected values changhc/pydantic-core
2 participants
@sydney-runkle @KotlinIsland