Cleanup Normalizer type hints

Author: cburgdorf

eth/tools/_utils/normalization.py

@@ -5,6 +5,7 @@
     Any,
     AnyStr,
     Callable,
+    cast,
     Dict,
     Iterable,
     List,
@@ -56,8 +57,9 @@
 from eth.typing import (
     AccountState,
     GeneralState,
-    NormalizerType,
+    Normalizer,
     TransactionDict,
+    TransactionNormalizer,
 )
 
 
@@ -127,7 +129,7 @@ def normalize_to_address(value: AnyStr) -> Address:
 #
 def dict_normalizer(formatters: Dict[Any, Callable[..., Any]],
                     required: Iterable[Any]=None,
-                    optional: Iterable[Any]=None) -> NormalizerType:
+                    optional: Iterable[Any]=None) -> Normalizer:
 
     all_keys = set(formatters.keys())
 
@@ -154,7 +156,7 @@ def normalizer(d: Dict[Any, Any]) -> Dict[str, Any]:
     return normalizer
 
 
-def dict_options_normalizer(normalizers: Iterable[NormalizerType]) -> NormalizerType:
+def dict_options_normalizer(normalizers: Iterable[Normalizer]) -> Normalizer:
 
     def normalize(d: Dict[Any, Any]) -> Dict[str, Any]:
         first_exception = None
@@ -247,36 +249,36 @@ def state_definition_to_dict(state_definition: GeneralState) -> AccountState:
 )
 
 
-normalize_main_transaction = dict_normalizer({    # type: ignore # Overwrite type hint not yet supported # noqa: 501
+normalize_main_transaction = cast(Normalizer, dict_normalizer({
     "data": normalize_bytes,
     "gasLimit": normalize_int,
     "gasPrice": normalize_int,
     "nonce": normalize_int,
     "secretKey": normalize_bytes,
     "to": normalize_to_address,
     "value": normalize_int,
-})  # type: TransactionNormalizer
+}))
 
 
-normalize_transaction = dict_options_normalizer([  # type: ignore # Overwrite type hint not yet supported # noqa: 501
+normalize_transaction = cast(TransactionNormalizer, dict_options_normalizer([
     normalize_main_transaction,
-])  # type: TransactionNormalizer
+]))
 
 
-normalize_main_transaction_group = dict_normalizer({   # type: ignore # Overwrite type hint not yet supported # noqa: 501
+normalize_main_transaction_group = cast(Normalizer, dict_normalizer({
     "data": eth_utils.curried.apply_formatter_to_array(normalize_bytes),
     "gasLimit": eth_utils.curried.apply_formatter_to_array(normalize_int),
     "gasPrice": normalize_int,
     "nonce": normalize_int,
     "secretKey": normalize_bytes,
     "to": normalize_to_address,
     "value": eth_utils.curried.apply_formatter_to_array(normalize_int),
-})  # type: TransactionNormalizer
+}))
 
 
-normalize_transaction_group = dict_options_normalizer([   # type: ignore # Overwrite type hint not yet supported # noqa: 501
+normalize_transaction_group = cast(TransactionNormalizer, dict_options_normalizer([
     normalize_main_transaction_group,
-])  # type: TransactionNormalizer
+]))
 
 
 normalize_execution = dict_normalizer({
@@ -330,9 +332,10 @@ def state_definition_to_dict(state_definition: GeneralState) -> AccountState:
 def normalize_unsigned_transaction(transaction: TransactionDict,
                                    indexes: Dict[str, Any]) -> TransactionDict:
 
-    normalized = normalize_transaction_group(transaction)   # type: TransactionDict
+    normalized = normalize_transaction_group(transaction)
     return merge(normalized, {
-        transaction_key: normalized[transaction_key][indexes[index_key]]    # type: ignore # https://github.com/python/mypy/issues/5359 # noqa: 501
+        # Dynamic key access not yet allowed with TypedDict https://github.com/python/mypy/issues/5359
+        transaction_key: normalized[transaction_key][indexes[index_key]]  # type: ignore
         for transaction_key, index_key in [
             ("gasLimit", "gas"),
             ("value", "value"),

eth/tools/fixtures/normalization.py

@@ -52,12 +52,16 @@
     deep_merge,
     is_cleanly_mergable,
 )
+from eth.tools._utils.normalization import (
+    normalize_transaction_group
+)
 
 from eth.typing import (
     AccountState,
     GeneralState,
-    NormalizerType,
+    Normalizer,
     TransactionDict,
+    TransactionNormalizer,
 )
 
 
@@ -125,7 +129,7 @@ def normalize_to_address(value: AnyStr) -> Address:
 #
 def dict_normalizer(formatters: Dict[Any, Callable[..., Any]],
                     required: Iterable[Any]=None,
-                    optional: Iterable[Any]=None) -> NormalizerType:
+                    optional: Iterable[Any]=None) -> Normalizer:
 
     all_keys = set(formatters.keys())
 
@@ -152,7 +156,7 @@ def normalizer(d: Dict[Any, Any]) -> Dict[str, Any]:
     return normalizer
 
 
-def dict_options_normalizer(normalizers: Iterable[NormalizerType]) -> NormalizerType:
+def dict_options_normalizer(normalizers: Iterable[Normalizer]) -> Normalizer:
 
     def normalize(d: Dict[Any, Any]) -> Dict[str, Any]:
         first_exception = None
@@ -245,38 +249,6 @@ def state_definition_to_dict(state_definition: GeneralState) -> AccountState:
 )
 
 
-normalize_main_transaction = dict_normalizer({      # type: ignore # Overwrite type hint not yet supported by mypy # noqa: 501
-    "data": normalize_bytes,
-    "gasLimit": normalize_int,
-    "gasPrice": normalize_int,
-    "nonce": normalize_int,
-    "secretKey": normalize_bytes,
-    "to": normalize_to_address,
-    "value": normalize_int,
-})  # type: TransactionNormalizer
-
-
-normalize_transaction = dict_options_normalizer([    # type: ignore # Overwrite type hint not yet supported by mypy # noqa: 501
-    normalize_main_transaction,
-])  # type: TransactionNormalizer
-
-
-normalize_main_transaction_group = dict_normalizer({  # type: ignore # Overwrite type hint not yet supported by mypy # noqa: 501
-    "data": eth_utils.curried.apply_formatter_to_array(normalize_bytes),
-    "gasLimit": eth_utils.curried.apply_formatter_to_array(normalize_int),
-    "gasPrice": normalize_int,
-    "nonce": normalize_int,
-    "secretKey": normalize_bytes,
-    "to": normalize_to_address,
-    "value": eth_utils.curried.apply_formatter_to_array(normalize_int),
-})  # type: TransactionNormalizer
-
-
-normalize_transaction_group = dict_options_normalizer([   # type: ignore # Overwrite type hint not yet supported by mypy # noqa: 501
-    normalize_main_transaction_group,
-])  # type: TransactionNormalizer
-
-
 normalize_execution = dict_normalizer({
     "address": to_canonical_address,
     "origin": to_canonical_address,
@@ -330,7 +302,8 @@ def normalize_unsigned_transaction(transaction: TransactionDict,
 
     normalized = normalize_transaction_group(transaction)
     return merge(normalized, {
-        transaction_key: normalized[transaction_key][indexes[index_key]]    # https://github.com/python/mypy/issues/5359 # noqa: 501
+        # Dynamic key access not yet allowed with TypedDict https://github.com/python/mypy/issues/5359
+        transaction_key: normalized[transaction_key][indexes[index_key]]  #  type: ignore
         for transaction_key, index_key in [
             ("gasLimit", "gas"),
             ("value", "value"),

eth/typing.py

@@ -44,7 +44,7 @@
                              'secretKey': bytes,
                              })
 
-NormalizerType = Callable[[Dict[Any, Any]], Dict[str, Any]]
+Normalizer = Callable[[Dict[Any, Any]], Dict[str, Any]]
 
 TransactionNormalizer = Callable[[TransactionDict], TransactionDict]