Exercise doctests in _utils.abi

Includes fixes for previously broken doctests.

Author: feuGeneA

tests/core/utilities/test_abi.py

@@ -1,6 +1,7 @@
-
+import doctest
 import pytest
 
+import web3._utils.abi
 from web3._utils.abi import (
     ABITypedData,
     abi_data_tree,
@@ -162,3 +163,11 @@ def test_map_abi_data(types, data, funcs, expected):
 )
 def test_get_abi_inputs(function_abi, arg_values, expected):
     assert get_abi_inputs(function_abi, arg_values) == expected
+
+
+def test_docstrings(capsys):
+    """Exercise docstrings in the web3._utils.abi module."""
+    # disable stdout capture so failed tests will show why they failed
+    with capsys.disabled():
+        failure_count, _ = doctest.testmod(web3._utils.abi)
+        assert failure_count == 0

web3/_utils/abi.py

@@ -596,8 +596,8 @@ def abi_data_tree(types, data):
     As an example:
 
     >>> abi_data_tree(types=["bool[2]", "uint"], data=[[True, False], 0])
-    [("bool[2]", [("bool", True), ("bool", False)]), ("uint256", 0)]
-    '''
+    [ABITypedData(abi_type='bool[2]', data=[ABITypedData(abi_type='bool', data=True), ABITypedData(abi_type='bool', data=False)]), ABITypedData(abi_type='uint256', data=0)]
+    '''  # noqa: E501 (line too long)
     return [
         abi_sub_tree(data_type, data_value)
         for data_type, data_value
@@ -629,9 +629,11 @@ class ABITypedData(namedtuple('ABITypedData', 'abi_type, data')):
     '''
     This class marks data as having a certain ABI-type.
 
+    >>> addr1 = "0x" + "0" * 20
+    >>> addr2 = "0x" + "f" * 20
     >>> a1 = ABITypedData(['address', addr1])
     >>> a2 = ABITypedData(['address', addr2])
-    >>> addrs = ABITypedData(['address[]', [a1, a2])
+    >>> addrs = ABITypedData(['address[]', [a1, a2]])
 
     You can access the fields using tuple() interface, or with
     attributes: