Merge pull request #1200 from njgheorghita/update-manager-providers-to-single-provider

Change manager.providers from list to single manager.provider (V5 beta)

Author: njgheorghita

conftest.py

@@ -40,19 +40,15 @@ def sleep_interval():
     return PollDelayCounter()
 
 
-def is_all_testrpc_providers(providers):
-    return all(
-        isinstance(provider, EthereumTesterProvider)
-        for provider
-        in providers
-    )
+def is_testrpc_provider(provider):
+    return isinstance(provider, EthereumTesterProvider)
 
 
 @pytest.fixture()
 def skip_if_testrpc():
 
     def _skip_if_testrpc(web3):
-        if is_all_testrpc_providers(web3.providers):
+        if is_testrpc_provider(web3.provider):
             pytest.skip()
     return _skip_if_testrpc
 

docs/providers.rst

@@ -316,29 +316,3 @@ AutoProvider
 :class:`~web3.providers.auto.AutoProvider` is the default used when initializing
 :class:`web3.Web3` without any providers. There's rarely a reason to use it
 explicitly.
-
-
-Using Multiple Providers
-------------------------
-
-Web3 supports the use of multiple providers.  This is useful for cases where
-you wish to delegate requests across different providers.  To use this feature,
-simply instantiate your web3 instance with an iterable of provider instances.
-
-
-.. code-block:: python
-
-    >>> from web3 import Web3, HTTPProvider
-    >>> from . import MySpecialProvider
-    >>> special_provider = MySpecialProvider()
-    >>> infura_provider = HTTPProvider('https://ropsten.infura.io')
-    >>> w3 = Web3([special_provider, infura_provider])
-
-
-When web3 has multiple providers it will iterate over them in order, trying the
-RPC request and returning the first response it receives.  Any provider which
-*cannot* respond to a request **must** throw a
-``web3.exceptions.CannotHandleRequest`` exception.
-
-If none of the configured providers are able to handle the request, then a
-``web3.exceptions.UnhandledRequest`` exception will be thrown.

ens/main.py

@@ -48,14 +48,14 @@ class ENS:
     is_valid_name = staticmethod(is_valid_name)
     reverse_domain = staticmethod(address_to_reverse_domain)
 
-    def __init__(self, providers=default, addr=None):
+    def __init__(self, provider=default, addr=None):
         '''
-        :param providers: a list or single provider used to connect to Ethereum
-        :type providers: instance of `web3.providers.base.BaseProvider`
+        :param provider: a single provider used to connect to Ethereum
+        :type provider: instance of `web3.providers.base.BaseProvider`
         :param hex-string addr: the address of the ENS registry on-chain. If not provided,
             ENS.py will default to the mainnet ENS registry address.
         '''
-        self.web3 = init_web3(providers)
+        self.web3 = init_web3(provider)
 
         ens_addr = addr if addr else ENS_MAINNET_ADDR
         self.ens = self.web3.eth.contract(abi=abis.ENS, address=ens_addr)
@@ -70,7 +70,7 @@ def fromWeb3(cls, web3, addr=None):
         :param hex-string addr: the address of the ENS registry on-chain. If not provided,
             ENS.py will default to the mainnet ENS registry address.
         '''
-        return cls(web3.manager.providers, addr=addr)
+        return cls(web3.manager.provider, addr=addr)
 
     def address(self, name, guess_tld=True):
         '''

tests/core/contracts/test_contract_call_interface.py

@@ -412,13 +412,13 @@ def test_call_fallback_function(fallback_function_contract):
 
 
 def test_throws_error_if_block_out_of_range(web3, math_contract):
-    web3.providers[0].make_request(method='evm_mine', params=[20])
+    web3.provider.make_request(method='evm_mine', params=[20])
     with pytest.raises(BlockNumberOutofRange):
         math_contract.functions.counter().call(block_identifier=-50)
 
 
 def test_accepts_latest_block(web3, math_contract):
-    web3.providers[0].make_request(method='evm_mine', params=[5])
+    web3.provider.make_request(method='evm_mine', params=[5])
     math_contract.functions.increment().transact()
 
     late = math_contract.functions.counter().call(block_identifier='latest')
@@ -429,9 +429,9 @@ def test_accepts_latest_block(web3, math_contract):
 
 
 def test_accepts_block_hash_as_identifier(web3, math_contract):
-    blocks = web3.providers[0].make_request(method='evm_mine', params=[5])
+    blocks = web3.provider.make_request(method='evm_mine', params=[5])
     math_contract.functions.increment().transact()
-    more_blocks = web3.providers[0].make_request(method='evm_mine', params=[5])
+    more_blocks = web3.provider.make_request(method='evm_mine', params=[5])
 
     old = math_contract.functions.counter().call(block_identifier=blocks['result'][2])
     new = math_contract.functions.counter().call(block_identifier=more_blocks['result'][2])
@@ -441,10 +441,10 @@ def test_accepts_block_hash_as_identifier(web3, math_contract):
 
 
 def test_neg_block_indexes_from_the_end(web3, math_contract):
-    web3.providers[0].make_request(method='evm_mine', params=[5])
+    web3.provider.make_request(method='evm_mine', params=[5])
     math_contract.functions.increment().transact()
     math_contract.functions.increment().transact()
-    web3.providers[0].make_request(method='evm_mine', params=[5])
+    web3.provider.make_request(method='evm_mine', params=[5])
 
     output1 = math_contract.functions.counter().call(block_identifier=-7)
     output2 = math_contract.functions.counter().call(block_identifier=-6)
@@ -455,7 +455,7 @@ def test_neg_block_indexes_from_the_end(web3, math_contract):
 
 def test_returns_data_from_specified_block(web3, math_contract):
     start_num = web3.eth.getBlock('latest').number
-    web3.providers[0].make_request(method='evm_mine', params=[5])
+    web3.provider.make_request(method='evm_mine', params=[5])
     math_contract.functions.increment().transact()
     math_contract.functions.increment().transact()
 

tests/core/filtering/conftest.py

@@ -19,7 +19,7 @@
 
 @pytest.fixture()
 def tester_snapshot(web3):
-    return web3.providers[0].ethereum_tester.take_snapshot()
+    return web3.provider.ethereum_tester.take_snapshot()
 
 
 @pytest.fixture(

tests/core/filtering/test_contract_data_filters.py

@@ -61,7 +61,7 @@ def clear_chain_state(web3, snapshot):
     Hypothesis doesn't allow function scoped fixtures to re-run between test runs
     so chain state needs to be explicitly cleared
     """
-    web3.providers[0].ethereum_tester.revert_to_snapshot(snapshot)
+    web3.provider.ethereum_tester.revert_to_snapshot(snapshot)
 
 
 @pytest.mark.parametrize('api_style', ('v4', 'build_filter'))

tests/core/filtering/test_contract_topic_filters.py

@@ -63,7 +63,7 @@ def clear_chain_state(web3, snapshot):
     Hypothesis doesn't allow function scoped fixtures to re-run between test runs
     so chain state needs to be explicitly cleared
     """
-    web3.providers[0].ethereum_tester.revert_to_snapshot(snapshot)
+    web3.provider.ethereum_tester.revert_to_snapshot(snapshot)
 
 
 @pytest.mark.parametrize('api_style', ('v4', 'build_filter'))

tests/core/filtering/test_existing_filter_instance.py

@@ -10,8 +10,8 @@
 
 @pytest.fixture()
 def filter_id(web3):
-    if EthereumTesterProvider not in map(type, web3.providers):
-        web3.providers = EthereumTesterProvider()
+    if not isinstance(web3.provider, EthereumTesterProvider):
+        web3.provider = EthereumTesterProvider()
 
     block_filter = web3.eth.filter("latest")
     return block_filter.filter_id

tests/core/filtering/test_filter_against_latest_blocks.py

@@ -7,8 +7,8 @@
 
 
 def test_sync_filter_against_latest_blocks(web3, sleep_interval, wait_for_block):
-    if EthereumTesterProvider not in map(type, web3.providers):
-        web3.providers = EthereumTesterProvider()
+    if not isinstance(web3.provider, EthereumTesterProvider):
+        web3.provider = EthereumTesterProvider()
 
     txn_filter = web3.eth.filter("latest")
 

tests/core/gas-strategies/test_time_based_gas_price_strategy.py

@@ -141,7 +141,7 @@ def test_time_based_gas_price_strategy(strategy_params, expected):
     })
 
     w3 = Web3(
-        providers=[BaseProvider()],
+        provider=BaseProvider(),
         middlewares=[fixture_middleware],
     )
 
@@ -195,7 +195,7 @@ def test_time_based_gas_price_strategy_zero_sample(strategy_params_zero,
         })
 
         w3 = Web3(
-            providers=[BaseProvider()],
+            provider=BaseProvider(),
             middlewares=[fixture_middleware],
         )
         time_based_gas_price_strategy_zero = construct_time_based_gas_price_strategy(

tests/core/manager/test_provider_property.py

@@ -13,8 +13,8 @@ def test_provider_property_setter_and_getter():
     assert provider_a is not provider_b
 
     manager = RequestManager(None, provider_a)
-    assert manager.providers[0] is provider_a
+    assert manager.provider is provider_a
 
-    manager.providers = provider_b
+    manager.provider = provider_b
 
-    assert manager.providers[0] is provider_b
+    assert manager.provider is provider_b

tests/core/middleware/test_filter_middleware.py

@@ -47,7 +47,7 @@ def result_generator_middleware(iter_block_number):
 
 @pytest.fixture(scope='function')
 def w3_base():
-    return Web3(providers=[DummyProvider()], middlewares=[])
+    return Web3(provider=DummyProvider(), middlewares=[])
 
 
 @pytest.fixture(scope='function')

tests/core/middleware/test_fixture_middleware.py

@@ -21,7 +21,7 @@ def make_request(self, method, params):
 
 @pytest.fixture
 def w3():
-    return Web3(providers=[DummyProvider()], middlewares=[])
+    return Web3(provider=DummyProvider(), middlewares=[])
 
 
 @pytest.mark.parametrize(

tests/core/middleware/test_latest_block_based_cache_middleware.py

@@ -25,7 +25,7 @@
 
 @pytest.fixture
 def w3_base():
-    return Web3(providers=[BaseProvider()], middlewares=[])
+    return Web3(provider=BaseProvider(), middlewares=[])
 
 
 def _mk_block(n, timestamp):

tests/core/middleware/test_name_to_address_middleware.py

@@ -29,7 +29,7 @@ def address(self, name, guess_tld=True):
 
 @pytest.fixture
 def w3():
-    w3 = Web3(providers=[BaseProvider()], middlewares=[])
+    w3 = Web3(provider=BaseProvider(), middlewares=[])
     w3.ens = TempENS({NAME: ADDRESS})
     w3.middleware_stack.add(name_to_address_middleware(w3))
     return w3

tests/core/middleware/test_request_param_normalizer.py

@@ -12,7 +12,7 @@
 
 @pytest.fixture
 def w3_base():
-    return Web3(providers=[BaseProvider()], middlewares=[])
+    return Web3(provider=BaseProvider(), middlewares=[])
 
 
 @pytest.fixture

tests/core/middleware/test_simple_cache_middleware.py

@@ -18,7 +18,7 @@
 
 @pytest.fixture
 def w3_base():
-    return Web3(providers=[BaseProvider()], middlewares=[])
+    return Web3(provider=BaseProvider(), middlewares=[])
 
 
 @pytest.fixture

tests/core/middleware/test_time_based_cache_middleware.py

@@ -19,7 +19,7 @@
 
 @pytest.fixture
 def w3_base():
-    return Web3(providers=[BaseProvider()], middlewares=[])
+    return Web3(provider=BaseProvider(), middlewares=[])
 
 
 @pytest.fixture

tests/core/middleware/test_transaction_signing.py

@@ -89,7 +89,7 @@ def result_generator_middleware():
 
 @pytest.fixture()
 def w3_base():
-    return Web3(providers=[DummyProvider()], middlewares=[])
+    return Web3(provider=DummyProvider(), middlewares=[])
 
 
 @pytest.fixture()

tests/core/providers/test_auto_provider.py

@@ -45,8 +45,8 @@ def test_web3_auto_infura_empty_key(monkeypatch, caplog, environ_name):
     assert level == logging.WARNING
 
     w3 = infura.w3
-    assert isinstance(w3.providers[0], HTTPProvider)
-    assert getattr(w3.providers[0], 'endpoint_uri') == 'https://mainnet.infura.io/'
+    assert isinstance(w3.provider, HTTPProvider)
+    assert getattr(w3.provider, 'endpoint_uri') == 'https://mainnet.infura.io/'
 
 
 @pytest.mark.parametrize('environ_name', ['INFURA_API_KEY', 'WEB3_INFURA_API_KEY'])
@@ -61,8 +61,8 @@ def test_web3_auto_infura_deleted_key(monkeypatch, caplog, environ_name):
     assert level == logging.WARNING
 
     w3 = infura.w3
-    assert isinstance(w3.providers[0], HTTPProvider)
-    assert getattr(w3.providers[0], 'endpoint_uri') == 'https://mainnet.infura.io/'
+    assert isinstance(w3.provider, HTTPProvider)
+    assert getattr(w3.provider, 'endpoint_uri') == 'https://mainnet.infura.io/'
 
 
 @pytest.mark.parametrize('environ_name', ['INFURA_API_KEY', 'WEB3_INFURA_API_KEY'])
@@ -76,14 +76,14 @@ def test_web3_auto_infura(monkeypatch, caplog, environ_name):
     assert len(caplog.record_tuples) == 0
 
     w3 = infura.w3
-    assert isinstance(w3.providers[0], HTTPProvider)
-    assert getattr(w3.providers[0], 'endpoint_uri') == expected_url
+    assert isinstance(w3.provider, HTTPProvider)
+    assert getattr(w3.provider, 'endpoint_uri') == expected_url
 
 
 def test_web3_auto_infura_websocket_default(caplog):
     importlib.reload(infura)
     assert len(caplog.record_tuples) == 0
 
     w3 = infura.w3
-    assert isinstance(w3.providers[0], WebsocketProvider)
-    assert getattr(w3.providers[0], 'endpoint_uri') == 'wss://mainnet.infura.io/ws'
+    assert isinstance(w3.provider, WebsocketProvider)
+    assert getattr(w3.provider, 'endpoint_uri') == 'wss://mainnet.infura.io/ws'

tests/core/providers/test_ipc_provider.py

@@ -81,7 +81,7 @@ def test_sync_waits_for_full_result(jsonrpc_ipc_pipe_path, serve_empty_result):
 
 
 def test_web3_auto_gethdev():
-    assert isinstance(w3.providers[0], IPCProvider)
+    assert isinstance(w3.provider, IPCProvider)
     return_block_with_long_extra_data = construct_fixture_middleware({
         'eth_getBlockByNumber': {'extraData': '0x' + 'ff' * 33},
     })

tests/core/web3-module/test_providers.py

@@ -7,20 +7,12 @@
 )
 
 
-def test_set_providers(web3):
-    providers = [EthereumTesterProvider()]
+def test_set_provider(web3):
+    provider = EthereumTesterProvider()
 
-    web3.providers = providers
+    web3.provider = provider
 
-    assert web3.providers == providers
-
-
-def test_set_providers_single(web3):
-    providers = [EthereumTesterProvider()]
-
-    web3.providers = providers[0]
-
-    assert web3.providers == providers
+    assert web3.provider == provider
 
 
 def test_auto_provider_none():
@@ -30,4 +22,4 @@ def test_auto_provider_none():
     # non-node requests succeed
     w3.toHex(0) == '0x0'
 
-    type(w3.providers[0]) == AutoProvider
+    type(w3.provider) == AutoProvider