Add support for external modules to web3 instance #2288
Merged
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
fselmo
force-pushed
the
attach-external-modules
branch
4 times, most recently
from
b26de80
to
d550b85
Compare
fselmo
changed the title
fselmo
commented
Jan 5, 2022
fselmo
commented
Jan 5, 2022
| @@ -18,11 +18,13 @@ | |||
|
|
|||
| def attach_modules( | |||
| parent_module: Union["Web3", "Module"], | |||
| module_definitions: Dict[str, Sequence[Any]], | |||
| module_definitions: Dict[str, Any], | |||
There was a problem hiding this comment.
The recursive nature of this method makes it really hard to add any useful typing here so this has to be Any unfortunately. But I am new to typing in python, maybe there's a way to make this stricter 🤔 . At least all the uses of this method are able to be a tad more strict.
There was a problem hiding this comment.
I found this documentation: https://mypy.readthedocs.io/en/stable/protocols.html#recursive-protocols, but I would have to play with it some to figure out how exactly we'd use it. If digging into that seems out of the scope of this PR, I'm fine leaving this as-is.
fselmo
commented
Jan 5, 2022
fselmo
force-pushed
the
attach-external-modules
branch
from
d550b85
to
ee6c2e5
Compare
- added web3.attach_module() to attach a single module to a web3 instance e.g. w3.attach_module('module1', ModuleClass1)
- added support for initializing the instance with external modules e.g. w3 = Web3(..., external_modules={'module1': ModuleClass1})
- modules can be passed in without needing to be a tuple or list if they don't contain submodules i.e. pass in the class by itself instead a tuple with 1 argument, (ModuleClass1,)
- added tests for the above
- updated docs for web3 main to include usage examples for the above changes
fselmo
force-pushed
the
attach-external-modules
branch
from
ee6c2e5
to
1190d9d
Compare
kclowes
reviewed
Jan 5, 2022
| @@ -18,11 +18,13 @@ | |||
|
|
|||
| def attach_modules( | |||
| parent_module: Union["Web3", "Module"], | |||
| module_definitions: Dict[str, Sequence[Any]], | |||
| module_definitions: Dict[str, Any], | |||
There was a problem hiding this comment.
I found this documentation: https://mypy.readthedocs.io/en/stable/protocols.html#recursive-protocols, but I would have to play with it some to figure out how exactly we'd use it. If digging into that seems out of the scope of this PR, I'm fine leaving this as-is.
kclowes
approved these changes
Jan 5, 2022
fselmo
added a commit
to fselmo/web3.py
that referenced
this pull request
Jan 5, 2022
- Add a test to make sure a tuple with a single module class still works for backwards compatibility. - Take out the docstring examples for `attach_module()` and leave them only in the docs. The consensus is that lengthy docstrings reiterating what is in the documentation would just crowd out our files and make the code harder to read. Instead, we should opt for brief yet useful despritions in the method docstrings.
fselmo
added a commit
to fselmo/web3.py
that referenced
this pull request
Jan 5, 2022
- Add a test to make sure a tuple with a single module class still works for backwards compatibility. - Take out the docstring examples for `attach_modules()` and leave them only in the docs. The consensus is that lengthy docstrings reiterating what is in the documentation would just crowd out our files and make the code harder to read. Instead, we should opt for brief yet useful despritions in the method docstrings. - Change the method to allow for a dict as the argument, as is in the constructor, so that multiple modules may be attached if desired.
fselmo
force-pushed
the
attach-external-modules
branch
from
8920d55
to
971028d
Compare
fselmo
added a commit
to fselmo/web3.py
that referenced
this pull request
Jan 5, 2022
- Add a test to make sure a tuple with a single module class still works for backwards compatibility. - Take out the docstring examples for `attach_modules()` and leave them only in the docs. The consensus is that lengthy docstrings reiterating what is in the documentation would just crowd out our files and make the code harder to read. Instead, we should opt for brief yet useful despritions in the method docstrings. - Change the method to allow for a dict as the argument, as is in the constructor, so that multiple modules may be attached if desired.
fselmo
force-pushed
the
attach-external-modules
branch
from
971028d
to
71d9de9
Compare
fselmo
added a commit
to fselmo/web3.py
that referenced
this pull request
Jan 5, 2022
- Add a test to make sure a tuple with a single module class still works for backwards compatibility. - Take out the docstring examples for `attach_modules()` and leave them only in the docs. The consensus is that lengthy docstrings reiterating what is in the documentation would just crowd out our files and make the code harder to read. Instead, we should opt for brief yet useful despritions in the method docstrings. - Change the method to allow for a dict as the argument, as is in the constructor, so that multiple modules may be attached if desired.
fselmo
force-pushed
the
attach-external-modules
branch
from
71d9de9
to
183a5dc
Compare
- Add a test to make sure a tuple with a single module class still works for backwards compatibility. - Take out the docstring examples for `attach_modules()` and leave them only in the docs. The consensus is that lengthy docstrings reiterating what is in the documentation would just crowd out our files and make the code harder to read. Instead, we should opt for brief yet useful despritions in the method docstrings. - Change the method to allow for a dict as the argument, as is in the constructor, so that multiple modules may be attached if desired. - Use the attach_modules utility method as an underscore-aliased internal method for clarity
fselmo
force-pushed
the
attach-external-modules
branch
from
183a5dc
to
95bd986
Compare
This was referenced Jan 14, 2022
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.
What was wrong?
We don't have an easy way to attach modules to the
Web3instance. This will help users customize their web3 experience but can also help to support things like attaching layer 2 modules from a separate library or any other modules that can prove useful.Closes Difficult to attach one extra module to a web3 instance.. #2231
How was it fixed?
The idea is to just expose the internal api for now. Perhaps improve on this in v6.
Web3instantiation. This is separate from the internal default modules already attached at instantiation.attach_modules()methodTodo:
Cute Animal Picture