Implemented data serialization/deserialization with marshmallow #21
Conversation
There was a problem hiding this comment.
I think these changes are really nice and you chose a great example to start with! It might be worth seeing how many issues arise when running mypy --strict because of this (just to get an idea of how far we can take it wrt other projects). I am also curious to know how compatible json.loads/dumps works with lists of marshmallow objects and similar for things like CSV export (i.e. as_tuple). I know that python's native dataclasses come packed with as_tuple which is a plus.
src/utils.py
Outdated
| def _deserialize(self, value, *args, **kwargs): | ||
| if hasattr(value, "lower"): | ||
| value = value.lower() | ||
| return super()._deserialize(value, *args, **kwargs) | ||
|
|
||
| def _serialize(self, value, attr, obj, **kwargs): | ||
| if value is None: | ||
| return "" | ||
| return str(value).lower() |
There was a problem hiding this comment.
In both of these methods I see several unused attributes... (attr, obj, args, kwargs) are these required by the Schema interface? How might one go about handling the lint/type errors that arise from this?
There was a problem hiding this comment.
They were part of the suggested way to implement custom Fields in marshmallow: https://marshmallow.readthedocs.io/en/stable/custom_fields.html#creating-a-field-class
That's a good question. Not sure how this is possible. I'll try removing them and see if it still works.
|
I've added some of your feedback into the suggestions @bh2smith. Let me know what you think about them? |
|
Looks much better! I think we can go with it (once CI passes). |
|
one thing I just noticed is that all the "models" are now in the utils file. would probably be better to put them in a models file |
|
I agree it's definitely the right way to do so. I'll create an issue about it. |
|
Issue can be found here. |
In reference to the discussion in #20 I wanted to propose to start implementing marshmallow for data serialization and deserialization. This might not be the best possible example for this as there are other more advanced functionalities that I haven't made use of.
Reference: https://marshmallow.readthedocs.io/en/stable/quickstart.html
Open for any discussion or feedback this might have.