Deprecate async get_uncle* methods

Author: tibor-reiss

tests/core/utilities/test_abi.py

@@ -829,7 +829,7 @@ def test_get_event_abi(event_name: str, input_args: Sequence[ABIComponent]) -> N
 
     with pytest.warns(
         DeprecationWarning,
-        match="get_event_abi is deprecated in favor of get_abi_element",
+        match="get_event_abi is deprecated: use get_abi_element instead",
     ):
         assert (
             get_event_abi(contract_abi, event_name, input_names) == expected_event_abi

web3/_utils/decorators.py

@@ -43,7 +43,7 @@ def deprecated_for(replace_message: str) -> Callable[..., Any]:
     """
     Decorate a deprecated function, with info about what to use instead, like:
 
-    @deprecated_for("to_bytes()")
+    @deprecated_for("use to_bytes() instead")
     def toAscii(arg):
         ...
     """
@@ -52,7 +52,7 @@ def decorator(to_wrap: TFunc) -> TFunc:
         @functools.wraps(to_wrap)
         def wrapper(*args: Any, **kwargs: Any) -> Callable[..., Any]:
             warnings.warn(
-                f"{to_wrap.__name__} is deprecated in favor of {replace_message}",
+                f"{to_wrap.__name__} is deprecated: {replace_message}",
                 category=DeprecationWarning,
                 stacklevel=2,
             )

web3/_utils/module_testing/eth_module.py

@@ -2172,19 +2172,29 @@ async def test_eth_getBlockTransactionCountByHash_block_with_txn(
     async def test_eth_getUncleCountByBlockHash(
         self, async_w3: "AsyncWeb3", async_empty_block: BlockData
     ) -> None:
-        uncle_count = await async_w3.eth.get_uncle_count(async_empty_block["hash"])
+        with pytest.warns(
+            DeprecationWarning,
+            match=r"get_uncle_count is deprecated: all get_uncle\* methods will be removed in v8",
+        ):
+            uncle_count = await async_w3.eth.get_uncle_count(async_empty_block["hash"])
 
-        assert is_integer(uncle_count)
-        assert uncle_count == 0
+            assert is_integer(uncle_count)
+            assert uncle_count == 0
 
     @pytest.mark.asyncio
     async def test_eth_getUncleCountByBlockNumber(
         self, async_w3: "AsyncWeb3", async_empty_block: BlockData
     ) -> None:
-        uncle_count = await async_w3.eth.get_uncle_count(async_empty_block["number"])
+        with pytest.warns(
+            DeprecationWarning,
+            match=r"get_uncle_count is deprecated: all get_uncle\* methods will be removed in v8",
+        ):
+            uncle_count = await async_w3.eth.get_uncle_count(
+                async_empty_block["number"]
+            )
 
-        assert is_integer(uncle_count)
-        assert uncle_count == 0
+            assert is_integer(uncle_count)
+            assert uncle_count == 0
 
     @pytest.mark.asyncio
     async def test_eth_getBlockTransactionCountByNumber_block_with_txn(

web3/eth/async_eth.py

@@ -39,6 +39,9 @@
 from web3._utils.compat import (
     Unpack,
 )
+from web3._utils.decorators import (
+    deprecated_for,
+)
 from web3._utils.fee_utils import (
     async_fee_history_priority_fee,
 )
@@ -669,6 +672,7 @@ async def sign_typed_data(
         mungers=[default_root_munger],
     )
 
+    @deprecated_for("all get_uncle* methods will be removed in v8")
     async def get_uncle_count(self, block_identifier: BlockIdentifier) -> int:
         return await self._get_uncle_count(block_identifier)
 

web3/utils/abi.py

@@ -682,7 +682,7 @@ def check_if_arguments_can_be_encoded(
     )
 
 
-@deprecated_for("get_abi_element")
+@deprecated_for("use get_abi_element instead")
 def get_event_abi(
     abi: ABI,
     event_name: str,