Add TupleDataclass #590
Merged
Add TupleDataclass #590
Conversation
This file contains 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
|
I have just got an idea that might work, please don't review yet. |
|
Ok, it won't work, dataclasses are a better solution |
Codecov ReportBase: 96.21% // Head: 96.20% // Decreases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## refactor/data-transformer #590 +/- ##
=============================================================
- Coverage 96.21% 96.20% -0.01%
=============================================================
Files 58 59 +1
Lines 2641 2664 +23
=============================================================
+ Hits 2541 2563 +22
- Misses 100 101 +1
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
cptartur
reviewed
Dec 13, 2022
war-in
approved these changes
Dec 14, 2022
I thought about doing that, but then realised that tuple won't know how to compare themselves to our dataclass. I checked and actually python prioritises custom eq, so it works 👌 |
cptartur
requested changes
Dec 14, 2022
cptartur
approved these changes
Dec 14, 2022
cptartur
added a commit
that referenced
this pull request
Jan 23, 2023
* Add cairo type parser (#566) * Add ABI module (#571) * Add transformation context (#576) * Add TupleDataclass (#590) * Add cairo.serializer module (#593) * Add fix to nested errors (#599) * Feat/payload serializer (#601) * Add tuple serializers (#612) * Add struct & uin256 serilaizer (#613) * Add FunctionSerializationAdapter (#614) * Add cycle check in parser (#630) * Add serializer factory functions (#629) * Use new serializer in contract (#637) * Replace data transfomer in some modules (#642) * Replace data transfomer in some modules * Simplify structure in account * Remove more dependencies on data_transfomer * Remove string typed types in contract * Cover missing statements (#648) * Cover missing statements * Change deprecation text in felt.py * Update starknet_py/cairo/type_parser.py Co-authored-by: war-in <61014013+war-in@users.noreply.github.com> Co-authored-by: war-in <61014013+war-in@users.noreply.github.com> * Add missing dots (#652) * Deprecate data_transformer module (#654) * Add simple examples in documentation of serializers (#653) * Add test for complex abi (#663) * Support {low, high} dict in uint256 serializer (#668) * Support {low, high} dict in uint256 serializer * Replace ^ with ** * Add basic docs for serializers (#679) * Add basic docs for serializers * Add more docs * Adjust comment * Move abi and serialization to top level modules * Add TupleDataclass to api * Fix docs * Fix serializing example * Fix lint * Use header consistent with the rest of the api * Remove unnecessary pylint disable, unify disables * Update comment * Format * Update docs/guide/serialization.rst Co-authored-by: Kamil Jankowski <kamil.jankowski.x@gmail.com> Co-authored-by: Artur Michalek <artur.michalek@swmansion.com> Co-authored-by: Artur Michałek <52135326+cptartur@users.noreply.github.com> Co-authored-by: Kamil Jankowski <kamil.jankowski.x@gmail.com> * Apply suggestions from code review Co-authored-by: war-in <61014013+war-in@users.noreply.github.com> * Make deployer.py variables private Co-authored-by: war-in <61014013+war-in@users.noreply.github.com> Co-authored-by: Artur Michalek <artur.michalek@swmansion.com> Co-authored-by: Artur Michałek <52135326+cptartur@users.noreply.github.com> Co-authored-by: Kamil Jankowski <kamil.jankowski.x@gmail.com>
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.
About
In data_transformer module we return
Resultclass and pretend it is a NamedTuple. This can lead to some unexpected behaviour.The most important feature of NamedTuple is that it can be used both as tuple and a regular object. By using dataclasses with
__getitem__and__iter__we can replicate this behaviour.Differences
The differences with previous implementation:
_asdictmethodI am wondering if we should support these two 🤔 Let me know what you think.
I also added 2 utility functions:
as_tupleandas_dictto make sure the most popular flows are covered out of the box.Cool things
In the future when doing #492 we can easily subclass
TupleDataclassto provide strict typing 🔥Other solutions
To be honest ideally I would just switch to using dicts as returned values from functions, but we would be missing spreading values like this:
x, y = result. It would be a big breaking change and would make quality of life worse. I think using simple dataclasses is nice compromise: we rely on solid, well known implementation and offer some simplifications.Related issues
Closes #589.