[WIP] Fix set serialization in metadata system #4249
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
htahir1
force-pushed
the
claude/zenml-issue-4248-01FHgBjs7uLxfNF5oP7incqW
branch
from
084095b to
fcda9c8
Compare
schustmi
requested changes
Nov 26, 2025
src/zenml/metadata/metadata_types.py
Outdated
| return typed_value # type: ignore[no-any-return] | ||
|
|
||
|
|
||
| def serialize_metadata_value(value: MetadataType) -> str: |
Contributor
There was a problem hiding this comment.
This is not a good implementation. It does cover top-level sets, but for example fails if it's nested in some other element like a dictionary or list. There is a way to do this natively with json encoders, and there even is a pydantic encoder that we use in our code to solve this in other places.
Contributor
Documentation Link Check Results❌ Absolute links check failed |
htahir1
force-pushed
the
claude/zenml-issue-4248-01FHgBjs7uLxfNF5oP7incqW
branch
3 times, most recently
from
04e40e1 to
ffa80a5
Compare
Sets were documented as a supported MetadataType but failed during serialization because json.dumps() cannot serialize Python sets. This change uses the standard pydantic_encoder to convert sets (and tuples) to lists before JSON serialization, making them compatible with JSON while preserving type information via MetadataTypeEnum. The fix uses pydantic_encoder directly (via json.dumps(value, default=pydantic_encoder)) at all serialization points, following the same pattern used throughout the ZenML codebase. This ensures consistency and proper handling of all supported types including nested sets/tuples, UUIDs, datetimes, etc. Changes: - Update validate_metadata() in metadata_types.py to use pydantic_encoder - Update Client.create_run_metadata() to use pydantic_encoder - Update SQLZenStore.create_run_metadata() to use pydantic_encoder - Add unit tests for set/tuple validation - Document supported metadata types in user guide Fixes #4248
htahir1
force-pushed
the
claude/zenml-issue-4248-01FHgBjs7uLxfNF5oP7incqW
branch
from
ffa80a5 to
6b41e90
Compare
schustmi
approved these changes
Nov 26, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Just running this to run tests
Sets were documented as a supported MetadataType but failed during serialization because json.dumps() cannot serialize Python sets. This change adds a helper function to convert sets (and tuples) to lists before JSON serialization, making them compatible with JSON while preserving type information via MetadataTypeEnum.
Fixes #4248
Pre-requisites
Please ensure you have done the following:
developand the open PR is targetingdevelop. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.Types of changes