Add useful context information to the CompilerException class (#493)

* Add useful context information to the CompilerException class

* Fix things

* Be literally less dumb

Author: chrisrink10

src/basilisp/lang/compiler/exception.py

@@ -5,10 +5,20 @@
 
 import basilisp._pyast as ast
 import basilisp.lang.keyword as kw
+import basilisp.lang.map as lmap
 from basilisp.lang.compiler.nodes import Node
-from basilisp.lang.interfaces import ISeq
+from basilisp.lang.interfaces import IExceptionInfo, IMeta, IPersistentMap, ISeq
+from basilisp.lang.obj import lrepr
+from basilisp.lang.reader import READER_COL_KW, READER_LINE_KW
 from basilisp.lang.typing import LispForm
 
+_PHASE = kw.keyword("phase")
+_FORM = kw.keyword("form")
+_LISP_AST = kw.keyword("lisp_ast")
+_PY_AST = kw.keyword("py_ast")
+_LINE = kw.keyword("line")
+_COL = kw.keyword("col")
+
 
 class CompilerPhase(Enum):
     ANALYZING = kw.keyword("analyzing")
@@ -17,10 +27,47 @@ class CompilerPhase(Enum):
     COMPILING_PYTHON = kw.keyword("compiling-python")
 
 
-@attr.s(auto_attribs=True, slots=True)
-class CompilerException(Exception):
+@attr.s(auto_attribs=True, frozen=True, slots=True)
+class _loc:
+    line: Optional[int] = None
+    col: Optional[int] = None
+
+    def __bool__(self):
+        return self.line is not None and self.col is not None
+
+
+@attr.s(auto_attribs=True, slots=True, str=False)
+class CompilerException(IExceptionInfo):
     msg: str
     phase: CompilerPhase
     form: Union[LispForm, None, ISeq] = None
     lisp_ast: Optional[Node] = None
     py_ast: Optional[ast.AST] = None
+
+    @property
+    def data(self) -> IPersistentMap:
+        d = {_PHASE: self.phase.value}
+        loc = None
+        if self.form is not None:
+            d[_FORM] = self.form
+            loc = (
+                _loc(
+                    self.form.meta.val_at(READER_LINE_KW),
+                    self.form.meta.val_at(READER_COL_KW),
+                )
+                if isinstance(self.form, IMeta) and self.form.meta
+                else None
+            )
+        if self.lisp_ast is not None:  # pragma: no cover
+            d[_LISP_AST] = self.lisp_ast
+            loc = loc or _loc(self.lisp_ast.env.line, self.lisp_ast.env.col)
+        if self.py_ast is not None:  # pragma: no cover
+            d[_PY_AST] = self.py_ast
+            loc = loc or _loc(self.py_ast.lineno, self.py_ast.col_offset)
+        if loc:  # pragma: no cover
+            d[_LINE] = loc.line
+            d[_COL] = loc.col
+        return lmap.map(d)
+
+    def __str__(self):
+        return f"{self.msg} {lrepr(self.data)}"

tests/basilisp/cli_test.py

@@ -47,8 +47,9 @@ def test_compiler_error(self):
         result = runner.invoke(cli, ["repl"], input="(fn*)")
         assert (
             "basilisp.lang.compiler.exception.CompilerException: fn form "
-            "must match: (fn* name? [arg*] body*) or (fn* name? method*)\nbasilisp.user=> "
+            "must match: (fn* name? [arg*] body*) or (fn* name? method*)"
         ) in result.stdout
+        assert result.stdout.endswith("\nbasilisp.user=> ")
 
     def test_other_exception(self):
         runner = CliRunner()