Remove AttributeDict method formatters and opt for middleware
#2805
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
fselmo
force-pushed
the
opt-in-attribute-dicts
branch
from
8b4b4ce to
7ad9bfd
Compare
- ``AttributeDict`` leads to typing complications when properties are accessed via attribute, rather than key / value. This doesn't complicate too much since a user can opt for key / value every time but it isn't ideal to provide an option that breaks typing. Those who wish to turn off all recursive conversion to ``AttributeDict`` can simply remove the ``attrdict_middleware`` (or ``async_attrdict_middleware``) and not worry about possible typing complications. - In order for this to work for async as well, support for ``async_attrdict_middleware` was introduced. This is also now one of the default middlewares for the ``EthereumTesterProvider`` as this was the default behavior achieved via the result formatters.
fselmo
force-pushed
the
opt-in-attribute-dicts
branch
from
7ad9bfd to
7231fef
Compare
- fix test_process_params to expect one result formatter - add attribute dict middlewares to sync and async local filter middleware tests - add attrdict middleware check to async http provider test
fselmo
force-pushed
the
opt-in-attribute-dicts
branch
from
7231fef to
578b8e8
Compare
fselmo
force-pushed
the
opt-in-attribute-dicts
branch
from
22acff8 to
dcb0455
Compare
kclowes
approved these changes
Feb 6, 2023
Collaborator
kclowes
left a comment
kclowes
left a comment
There was a problem hiding this comment.
LGTM! Just had one nit in the docs, feel free to take or leave.
| "eth_estimateGas", | ||
| "eth_sendTransaction", | ||
| ): | ||
| fill_default_from = fill_default("from", guess_from, w3) |
Collaborator
There was a problem hiding this comment.
That's wild that these are the only methods that need a default from 🤔
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
What was wrong?
AttributeDictleads to typing complications when properties are accessed via attribute, rather than key / value. This doesn't complicate too much since a user can opt for key / value every time but it isn't ideal to provide an option that breaks typing.closes #1656
How was it fixed?
The approach suggested in #1656 does not feel like a great resolution since
NamedTuplewill rename any reserved python keywords to_0,_1,_2, etc... Seeing as JSON-RPC responses commonly have properties likefrom, for example, this would not lead to a very good user experience.AttributeDictconversion was removed from the result formatters and moved back to being only in the middleware. A more inclusive recursive approach was taken to make sure all results get passed through the recursive checks for conversion ofdicttoAttributeDict. Users who wish to turn off all recursive conversion toAttributeDictcan simply remove theattrdict_middleware(orasync_attrdict_middleware) and not worry about possible typing complications.In order for this to work for async as well, support for
async_attrdict_middlewarewas introduced. This is also now one of the default middlewares for theEthereumTesterProvider(andAsyncEthereumTesterProvider) asdict->AttributeDictwas the default behavior, via result formatters, forEthereumTesterProvider.Todo:
attrdict_middleware+async_attrdict_middlewareCute Animal Picture