Merge pull request #17 from unparalleled-js/refactor/display-node-begone

.github/workflows/test.yaml

@@ -53,7 +53,7 @@ jobs:
         strategy:
             matrix:
                 os: [ubuntu-latest, macos-latest]   # eventually add `windows-latest`
-                python-version: [3.7, 3.8, 3.9, "3.10"]
+                python-version: [3.8, 3.9, "3.10"]
 
         steps:
         - uses: actions/checkout@v2

.pre-commit-config.yaml

@@ -28,4 +28,4 @@ repos:
 
 
 default_language_version:
-    python: python3.8
+    python: python3.9

README.md

@@ -4,7 +4,7 @@ Ethereum Virtual Machine transaction tracing tool
 
 ## Dependencies
 
-* [python3](https://www.python.org/downloads) version 3.7.2 or greater, python3-dev
+* [python3](https://www.python.org/downloads) version 3.8 or greater, python3-dev
 
 ## Installation
 
@@ -79,25 +79,6 @@ from evm_trace import get_calltree_from_parity_trace
 tree = get_calltree_from_parity_trace(trace_list)
 ```
 
-### Call Tree Node Customization
-
-You can also customize the output by making your own display class:
-
-```python
-from evm_trace.display import DisplayableCallTreeNode, get_calltree_from_trace
-
-
-class CustomDisplay(DisplayableCallTreeNode):
-    def title(self) -> str:
-        call_type = self.call.call_type.value.lower().capitalize()
-        address = self.call.address.hex()
-        cost = self.call.gas_cost
-        return f"{call_type} call @ {address} gas_cost={cost}"
-
-
-calltree = get_calltree_from_geth_trace(trace, display_cls=CustomDisplay)
-```
-
 ### Gas Reports
 
 If you are using a node that supports creating traces, you can get a gas report.

evm_trace/base.py

@@ -1,11 +1,11 @@
 import math
-from typing import Dict, Iterator, List, Optional, Type
+from typing import Dict, Iterator, List, Optional
 
 from eth_utils import to_int
 from ethpm_types import BaseModel, HexBytes
 from pydantic import Field
 
-from evm_trace.display import DisplayableCallTreeNode
+from evm_trace.display import get_tree_display
 from evm_trace.enums import CallType
 
 
@@ -32,13 +32,9 @@ class CallTreeNode(BaseModel):
     calls: List["CallTreeNode"] = []
     selfdestruct: bool = False
     failed: bool = False
-    display_cls: Type[DisplayableCallTreeNode] = DisplayableCallTreeNode
-
-    def get_display_nodes(self) -> Iterator[DisplayableCallTreeNode]:
-        return self.display_cls.make_tree(self)
 
     def __str__(self) -> str:
-        return "\n".join([str(t) for t in self.get_display_nodes()])
+        return get_tree_display(self)
 
     def __repr__(self) -> str:
         return str(self)

evm_trace/display.py

@@ -6,16 +6,20 @@
     from evm_trace.base import CallTreeNode
 
 
-class DisplayableCallTreeNode(object):
-    _FILE_MIDDLE_PREFIX = "├──"
-    _FILE_LAST_PREFIX = "└──"
-    _PARENT_PREFIX_MIDDLE = "    "
-    _PARENT_PREFIX_LAST = "│   "
+def get_tree_display(call: "CallTreeNode") -> str:
+    return "\n".join([str(t) for t in TreeRepresentation.make_tree(call)])
+
+
+class TreeRepresentation(object):
+    FILE_MIDDLE_PREFIX = "├──"
+    FILE_LAST_PREFIX = "└──"
+    PARENT_PREFIX_MIDDLE = "    "
+    PARENT_PREFIX_LAST = "│   "
 
     def __init__(
         self,
         call: "CallTreeNode",
-        parent: Optional["DisplayableCallTreeNode"] = None,
+        parent: Optional["TreeRepresentation"] = None,
         is_last: bool = False,
     ):
         self.call = call
@@ -57,9 +61,9 @@ def title(self) -> str:
     def make_tree(
         cls,
         root: "CallTreeNode",
-        parent: Optional["DisplayableCallTreeNode"] = None,
+        parent: Optional["TreeRepresentation"] = None,
         is_last: bool = False,
-    ) -> Iterator["DisplayableCallTreeNode"]:
+    ) -> Iterator["TreeRepresentation"]:
         displayable_root = cls(root, parent=parent, is_last=is_last)
         yield displayable_root
 
@@ -77,12 +81,12 @@ def __str__(self) -> str:
         if self.parent is None:
             return self.title
 
-        _filename_prefix = self._FILE_LAST_PREFIX if self.is_last else self._FILE_MIDDLE_PREFIX
+        filename_prefix = self.FILE_LAST_PREFIX if self.is_last else self.FILE_MIDDLE_PREFIX
 
-        parts = [f"{_filename_prefix} {self.title}"]
+        parts = [f"{filename_prefix} {self.title}"]
         parent = self.parent
         while parent and parent.parent is not None:
-            parts.append(self._PARENT_PREFIX_MIDDLE if parent.is_last else self._PARENT_PREFIX_LAST)
+            parts.append(self.PARENT_PREFIX_MIDDLE if parent.is_last else self.PARENT_PREFIX_LAST)
             parent = parent.parent
 
         return "".join(reversed(parts))

evm_trace/parity.py

@@ -1,9 +1,8 @@
-from typing import Any, Dict, List, Optional, Type, Union
+from typing import Any, Dict, List, Optional, Union
 
 from pydantic import BaseModel, Field, validator
 
 from evm_trace.base import CallTreeNode, CallType
-from evm_trace.display import DisplayableCallTreeNode
 
 
 class CallAction(BaseModel):
@@ -95,7 +94,6 @@ def __getitem__(self, item):
 def get_calltree_from_parity_trace(
     traces: ParityTraceList,
     root: Optional[ParityTrace] = None,
-    display_cls: Type[DisplayableCallTreeNode] = DisplayableCallTreeNode,
     **root_kwargs,
 ) -> CallTreeNode:
     """
@@ -120,7 +118,6 @@ def get_calltree_from_parity_trace(
     node_kwargs: Dict[Any, Any] = dict(
         call_type=root.call_type,
         failed=failed,
-        display_cls=display_cls,
         **root_kwargs,
     )
 

setup.py

@@ -60,7 +60,7 @@
         "eth-utils>=2.0.0",
         "ethpm-types>=0.3.7,<0.4.0",
     ],
-    python_requires=">=3.7.2,<4",
+    python_requires=">=3.8,<4",
     extras_require=extras_require,
     py_modules=["evm_trace"],
     license="Apache-2.0",
@@ -76,7 +76,6 @@
         "Operating System :: MacOS",
         "Operating System :: POSIX",
         "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.7",
         "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",