fix(uved): ensure metadata is serializable and update extraction meth… #90
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
…ods to return dicts
Contributor
There was a problem hiding this comment.
Pull request overview
This PR ensures that metadata extracted from UVED documents is fully JSON-serializable by converting dataclass objects to dictionaries. This addresses serialization issues that would occur when attempting to convert metadata containing dataclass instances to JSON.
Changes:
- Converted topics, levels, scholar institution types, fields of education, and authors from dataclass objects to dictionaries using
asdict - Added test case to verify metadata can be serialized to JSON without errors
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| welearn_datastack/plugins/rest_requesters/uved.py | Updated _extract_metadata to convert all dataclass objects to dictionaries for JSON serialization |
| tests/document_collector_hub/plugins_test/test_uved.py | Added test to verify metadata serialization works correctly |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…'t assert anything. Consider adding an assertion to verify the serialization succeeds, such as self.assertIsInstance(json.dumps(metadata), str) or at minimum add a comment explaining that this test validates no exception is raised.
jmsevin
approved these changes
Jan 13, 2026
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.
This pull request focuses on improving the serialization of metadata extracted from UVED documents, ensuring that all relevant objects are converted to dictionaries for compatibility with JSON serialization. It also adds a test to verify that the metadata can be serialized without errors.
Metadata Serialization Improvements:
_extract_metadatamethod inuved.pyto convert all extracted topic, level, scholar institution type, field of education, and author objects to dictionaries usingasdict, ensuring the returned metadata is fully JSON-serializable. [1] [2]asdictfromdataclassesinuved.pyto support the new serialization logic.Testing Enhancements:
test_serialize_metadataintest_uved.pyto verify that the metadata extracted from a UVED item can be serialized to JSON without errors.