deprecate getFilterChanges in favor of get_filter_changes

Author: tmckenzie51

docs/filters.rst

@@ -64,7 +64,7 @@ Filter Class
     Retrieve new entries for this filter.
 
     Logs will be retrieved using the
-    :func:`web3.eth.Eth.getFilterChanges` which returns only new entries since the last
+    :func:`web3.eth.Eth.get_filter_changes` which returns only new entries since the last
     poll.
 
 

docs/overview.rst

@@ -278,7 +278,7 @@ API
 ^^^
 
 - :meth:`web3.eth.filter() <web3.eth.Eth.filter>`
-- :meth:`web3.eth.getFilterChanges() <web3.eth.Eth.getFilterChanges>`
+- :meth:`web3.eth.get_filter_changes() <web3.eth.Eth.get_filter_changes>`
 - :meth:`web3.eth.get_filter_logs() <web3.eth.Eth.get_filter_logs>`
 - :meth:`web3.eth.uninstall_filter() <web3.eth.Eth.uninstall_filter>`
 - :meth:`web3.eth.get_logs() <web3.eth.Eth.get_logs>`

docs/web3.eth.rst

@@ -1060,7 +1060,7 @@ with the filtering API.
         >>> web3.eth.filter({'fromBlock': 1000000, 'toBlock': 1000100, 'address': '0x6C8f2A135f6ed072DE4503Bd7C4999a1a17F824B'})
         <LogFilter at 0x10b7803d8>
 
-.. py:method:: Eth.getFilterChanges(self, filter_id)
+.. py:method:: Eth.get_filter_changes(self, filter_id)
 
     * Delegates to ``eth_getFilterChanges`` RPC Method.
 
@@ -1070,7 +1070,7 @@ with the filtering API.
     .. code-block:: python
 
         >>> filt = web3.eth.filter()
-        >>> web3.eth.getFilterChanges(filt.filter_id)
+        >>> web3.eth.get_filter_changes(filt.filter_id)
         [
             {
                 'address': '0xDc3A9Db694BCdd55EBaE4A89B22aC6D12b3F0c24',
@@ -1088,6 +1088,12 @@ with the filtering API.
         ]
 
 
+.. py:method:: Eth.getFilterChanges(self, filter_id)
+
+    .. warning:: Deprecated: This property is deprecated in favor of
+      :meth:`~web3.eth.Eth.get_filter_changes()`
+
+
 .. py:method:: Eth.get_filter_logs(self, filter_id)
 
     * Delegates to ``eth_getFilterLogs`` RPC Method.

newsfragments/1916.feature.rst

@@ -0,0 +1 @@
+Add ``w3.eth.get_filter_changes`` deprecate ``w3.eth.getFilterChanges``

tests/core/middleware/test_filter_middleware.py

@@ -149,10 +149,10 @@ def test_local_filter_middleware(w3, iter_block_number):
 
     log_filter = w3.eth.filter(filter_params={'fromBlock': 'latest'})
 
-    assert w3.eth.getFilterChanges(block_filter.filter_id) == [HexBytes(BLOCK_HASH)]
+    assert w3.eth.get_filter_changes(block_filter.filter_id) == [HexBytes(BLOCK_HASH)]
 
     iter_block_number.send(2)
-    results = w3.eth.getFilterChanges(log_filter.filter_id)
+    results = w3.eth.get_filter_changes(log_filter.filter_id)
     assert results == FILTER_LOG
 
     assert w3.eth.get_filter_logs(log_filter.filter_id) == FILTER_LOG

web3/_utils/filters.py

@@ -161,7 +161,7 @@ def _filter_valid_entries(self, entries: Collection[LogReceipt]) -> Iterator[Log
         return filter(self.is_valid_entry, entries)
 
     def get_new_entries(self) -> List[LogReceipt]:
-        log_entries = self._filter_valid_entries(self.eth_module.getFilterChanges(self.filter_id))
+        log_entries = self._filter_valid_entries(self.eth_module.get_filter_changes(self.filter_id))
         return self._format_log_entries(log_entries)
 
     def get_all_entries(self) -> List[LogReceipt]:

web3/_utils/module_testing/eth_module.py

@@ -161,10 +161,8 @@ def test_eth_get_balance(self, web3: "Web3") -> None:
     def test_eth_getBalance_deprecated(self, web3: "Web3") -> None:
         coinbase = web3.eth.coinbase
 
-        with pytest.warns(DeprecationWarning):
-            with pytest.raises(InvalidAddress):
-                web3.eth.getBalance(ChecksumAddress(HexAddress(HexStr(coinbase.lower()))))
-
+        with pytest.warns(DeprecationWarning,
+                          match='getBalance is deprecated in favor of get_balance'):
             balance = web3.eth.getBalance(coinbase)
 
         assert is_integer(balance)
@@ -1298,7 +1296,7 @@ def test_eth_getUncleByBlockNumberAndIndex(self, web3: "Web3") -> None:
     def test_eth_newFilter(self, web3: "Web3") -> None:
         filter = web3.eth.filter({})
 
-        changes = web3.eth.getFilterChanges(filter.filter_id)
+        changes = web3.eth.get_filter_changes(filter.filter_id)
         assert is_list_like(changes)
         assert not changes
 
@@ -1312,7 +1310,7 @@ def test_eth_newFilter(self, web3: "Web3") -> None:
     def test_eth_newFilter_deprecated(self, web3: "Web3") -> None:
         filter = web3.eth.filter({})
 
-        changes = web3.eth.getFilterChanges(filter.filter_id)
+        changes = web3.eth.get_filter_changes(filter.filter_id)
         assert is_list_like(changes)
         assert not changes
 
@@ -1329,7 +1327,7 @@ def test_eth_newBlockFilter(self, web3: "Web3") -> None:
         filter = web3.eth.filter('latest')
         assert is_string(filter.filter_id)
 
-        changes = web3.eth.getFilterChanges(filter.filter_id)
+        changes = web3.eth.get_filter_changes(filter.filter_id)
         assert is_list_like(changes)
         assert not changes
 
@@ -1345,7 +1343,7 @@ def test_eth_newPendingTransactionFilter(self, web3: "Web3") -> None:
         filter = web3.eth.filter('pending')
         assert is_string(filter.filter_id)
 
-        changes = web3.eth.getFilterChanges(filter.filter_id)
+        changes = web3.eth.get_filter_changes(filter.filter_id)
         assert is_list_like(changes)
         assert not changes
 

web3/eth.py

@@ -600,7 +600,7 @@ def filter_munger(
         mungers=[filter_munger],
     )
 
-    getFilterChanges: Method[Callable[[HexStr], List[LogReceipt]]] = Method(
+    get_filter_changes: Method[Callable[[HexStr], List[LogReceipt]]] = Method(
         RPC.eth_getFilterChanges,
         mungers=[default_root_munger]
     )
@@ -716,3 +716,6 @@ def set_gas_price_strategy(self, gas_price_strategy: GasPriceStrategy) -> None:
                                              'get_transaction_receipt')
     uninstallFilter = DeprecatedMethod(uninstall_filter, 'uninstallFilter', 'uninstall_filter')
     getFilterLogs = DeprecatedMethod(get_filter_logs, 'getFilterLogs', 'get_filter_logs')
+    getFilterChanges = DeprecatedMethod(get_filter_changes,
+                                        'getFilterChanges',
+                                        'get_filter_changes')