diff --git a/docs/contributing.rst b/docs/contributing.rst index 823be9cd78..f78e720db4 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -381,7 +381,7 @@ virtualenv for smoke testing: $ pip install ipython $ ipython >>> from web3.auto import w3 - >>> w3.isConnected() + >>> w3.is_connected() >>> ... diff --git a/docs/internals.rst b/docs/internals.rst index faf4afcca9..85137bee01 100644 --- a/docs/internals.rst +++ b/docs/internals.rst @@ -101,7 +101,7 @@ setting the middlewares the provider should use. the JSON-RPC method being called. -.. py:method:: BaseProvider.isConnected() +.. py:method:: BaseProvider.is_connected() This function should return ``True`` or ``False`` depending on whether the provider should be considered *connected*. For example, an IPC socket diff --git a/docs/overview.rst b/docs/overview.rst index 60e40a0ee0..5fe3a8f321 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -40,7 +40,7 @@ following built-in providers: # WebsocketProvider: >>> w3 = Web3(Web3.WebsocketProvider('ws://127.0.0.1:8546')) - >>> w3.isConnected() + >>> w3.is_connected() True For more information, (e.g., connecting to remote nodes, provider auto-detection, diff --git a/docs/providers.rst b/docs/providers.rst index 293b9097b2..08668e675f 100644 --- a/docs/providers.rst +++ b/docs/providers.rst @@ -132,7 +132,7 @@ For example, the following retrieves the client enode endpoint for both geth and from web3.auto import w3 - connected = w3.isConnected() + connected = w3.is_connected() if connected and w3.clientVersion.startswith('Parity'): enode = w3.parity.enode @@ -186,7 +186,7 @@ an optional secret key, set the environment variable ``WEB3_INFURA_API_SECRET``: >>> from web3.auto.infura import w3 # confirm that the connection succeeded - >>> w3.isConnected() + >>> w3.is_connected() True Geth dev Proof of Authority @@ -199,7 +199,7 @@ To connect to a ``geth --dev`` Proof of Authority instance with defaults: >>> from web3.auto.gethdev import w3 # confirm that the connection succeeded - >>> w3.isConnected() + >>> w3.is_connected() True Built In Providers diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 169115a2bc..d0129d6fe0 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -46,7 +46,7 @@ Web3.py makes this test provider available via ``EthereumTesterProvider``: >>> from web3 import Web3, EthereumTesterProvider >>> w3 = Web3(EthereumTesterProvider()) - >>> w3.isConnected() + >>> w3.is_connected() True @@ -73,7 +73,7 @@ to this local node can be done as follows: # WebsocketProvider: >>> w3 = Web3(Web3.WebsocketProvider('wss://127.0.0.1:8546')) - >>> w3.isConnected() + >>> w3.is_connected() True If you stick to the default ports or IPC file locations, you can utilize a @@ -83,7 +83,7 @@ and save a few keystrokes: .. code-block:: python >>> from web3.auto import w3 - >>> w3.isConnected() + >>> w3.is_connected() True diff --git a/docs/troubleshooting.rst b/docs/troubleshooting.rst index 8f03bcecd1..2e4e1c6512 100644 --- a/docs/troubleshooting.rst +++ b/docs/troubleshooting.rst @@ -55,7 +55,7 @@ Ethereum network. An example configuration, if you're connecting to a locally ru >>> w3 = Web3(Web3.HTTPProvider('http://localhost:8545')) # now `w3` is available to use: - >>> w3.isConnected() + >>> w3.is_connected() True >>> w3.eth.send_transaction(...) @@ -66,11 +66,11 @@ Refer to the :ref:`providers` documentation for further help with configuration. Why isn't my web3 instance connecting to the network? ----------------------------------------------------- -You can check that your instance is connected via the ``isConnected`` method: +You can check that your instance is connected via the ``is_connected`` method: .. code-block:: python - >>> w3.isConnected() + >>> w3.is_connected() False There's a variety of explanations for why you may see ``False`` here. If you're diff --git a/newsfragments/2643.breaking-change.rst b/newsfragments/2643.breaking-change.rst new file mode 100644 index 0000000000..8bf020e9cb --- /dev/null +++ b/newsfragments/2643.breaking-change.rst @@ -0,0 +1 @@ +Snakecase the `isConnected` method diff --git a/tests/core/providers/test_async_tester_provider.py b/tests/core/providers/test_async_tester_provider.py index 4c95d50745..9a1fe29f53 100644 --- a/tests/core/providers/test_async_tester_provider.py +++ b/tests/core/providers/test_async_tester_provider.py @@ -8,7 +8,7 @@ @pytest.mark.asyncio async def test_async_tester_provider_is_connected() -> None: provider = AsyncEthereumTesterProvider() - connected = await provider.isConnected() + connected = await provider.is_connected() assert connected diff --git a/tests/core/providers/test_ipc_provider.py b/tests/core/providers/test_ipc_provider.py index a59f427a92..380aa9264b 100644 --- a/tests/core/providers/test_ipc_provider.py +++ b/tests/core/providers/test_ipc_provider.py @@ -33,10 +33,10 @@ def jsonrpc_ipc_pipe_path(): def test_ipc_no_path(): """ - IPCProvider.isConnected() returns False when no path is supplied + IPCProvider.is_connected() returns False when no path is supplied """ ipc = IPCProvider(None) - assert ipc.isConnected() is False + assert ipc.is_connected() is False def test_ipc_tilda_in_path(): diff --git a/tests/core/providers/test_provider.py b/tests/core/providers/test_provider.py index 3829042167..64c039ea19 100644 --- a/tests/core/providers/test_provider.py +++ b/tests/core/providers/test_provider.py @@ -6,30 +6,30 @@ class ConnectedProvider(BaseProvider): - def isConnected(self): + def is_connected(self): return True class DisconnectedProvider(BaseProvider): - def isConnected(self): + def is_connected(self): return False -def test_isConnected_connected(): +def test_is_connected_connected(): """ - Web3.isConnected() returns True when connected to a node. + Web3.is_connected() returns True when connected to a node. """ w3 = Web3(ConnectedProvider()) - assert w3.isConnected() is True + assert w3.is_connected() is True -def test_isConnected_disconnected(): +def test_is_connected_disconnected(): """ - Web3.isConnected() returns False when configured with a provider + Web3.is_connected() returns False when configured with a provider that's not connected to a node. """ w3 = Web3(DisconnectedProvider()) - assert w3.isConnected() is False + assert w3.is_connected() is False def test_autoprovider_detection(): @@ -50,6 +50,6 @@ def must_not_call(): w3 = Web3(auto) - assert w3.isConnected() + assert w3.is_connected() assert isinstance(auto._active_provider, ConnectedProvider) diff --git a/tests/core/utilities/test_attach_modules.py b/tests/core/utilities/test_attach_modules.py index 6b2d718855..ed1ba64e1c 100644 --- a/tests/core/utilities/test_attach_modules.py +++ b/tests/core/utilities/test_attach_modules.py @@ -127,7 +127,7 @@ def test_attach_external_modules_multiple_levels_deep( }, ) - assert w3.isConnected() + assert w3.is_connected() # assert instantiated with default modules assert hasattr(w3, "geth") diff --git a/web3/_utils/module_testing/eth_module.py b/web3/_utils/module_testing/eth_module.py index a886a4c154..e27974fe90 100644 --- a/web3/_utils/module_testing/eth_module.py +++ b/web3/_utils/module_testing/eth_module.py @@ -110,8 +110,8 @@ async def test_eth_gas_price(self, async_w3: "Web3") -> None: assert gas_price > 0 @pytest.mark.asyncio - async def test_isConnected(self, async_w3: "Web3") -> None: - is_connected = await async_w3.isConnected() # type: ignore + async def test_is_connected(self, async_w3: "Web3") -> None: + is_connected = await async_w3.is_connected() # type: ignore assert is_connected is True @pytest.mark.asyncio diff --git a/web3/_utils/module_testing/web3_module.py b/web3/_utils/module_testing/web3_module.py index 5c007d9498..1e4a1469eb 100644 --- a/web3/_utils/module_testing/web3_module.py +++ b/web3/_utils/module_testing/web3_module.py @@ -294,4 +294,4 @@ def test_solidityKeccak_same_number_of_types_and_values( w3.solidityKeccak(types, values) def test_is_connected(self, w3: "Web3") -> None: - assert w3.isConnected() + assert w3.is_connected() diff --git a/web3/main.py b/web3/main.py index f5c64d6f3c..185f17a7a0 100644 --- a/web3/main.py +++ b/web3/main.py @@ -338,8 +338,8 @@ def attach_modules( """ _attach_modules(self, modules) - def isConnected(self) -> Union[bool, Coroutine[Any, Any, bool]]: - return self.provider.isConnected() + def is_connected(self) -> Union[bool, Coroutine[Any, Any, bool]]: + return self.provider.is_connected() def is_encodable(self, _type: TypeStr, value: Any) -> bool: return self.codec.is_encodable(_type, value) diff --git a/web3/providers/async_base.py b/web3/providers/async_base.py index 88d493f5e7..bdf4a9d11a 100644 --- a/web3/providers/async_base.py +++ b/web3/providers/async_base.py @@ -82,7 +82,7 @@ async def _generate_request_func( async def make_request(self, method: RPCEndpoint, params: Any) -> RPCResponse: raise NotImplementedError("Providers must implement this method") - async def isConnected(self) -> bool: + async def is_connected(self) -> bool: raise NotImplementedError("Providers must implement this method") @@ -104,7 +104,7 @@ def decode_rpc_response(self, raw_response: bytes) -> RPCResponse: text_response = to_text(raw_response) return cast(RPCResponse, FriendlyJsonSerde().json_decode(text_response)) - async def isConnected(self) -> bool: + async def is_connected(self) -> bool: try: response = await self.make_request(RPCEndpoint("web3_clientVersion"), []) except OSError: diff --git a/web3/providers/auto.py b/web3/providers/auto.py index 90720f5a11..19d7e2e792 100644 --- a/web3/providers/auto.py +++ b/web3/providers/auto.py @@ -95,9 +95,9 @@ def make_request(self, method: RPCEndpoint, params: Any) -> RPCResponse: except OSError: return self._proxy_request(method, params, use_cache=False) - def isConnected(self) -> bool: + def is_connected(self) -> bool: provider = self._get_active_provider(use_cache=True) - return provider is not None and provider.isConnected() + return provider is not None and provider.is_connected() def _proxy_request( self, method: RPCEndpoint, params: Any, use_cache: bool = True @@ -117,7 +117,7 @@ def _get_active_provider(self, use_cache: bool) -> Optional[BaseProvider]: for Provider in self._potential_providers: provider = Provider() - if provider is not None and provider.isConnected(): + if provider is not None and provider.is_connected(): self._active_provider = provider return provider diff --git a/web3/providers/base.py b/web3/providers/base.py index ac1eff23dd..2155322099 100644 --- a/web3/providers/base.py +++ b/web3/providers/base.py @@ -82,7 +82,7 @@ def _generate_request_func( def make_request(self, method: RPCEndpoint, params: Any) -> RPCResponse: raise NotImplementedError("Providers must implement this method") - def isConnected(self) -> bool: + def is_connected(self) -> bool: raise NotImplementedError("Providers must implement this method") @@ -104,7 +104,7 @@ def encode_rpc_request(self, method: RPCEndpoint, params: Any) -> bytes: encoded = FriendlyJsonSerde().json_encode(rpc_dict) return to_bytes(text=encoded) - def isConnected(self) -> bool: + def is_connected(self) -> bool: try: response = self.make_request(RPCEndpoint("web3_clientVersion"), []) except OSError: diff --git a/web3/providers/eth_tester/main.py b/web3/providers/eth_tester/main.py index 4260e21cac..99f9a39a90 100644 --- a/web3/providers/eth_tester/main.py +++ b/web3/providers/eth_tester/main.py @@ -85,7 +85,7 @@ async def make_request(self, method: RPCEndpoint, params: Any) -> RPCResponse: "result": response, } - async def isConnected(self) -> Literal[True]: + async def is_connected(self) -> Literal[True]: return True @@ -157,5 +157,5 @@ def make_request(self, method: RPCEndpoint, params: Any) -> RPCResponse: "result": response, } - def isConnected(self) -> Literal[True]: + def is_connected(self) -> Literal[True]: return True