refactor Volume class to use dataclass and dataclass_json#89
Closed
tamirse wants to merge 3 commits intofeature/add-missing-volume-fieldsfrom
Closed
refactor Volume class to use dataclass and dataclass_json#89tamirse wants to merge 3 commits intofeature/add-missing-volume-fieldsfrom
tamirse wants to merge 3 commits intofeature/add-missing-volume-fieldsfrom
Conversation
Replaces the manual __init__/property/create_from_dict pattern with @DataClass + @dataclass_json for consistency with the Instance class. Undefined.EXCLUDE silently drops unknown API fields; infer_missing defaults missing optional fields to None. Retains create_from_dict as a deprecated shim for backwards compatibility. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
shamrin
requested changes
Mar 30, 2026
verda/volumes/_volumes.py
Outdated
| .. deprecated:: Use :meth:`from_dict` instead. | ||
| """ | ||
| return stringify_class_object_properties(self) | ||
| return cls.from_dict(volume_dict, infer_missing=True) |
Contributor
There was a problem hiding this comment.
Could we double-check that this is what we want? https://github.com/lidatong/dataclasses-json?tab=readme-ov-file#handle-missing-or-optional-field-values-when-decoding
verda/volumes/_volumes.py
Outdated
| volume_dict = self._http_client.get(VOLUMES_ENDPOINT + f'/{id}').json() | ||
|
|
||
| return Volume.create_from_dict(volume_dict) | ||
| return Volume.from_dict(volume_dict, infer_missing=True) |
All optional fields already have defaults on the dataclass, so infer_missing is unnecessary. Removing it gives stricter validation: a response missing a required field like id or name will raise immediately instead of silently setting None. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Replaces the manual
__init__/property/create_from_dictpattern with @DataClass + @dataclass_json for consistency with the Instance class. Undefined.EXCLUDE silently drops unknown API fields; infer_missing defaults missing optional fields to None. Retains create_from_dict as a deprecated shim for backwards compatibility.