add flag to is_connected to allow user to see why provider connection failed
#2912
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
pacrob
force-pushed
the
improve-is_connected-failure
branch
2 times, most recently
from
fc48a9c
to
78c5d0d
Compare
pacrob
changed the title
is_connected to allow user to see why provider connection failedis_connected to allow user to see why provider connection failed
pacrob
force-pushed
the
improve-is_connected-failure
branch
7 times, most recently
from
0bec883
to
72dcab4
Compare
pacrob
changed the title
is_connected to allow user to see why provider connection failedis_connected to allow user to see why provider connection failed
pacrob
force-pushed
the
improve-is_connected-failure
branch
from
72dcab4
to
2a59ab4
Compare
pacrob
force-pushed
the
improve-is_connected-failure
branch
from
2a59ab4
to
691a44e
Compare
kclowes
approved these changes
Apr 20, 2023
docs/internals.rst
Outdated
| @@ -101,13 +101,17 @@ setting the middlewares the provider should use. | |||
| the JSON-RPC method being called. | |||
|
|
|||
|
|
|||
| .. py:method:: BaseProvider.is_connected() | |||
| .. py:method:: BaseProvider.is_connected(raise_if_false=False) | |||
There was a problem hiding this comment.
I'm finding raise_if_false to be sort of hard to reason about. Maybe we could call this argument show_traceback or show_stack_trace or something along those lines instead?
There was a problem hiding this comment.
I like show_traceback. Changed.
docs/internals.rst
Outdated
|
|
||
| This function should return ``True`` or ``False`` depending on whether the | ||
| provider should be considered *connected*. For example, an IPC socket | ||
| based provider should return ``True`` if the socket is open and ``False`` | ||
| if the socket is closed. | ||
|
|
||
| If set to ``True``, the optional ``raise_if_false`` boolean should raise a |
There was a problem hiding this comment.
😄
Suggested change
| If set to ``True``, the optional ``raise_if_false`` boolean should raise a | |
| If set to ``True``, the optional ``raise_if_false`` boolean will raise a |
| @@ -83,5 +90,5 @@ async def test_user_provided_session() -> None: | |||
| session = ClientSession() | |||
| provider = AsyncHTTPProvider(endpoint_uri=URI) | |||
| cached_session = await provider.cache_async_session(session) | |||
| assert len(request._async_session_cache) == 1 | |||
| assert len(request._async_session_cache) == 2 | |||
There was a problem hiding this comment.
Why do these changes increase the cache size?
There was a problem hiding this comment.
The is_connecteds I added were added to the cache. Updated to clear the cache at the end of the test.
pacrob
force-pushed
the
improve-is_connected-failure
branch
2 times, most recently
from
2c115e4
to
19faa57
Compare
pacrob
force-pushed
the
improve-is_connected-failure
branch
from
19faa57
to
06d6ee2
Compare
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?
w3.is_connected()just returns True or False. It would be helpful to know why the connection failed if it is False.Closes #2910
How was it fixed?
Added a
raise_if_falseflag to theis_connectedmethod and a newProviderConnectionErrorwhich inherits fromWeb3Exception.While adding tests, did a little cleanup on other provider testing.
Todo:
Cute Animal Picture