Add get_uncle_count, deprecate getUncleCount

ethereum · Jan 29, 2021 · d8996bd · d8996bd
1 parent a5f05d5
commit d8996bd
Show file tree

Hide file tree

Showing 5 changed files with 33 additions and 7 deletions.
diff --git a/docs/overview.rst b/docs/overview.rst
@@ -150,7 +150,7 @@ API
 - :meth:`web3.eth.get_transaction_by_block() <web3.eth.Eth.get_transaction_by_block>`
 - :meth:`web3.eth.getTransactionCount() <web3.eth.Eth.getTransactionCount>`
 - :meth:`web3.eth.get_uncle_by_block() <web3.eth.Eth.get_uncle_by_block>`
-- :meth:`web3.eth.getUncleCount() <web3.eth.Eth.getUncleCount>`
+- :meth:`web3.eth.get_uncle_count() <web3.eth.Eth.get_uncle_count>`
 
 
 Making Transactions

diff --git a/docs/web3.eth.rst b/docs/web3.eth.rst
@@ -505,7 +505,7 @@ The following methods are available on the ``web3.eth`` namespace.
     .. warning:: Deprecated: This method is deprecated in favor of
       :meth:`~web3.eth.Eth.get_uncle_by_block()`
 
-.. py:method:: Eth.getUncleCount(block_identifier)
+.. py:method:: Eth.get_uncle_count(block_identifier)
 
     * Delegates to ``eth_getUncleCountByBlockHash`` or
       ``eth_getUncleCountByBlockNumber`` RPC methods
@@ -518,13 +518,17 @@ The following methods are available on the ``web3.eth`` namespace.
 
     .. code-block:: python
 
-        >>> web3.eth.getUncleCount(56160)
+        >>> web3.eth.get_uncle_count(56160)
         1
 
         # You can also refer to the block by hash:
-        >>> web3.eth.getUncleCount('0x685b2226cbf6e1f890211010aa192bf16f0a0cba9534264a033b023d7367b845')
+        >>> web3.eth.get_uncle_count('0x685b2226cbf6e1f890211010aa192bf16f0a0cba9534264a033b023d7367b845')
         1
 
+.. py:method:: Eth.getUncleCount(block_identifier)
+
+    .. warning:: Deprecated: This property is deprecated in favor of
+      :attr:`~web3.eth.Eth.get_uncle_count()`
 
 .. py:method:: Eth.get_transaction(transaction_hash)
 

diff --git a/newsfragments/1863.feature.rst b/newsfragments/1863.feature.rst
@@ -0,0 +1 @@
+Add get_uncle_count, deprecate getUncleCount
diff --git a/web3/_utils/module_testing/eth_module.py b/web3/_utils/module_testing/eth_module.py
@@ -297,13 +297,33 @@ def test_eth_getBlockTransactionCountByNumber_block_with_txn_deprecated(
         assert transaction_count >= 1
 
     def test_eth_getUncleCountByBlockHash(self, web3: "Web3", empty_block: BlockData) -> None:
-        uncle_count = web3.eth.getUncleCount(empty_block['hash'])
+        uncle_count = web3.eth.get_uncle_count(empty_block['hash'])
+
+        assert is_integer(uncle_count)
+        assert uncle_count == 0
+
+    def test_eth_getUncleCountByBlockHash_deprecated(self,
+                                                     web3: "Web3",
+                                                     empty_block: BlockData) -> None:
+        with pytest.warns(DeprecationWarning,
+                          match='getUncleCount is deprecated in favor of get_uncle_count'):
+            uncle_count = web3.eth.getUncleCount(empty_block['hash'])
 
         assert is_integer(uncle_count)
         assert uncle_count == 0
 
     def test_eth_getUncleCountByBlockNumber(self, web3: "Web3", empty_block: BlockData) -> None:
-        uncle_count = web3.eth.getUncleCount(empty_block['number'])
+        uncle_count = web3.eth.get_uncle_count(empty_block['number'])
+
+        assert is_integer(uncle_count)
+        assert uncle_count == 0
+
+    def test_eth_getUncleCountByBlockNumber_deprecated(self,
+                                                       web3: "Web3",
+                                                       empty_block: BlockData) -> None:
+        with pytest.warns(DeprecationWarning,
+                          match='getUncleCount is deprecated in favor of get_uncle_count'):
+            uncle_count = web3.eth.getUncleCount(empty_block['number'])
 
         assert is_integer(uncle_count)
         assert uncle_count == 0

diff --git a/web3/eth.py b/web3/eth.py
@@ -369,7 +369,7 @@ def get_block_munger(
     `eth_getUncleCountByBlockHash`
     `eth_getUncleCountByBlockNumber`
     """
-    getUncleCount: Method[Callable[[BlockIdentifier], int]] = Method(
+    get_uncle_count: Method[Callable[[BlockIdentifier], int]] = Method(
         method_choice_depends_on_args=select_method_for_block_identifier(
             if_predefined=RPC.eth_getUncleCountByBlockNumber,
             if_hash=RPC.eth_getUncleCountByBlockHash,
@@ -660,3 +660,4 @@ def setGasPriceStrategy(self, gas_price_strategy: GasPriceStrategy) -> None:
                                              'getTransactionByBlock',
                                              'get_transaction_by_block')
     getUncleByBlock = DeprecatedMethod(get_uncle_by_block, 'getUncleByBlock', 'get_uncle_by_block')
+    getUncleCount = DeprecatedMethod(get_uncle_count, 'getUncleCount', 'get_uncle_count')