Merge pull request #106 from Ritsuka314/fix-issue-73

fix #73: correct line number in CompilationError message

Author: Ritsuka314

src/pydsl/compiler.py

@@ -70,25 +70,32 @@ class Source:
     embeded: bool
     filepath: typing.Optional[Path] = None
     embedee_filepath: typing.Optional[Path] = None
+    lineno: typing.Optional[int] = None
 
-    def init_embeded(src_str: str, filepath: Path, src_ast=None) -> "Source":
+    def init_embeded(
+        src_str: str, filepath: Path, src_ast=None, lineno=None
+    ) -> "Source":
         src_ast = src_ast if src_ast is not None else ast.parse(src_str)
         return Source(
             src_str,
             src_ast,
             embeded=True,
             filepath=None,
             embedee_filepath=filepath,
+            lineno=lineno,
         )
 
-    def init_file(src_str: str, filepath: Path, src_ast=None) -> "Source":
+    def init_file(
+        src_str: str, filepath: Path, src_ast=None, lineno=None
+    ) -> "Source":
         src_ast = src_ast if src_ast is not None else ast.parse(src_str)
         return Source(
             src_str,
             src_ast,
             embeded=False,
             filepath=filepath,
             embedee_filepath=None,
+            lineno=lineno,
         )
 
     @property
@@ -167,15 +174,16 @@ def programmer_message(self):
             else ""
         )
 
+        base_lineno = 0
         if self.src is not None:
             file_descriptor = f"{self.src.path}"
-            if self.src.embeded:
-                file_descriptor = f"<embed in {file_descriptor}>"
+            if self.src.lineno is not None:
+                base_lineno = self.src.lineno
         else:
             file_descriptor = "<unknown>"
 
         if hasattr(self.node, "lineno"):
-            line_descriptor = str(self.node.lineno)
+            line_descriptor = str(self.node.lineno + base_lineno)
         else:
             line_descriptor = "<unknown>"
 

src/pydsl/frontend.py

@@ -1307,11 +1307,16 @@ def src_ast(self) -> AST:
     def filepath(self) -> Path:
         return Path(inspect.getsourcefile(self._o))
 
+    @property
+    def lineno(self) -> int:
+        return inspect.getsourcelines(self._o)[1]
+
     @cache
     def get_src(self) -> Source:
         return Source.init_embeded(
             src_str=self.src_str,
             filepath=self.filepath,
+            lineno=self.lineno,
         )
 
     def emit_mlir(self) -> str:
@@ -1431,6 +1436,7 @@ def get_src(self) -> Source:
             src_str=self.src_str,
             src_ast=self.src_ast,
             filepath=self.filepath,
+            lineno=self.lineno,
         )
 
     def finalize(self) -> None:

tests/e2e/test_error_msg.py

@@ -0,0 +1,37 @@
+from pydsl.compiler import CompilationError
+from pydsl.frontend import compile
+from helper import run
+
+import os
+import inspect
+
+
+def test_error_msg():
+    try:
+
+        @compile()
+        def f():
+            return a
+
+    except CompilationError as e:
+        current_line = inspect.currentframe().f_lineno
+        # the number 2 is the relative position
+        # between inspect.currentframe() and the line `return a`
+        error_line = current_line - 3
+
+        current_file_path = os.path.abspath(__file__)
+
+        expected_msg = f'File "{current_file_path}", line {error_line}'
+
+        assert e.programmer_message().startswith(expected_msg), (
+            f"expect error message:\n"
+            f"{expected_msg}\n"
+            f"got\n"
+            f"{e.programmer_message()}"
+        )
+    else:
+        assert False, f"expected CompilationError, but no error was raised"
+
+
+if __name__ == "__main__":
+    run(test_error_msg)