Moved describing functionality into an appropriate interface in the parser model

Author: andr-dots

arpeggio/__init__.py

@@ -71,7 +71,7 @@ class NoMatch(Exception):
     """
     def __init__(
         self,
-        rules: typing.Union['ParsingExpression', 'ParserModelDebuggable'],
+        rules: typing.Union['ParsingExpression', 'ParserModelDescribable'],
         position: int,
         parser: 'Parser',
     ):
@@ -183,7 +183,7 @@ def resolve(
         return resolved_node
 
 
-class ParserModelDebuggable(abc.ABC):
+class ParserModelDescribable(abc.ABC):
     """
     A basic interface class for all parser model helper classes.
 
@@ -196,8 +196,16 @@ class ParserModelDebuggable(abc.ABC):
     def name(self):
         pass
 
+    @property
+    def desc(self):
+        self.name
+
+    @property
+    def id(self):
+        return f'{self.name}: {id(self)}'
+
 
-class ParsingStatement(ParserModelItem):
+class ParsingStatement(ParserModelItem, ParserModelDescribable):
     """
     A basic class for all parser model statement classes.
 
@@ -212,7 +220,7 @@ def parse(self, parser: 'Parser') -> typing.Optional['ParseTreeNode']:
         pass
 
 
-class ParsingExpression(ParsingStatement, ParserModelDebuggable):
+class ParsingExpression(ParsingStatement):
     """
     An abstract class for all parsing expressions.
 
@@ -255,6 +263,7 @@ def __init__(self, *elements, **kwargs):
         # positions.
         self._result_cache = {}  # position -> parse tree at the position
 
+    @typing.override
     @property
     def desc(self):
         return "{}{}".format(self.name, "-" if self.suppress else "")
@@ -267,6 +276,7 @@ def name(self):
         else:
             return self.__class__.__name__
 
+    @typing.override
     @property
     def id(self):
         if self.root:
@@ -850,6 +860,7 @@ class Match(ParsingExpression):
     def __init__(self, rule_name, root=False, **kwargs):
         super().__init__(rule_name=rule_name, root=root, **kwargs)
 
+    @typing.override
     @property
     def name(self):
         if self.root:
@@ -1126,8 +1137,9 @@ def parse(self, parser: 'Parser') -> typing.Optional['ParseTreeNode']:
     def __str__(self):
         return '@' + self.state_name
 
+    @typing.override
     @property
-    def desc(self):
+    def name(self):
         return "@{}".format(
             self.state_name,
         )
@@ -1146,8 +1158,9 @@ def parse(self, parser: 'Parser') -> typing.Optional['ParseTreeNode']:
     def __str__(self):
         return '+@' + self.state_name
 
+    @typing.override
     @property
-    def desc(self):
+    def name(self):
         return "+@{}".format(
             self.state_name,
         )
@@ -1176,8 +1189,9 @@ def parse(self, parser: 'Parser') -> typing.Optional['ParseTreeNode']:
     def __str__(self):
         return '-@' + self.state_name
 
+    @typing.override
     @property
-    def desc(self):
+    def name(self):
         return "-@{}".format(
             self.state_name,
         )
@@ -1216,6 +1230,7 @@ class EndOfFile(Match):
     def __init__(self):
         super().__init__("EOF")
 
+    @typing.override
     @property
     def name(self):
         return "EOF"
@@ -1268,6 +1283,7 @@ def __init__(self, rule, position, error):
         self.error = error
         self.comments = None
 
+    @typing.override
     @property
     def name(self):
         return f"{self.rule_name} [{self.position}]"
@@ -1342,6 +1358,7 @@ def __init__(self, rule, position, value, error=False, suppress=False,
         self.suppress = suppress
         self.extra_info = extra_info
 
+    @typing.override
     @property
     def desc(self):
         if self.value:
@@ -1404,6 +1421,7 @@ def value(self):
         """Terminal protocol."""
         return str(self)
 
+    @typing.override
     @property
     def desc(self):
         return self.name

arpeggio/export.py

@@ -114,7 +114,7 @@ def neighbours(self):
 
 class PMDOTExportAdapter(DOTExportAdapter):
     """
-    Adapter for ParsingExpression graph types (parser model).
+    Adapter for ParsingStatement graph types (parser model).
     """
     @property
     def id(self):

arpeggio/peg.py

@@ -33,7 +33,7 @@
     ParserStateLayer,
     ParserRepetitionStateLayer,
     Parser,
-    ParserModelDebuggable,
+    ParserModelDescribable,
     ParserPython,
     ParseTreeNode,
     PTNodeVisitor,
@@ -236,7 +236,7 @@ class LayerScope(enum.Enum):
     CURRENT = -1
 
 
-class MatchedAction(ParserModelDebuggable):
+class MatchedAction(ParserModelDescribable):
     """
     An abstract class for all action classes used in MatchActions parsing rules.
     """
@@ -282,6 +282,7 @@ def run(
     def __str__(self):
         return f'{str(self._rule)}{{{' '.join(map(str, self._args))}}}'
 
+    @typing.override
     @property
     def name(self):
         if self._command_hint:
@@ -680,6 +681,7 @@ def __str__(self):
         rule_node = self.nodes[0]
         return str(rule_node)
 
+    @typing.override
     @property
     def desc(self):
         return "{}{{{}}}{}".format(