Skip to content

code in "Combining Pydantic and semver" doc contains bug on serialization to json. #429

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
Closed
apiwat-chantawibul opened this issue Oct 6, 2023 · 1 comment
Closed

code in "Combining Pydantic and semver" doc contains bug on serialization to json. #429

apiwat-chantawibul opened this issue Oct 6, 2023 · 1 comment

Comments

@apiwat-chantawibul
Copy link
Contributor

Situation

The code defining ManifestVersion in "Combining Pydantic and semver" documentation

python-semver/docs/advanced/combine-pydantic-and-semver.rst

Lines 17 to 60 in 1f08632

from typing import Annotated, Any, Callable
from pydantic import GetJsonSchemaHandler
from pydantic_core import core_schema
from pydantic.json_schema import JsonSchemaValue
from semver import Version
class _VersionPydanticAnnotation:
@classmethod
def __get_pydantic_core_schema__(
cls,
_source_type: Any,
_handler: Callable[[Any], core_schema.CoreSchema],
) -> core_schema.CoreSchema:
def validate_from_str(value: str) -> Version:
return Version.parse(value)
from_str_schema = core_schema.chain_schema(
[
core_schema.str_schema(),
core_schema.no_info_plain_validator_function(validate_from_str),
]
)
return core_schema.json_or_python_schema(
json_schema=from_str_schema,
python_schema=core_schema.union_schema(
[
core_schema.is_instance_schema(Version),
from_str_schema,
]
),
serialization=core_schema.plain_serializer_function_ser_schema(
lambda instance: instance.x
),
)
@classmethod
def __get_pydantic_json_schema__(
cls, _core_schema: core_schema.CoreSchema, handler: GetJsonSchemaHandler
) -> JsonSchemaValue:
return handler(core_schema.str_schema())
ManifestVersion = Annotated[Version, _VersionPydanticAnnotation]

has a bug when ManifestVersion is used for serialization to JSON, resulting in the following raised exception:

pydantic_core._pydantic_core.PydanticSerializationError: Error calling function `<lambda>`: AttributeError: 'Version' object has no attribute 'x'

To Reproduce

from pydantic import TypeAdapter
from semver import Version

version = Version.parse('1.2.3')
json_version = TypeAdapter(ManifestVersion).dump_json(version)

Expected Behavior

is described in the following pytest module.
(with the ManifestVersion defined in __init__.py.)

import json
import pytest
from pydantic import TypeAdapter
from semver import Version

from . import ManifestVersion


@pytest.mark.parametrize(
    'version',
    [
        '0.0.1',
        '1.9.8',
        '2.3.4-rc+generic',
        '11.12.13-0.1.2',
    ],
)
def test_serialize(version):
    expected_json = json.dumps(version).encode()
    expected_python = version = Version.parse(version)

    result_python = TypeAdapter(ManifestVersion).dump_python(version)
    result_json = TypeAdapter(ManifestVersion).dump_json(version)

    assert result_python == expected_python
    assert result_json == expected_json

Solution

Change

python-semver/docs/advanced/combine-pydantic-and-semver.rst

Lines 49 to 51 in 1f08632

serialization=core_schema.plain_serializer_function_ser_schema(
lambda instance: instance.x
),

to

serialization = core_schema.to_string_ser_schema(),
@tomschr tomschr closed this as completed in a951c8a Oct 7, 2023
tomschr added a commit that referenced this issue Oct 7, 2023
@tomschr
Merge pull request #430 from apiwat-chantawibul/fix-semver-pydantic-s…
bd313ed 
…erialization

Fix #429: bug on serialization to json
@tomschr
Copy link
Member

tomschr commented Oct 7, 2023

Thanks a lot! Merged and happy! 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@tomschr @apiwat-chantawibul