fix[ux]: add missing filename to syntax exceptions

tests/functional/syntax/exceptions/test_vyper_exception_pos.py

@@ -1,6 +1,7 @@
 from pytest import raises
 
-from vyper.exceptions import VyperException
+from vyper import compile_code
+from vyper.exceptions import SyntaxException, VyperException
 
 
 def test_type_exception_pos():
@@ -29,3 +30,32 @@ def __init__():
 
     """
     assert_compile_failed(lambda: get_contract(code), VyperException)
+
+
+def test_exception_contains_file(make_input_bundle):
+    code = """
+def bar()>:
+    """
+    input_bundle = make_input_bundle({"code.vy": code})
+    with raises(SyntaxException, match="contract"):
+        compile_code(code, input_bundle=input_bundle)
+
+
+def test_exception_reports_correct_file(make_input_bundle, chdir_tmp_path):
+    code_a = "def bar()>:"
+    code_b = "import A"
+    input_bundle = make_input_bundle({"A.vy": code_a, "B.vy": code_b})
+
+    with raises(SyntaxException, match=r'contract "A\.vy:\d+"'):
+        compile_code(code_b, input_bundle=input_bundle)
+
+
+def test_syntax_exception_reports_correct_offset(make_input_bundle):
+    code = """
+def foo():
+    uint256 a = pass
+    """
+    input_bundle = make_input_bundle({"code.vy": code})
+
+    with raises(SyntaxException, match="line \d+:12"):
+        compile_code(code, input_bundle=input_bundle)

tests/unit/ast/test_natspec.py

@@ -436,3 +436,19 @@ def test_natspec_parsed_implicitly():
     # anything beyond ast is blocked
     with pytest.raises(NatSpecSyntaxException):
         compile_code(code, output_formats=["annotated_ast_dict"])
+
+
+def test_natspec_exception_contains_file_path():
+    code = """
+@external
+def foo() -> (int128,uint256):
+    '''
+    @return int128
+    @return uint256
+    @return this should fail
+    '''
+    return 1, 2
+    """
+
+    with pytest.raises(NatSpecSyntaxException, match=r'contract "VyperContract\.vy:\d+"'):
+        parse_natspec(code)

tests/unit/ast/test_pre_parser.py

@@ -1,3 +1,5 @@
+from pathlib import Path
+
 import pytest
 
 from vyper import compile_code
@@ -56,6 +58,24 @@ def test_invalid_version_pragma(file_version, mock_version):
         validate_version_pragma(f"{file_version}", file_version, (SRC_LINE))
 
 
+def test_invalid_version_contains_file(mock_version):
+    mock_version(COMPILER_VERSION)
+    with pytest.raises(VersionException, match=r'contract "mock\.vy:\d+"'):
+        compile_code("# pragma version ^0.3.10", resolved_path=Path("mock.vy"))
+
+
+def test_imported_invalid_version_contains_correct_file(
+    mock_version, make_input_bundle, chdir_tmp_path
+):
+    code_a = "# pragma version ^0.3.10"
+    code_b = "import A"
+    input_bundle = make_input_bundle({"A.vy": code_a, "B.vy": code_b})
+    mock_version(COMPILER_VERSION)
+
+    with pytest.raises(VersionException, match=r'contract "A\.vy:\d+"'):
+        compile_code(code_b, input_bundle=input_bundle)
+
+
 prerelease_valid_versions = [
     "<0.1.1-beta.9",
     "<0.1.1b9",

tests/unit/cli/vyper_json/test_compile_json.py

@@ -238,7 +238,7 @@ def test_wrong_language():
 
 def test_exc_handler_raises_syntax(input_json):
     input_json["sources"]["badcode.vy"] = {"content": BAD_SYNTAX_CODE}
-    with pytest.raises(SyntaxException):
+    with pytest.raises(SyntaxException, match=r'contract "badcode\.vy:\d+"'):
         compile_json(input_json)
 
 

vyper/ast/natspec.py

@@ -19,6 +19,14 @@ class NatspecOutput:
 
 
 def parse_natspec(annotated_vyper_module: vy_ast.Module) -> NatspecOutput:
+    try:
+        return _parse_natspec(annotated_vyper_module)
+    except NatSpecSyntaxException as e:
+        e.path = annotated_vyper_module.resolved_path
+        raise e
+
+
+def _parse_natspec(annotated_vyper_module: vy_ast.Module) -> NatspecOutput:
     """
     Parses NatSpec documentation from a contract.
 

vyper/ast/parse.py

@@ -23,6 +23,22 @@ def parse_to_ast_with_settings(
     module_path: Optional[str] = None,
     resolved_path: Optional[str] = None,
     add_fn_node: Optional[str] = None,
+) -> tuple[Settings, vy_ast.Module]:
+    try:
+        return _parse_to_ast_with_settings(
+            vyper_source, source_id, module_path, resolved_path, add_fn_node
+        )
+    except SyntaxException as e:
+        e.path = resolved_path
+        raise e
+
+
+def _parse_to_ast_with_settings(
+    vyper_source: str,
+    source_id: int = 0,
+    module_path: Optional[str] = None,
+    resolved_path: Optional[str] = None,
+    add_fn_node: Optional[str] = None,
 ) -> tuple[Settings, vy_ast.Module]:
     """
     Parses a Vyper source string and generates basic Vyper AST nodes.
@@ -60,7 +76,8 @@ def parse_to_ast_with_settings(
         py_ast = python_ast.parse(pre_parser.reformatted_code)
     except SyntaxError as e:
         # TODO: Ensure 1-to-1 match of source_code:reformatted_code SyntaxErrors
-        raise SyntaxException(str(e), vyper_source, e.lineno, e.offset) from None
+        # SyntaxError offset is 1-based, not 0-based
+        raise SyntaxException(str(e.msg), vyper_source, e.lineno, e.offset - 1) from None
 
     # Add dummy function node to ensure local variables are treated as `AnnAssign`
     # instead of state variables (`VariableDecl`)

vyper/exceptions.py

@@ -54,6 +54,7 @@ def __init__(self, message="Error Message not found.", *items, hint=None, prev_d
         self.lineno = None
         self.col_offset = None
         self.annotations = None
+        self.path = None
 
         if len(items) == 1 and isinstance(items[0], tuple) and isinstance(items[0][0], int):
             # support older exceptions that don't annotate - remove this in the future!
@@ -127,13 +128,18 @@ def format_annotation(self, value):
             module_node = node.module_node
 
             # TODO: handle cases where module is None or vy_ast.Module
-            if module_node.get("path") not in (None, "<unknown>"):
-                node_msg = f'{node_msg}contract "{module_node.path}:{node.lineno}", '
+            if module_node.get("resolved_path") not in (None, "<unknown>"):
+                node_msg = self._format_contract_details(
+                    node_msg, module_node.resolved_path, node.lineno
+                )
 
             fn_node = node.get_ancestor(vy_ast.FunctionDef)
             if fn_node:
                 node_msg = f'{node_msg}function "{fn_node.name}", '
 
+        elif self.path is not None:
+            node_msg = self._format_contract_details(node_msg, self.path, node.lineno)
+
         col_offset_str = "" if node.col_offset is None else str(node.col_offset)
         node_msg = f"{node_msg}line {node.lineno}:{col_offset_str} \n{source_annotation}\n"
 
@@ -151,6 +157,11 @@ def _add_hint(self, msg):
             return msg
         return msg + f"\n  (hint: {self.hint})"
 
+    def _format_contract_details(self, msg, path, lineno):
+        from vyper.utils import safe_relpath
+
+        return f'{msg}contract "{safe_relpath(path)}:{lineno}", '
+
     def __str__(self):
         return self._add_hint(self._str_helper())