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.

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

update min version of dataclass-wizard to v0.29.2 #73

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

leifdenby
Copy link
Member

@leifdenby leifdenby commented Feb 17, 2025

Describe your changes

Update minimum version of dataclass-wizard to 0.29.2 which fixed bug which meant it wasn't possible to define Union types while checking that all keys in the loaded yaml-config file matched a field in the config dataclass (rnag/dataclass-wizard#137). The pressense of this bug meant in neural-lam that we had to keep raise_on_unknown_json_key to its default False value. We should ensure that people have a version of dataclass-wizard installed that means we can check the config yaml against the config dataclass while supporting union types.

I have run the tests both against 0.29.2 and also 0.35.0 (which dataclass-wizard>=0.29.2 currently resolves to) of dataclass-wizard.

Issue Link

Closes #43

Type of change

  • 🐛 Bug fix (non-breaking change that fixes an issue)
  • ✨ New feature (non-breaking change that adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📖 Documentation (Addition or improvements to documentation)
  • maintenance

Checklist before requesting a review

  • My branch is up-to-date with the target branch - if not update your fork with the changes from the target branch (use pull with --rebase option if possible).
  • I have performed a self-review of my code
  • For any new/modified functions/classes I have added docstrings that clearly describe its purpose, expected inputs and returned values
  • I have placed in-line comments to clarify the intent of any hard-to-understand passages of my code
  • I have updated the documentation to cover introduced code changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have given the PR a name that clearly describes the change, written in imperative form (context).
  • I have requested a reviewer and an assignee (assignee is responsible for merging)

Checklist for reviewers

Each PR comes with its own improvements and flaws. The reviewer should check the following:

  • the code is readable
  • the code is well tested
  • the code is documented (including return types and parameters)
  • the code is easy to maintain

Author checklist after completed review

  • I have added a line to the CHANGELOG describing this change, in a section
    reflecting type of change (add section where missing):
    • added: when you have added new functionality
    • changed: when default behaviour of the code has been changed
    • fixes: when your contribution fixes a bug

Checklist for assignee

  • PR is up to date with the base branch
  • the tests pass
  • author has added an entry to the changelog (and designated the change as added, changed or fixed)
  • Once the PR is ready to be merged, squash commits and merge the PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update to dataclass-wizard version to support Union types while checking unmatched keys
1 participant