Replace pydantic with mashumaro

[bvanelli]

Proposed Changes

This PR exchanges the pydantic dependency with mashumaro. This is due to the fact that the version of pydantic used is not anymore supported, and a migration was not accepted (see #531)

I've taken into account the following PRs from the author as references on how to do the migration:

• Replace pydantic with mashumaro python-elgato#938
• Replace pydantic with mashumaro python-tailscale#443

Changelog

I had to to some unrelated changes to get the pipeline to run through, due to some library upgrades that now fail on CI. Since the content is not crazy big, I decided to add them to the same PR, but let me know if I should make a separate PR instead. Here is the list of changes:

• Exchanged pydantic to mashumaro, like it was done on the other repositories

Discussion

As far as tests are concerned, the changes should work out of the box, but I do not have one of those devices to test it. If there is a way to have simulated APIs or there are test cases that should be covered, let me know.

Related Issues

For the pydantic upgrade in HA, this change is necessary:

• Pydantic v2 migration issue home-assistant/core#99218

[allenporter]

Changelog

I had to to some unrelated changes to get the pipeline to run through, due to some library upgrades that now fail on CI.
Since the content is not crazy big, I decided to add them to the same PR, but let me know if I should make a separate PR instead.

I'd definitely say make each of these changes into separate PRs for each change mentioned (CI fixes, async timeout, grammar/spelling fixes, linting fixes, etc)

[bvanelli]

I moved the unrelated changes to get the pipelines to run to other PRs:

• File had to be reformatted with latest ruff for the CI workflow to succeed, so some styling changed here and there, like spacings between and within comments.: Apply ruff pre-commit to all files. #742
• On the file .github/CODE_OF_CONDUCT.md, the codespell pre-commit was failing for the word socio-economic, so I changed it to socioeconomic. Seems like the word is not hyphenated: Fix typo on the code of conduct file. #743
• On CI linting workflow, the command poetry run ruff . was changed to poetry run ruff check .: ci: Fix ruff linting. #741
• I had to adapt the upload of artifacts because of Upcoming breaking change: Hidden Files will be excluded by default actions/upload-artifact#602, since the .coverage file would not be uploaded anymore without the include-hidden-files option.: Add include hidden files option to artifact upload. #744
• async_timeout.timeout has been replaced by asyncio.timeouts.timeout. See that the original library is not deprecated, and they recommend you to use asyncio instead. Since this library only supports Python 3.11 and above, the dependency is completely dropped (wasn't on the pyproject.toml either way): Remove async_timeouts and replace it with asyncio.timeouts. #745

Those can be made first and I'll rebase this branch once that is done. I left safety dependency removal in this PR because it's required to be removed for pydantic to be completely dropped.

[bvanelli]

• Also added Remove deprecation warnings when running ruff #746 for getting rid of warning when running ruff using deprecated options.

[frenck]

Thanks, for your work on this @bvanelli 👍

I've merged all split out PRs, and went over the project in certain places myself as well. CI on the main branch now passes again.

Can you rebase this PR on top of the latest main branch?

Thanks! 👍

../Frenck

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 92.92929% with 7 lines in your changes missing coverage. Please review.

Project coverage is 94.50%. Comparing base (53134cb) to head (2916c4e).
Report is 95 commits behind head on main.

Files with missing lines	Patch %	Lines
src/demetriek/models.py	94.25%	2 Missing and 3 partials ⚠️
src/demetriek/device.py	77.77%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #740      +/-   ##
==========================================
+ Coverage   93.73%   94.50%   +0.76%     
==========================================
  Files           6        6              
  Lines         383      400      +17     
  Branches       35       23      -12     
==========================================
+ Hits          359      378      +19     
+ Misses         22       17       -5     
- Partials        2        5       +3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[bvanelli]

@frenck did the rebase, everything looks nice except the poetry file that has some references to my own environent after running poetry lock --no-update to remove the dependency. You can also replace it on merge.

Let me know if I should change something else 👍

[frenck]

Thanks, @bvanelli! 👍 I will take a look...

[frenck]

There seems to be a serialization issue that is still left, the example provided in this repository doesn't work right now:

[frenck]

With the last change in place, it would only omit None values from the top level notification object, and not its contents, right?

[bvanelli]

With the last change in place, it would only omit None values from the top level notification object, and not its contents, right?

Yes, that is correct, I did that based on the docs request, and there it does not seem clear to me that those sub-fields are optional, for example, for Model.sound:

object that describes the notification sound to play when notification pops on the LaMetric Time’s screen

Fields from the Notification have the clear Optional keyword, but not this one, so I guess they are not optional on the request.

I did not move to review again since there is another issue. It seems like __pre_deserialize__ does not work the same way as the root validator does, since it does only run when desserializing, but not when directly instancing the object. I'm currently looking for a way to do that.

[bvanelli]

I'm currently looking for a way to do that.

Never mind, I just realized I used the wrong validation, I should have used dataclasses __post_init__ instead.

[bvanelli]

@frenck Thanks for reviewing and noticing my mistake on the serialization. I have changed the __pre_deserialize__ to __post_init__ since Sound is only instantiated directly.

Regarding the omit optional fields, I have not changed the behaviour for the inner objects. Since you have more experience with the API, should that be the case? That is affectin:

• Model.sound
• Goal.icon
• GoalData.icon
• Simple.icon

and from what I understood from the documentation none of them are option.

[frenck]

Awesome 👍

Just tested it against real devices, it seems to work as expected 👍

Will push up some nitpick sorting we can do now and continue on merging this one in.

../Frenck

[frenck]

Nice work @bvanelli 👍

../Frenck