core: surface original error when raising verification error

[superlopuh]

No description provided.

[codecov]

Codecov Report

Patch coverage: 100.00% and project coverage change: +0.10 🎉

Comparison is base (740c1dd) 88.65% compared to head (09f1aaf) 88.75%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1192      +/-   ##
==========================================
+ Coverage   88.65%   88.75%   +0.10%     
==========================================
  Files         160      161       +1     
  Lines       22464    22455       -9     
  Branches     3393     3409      +16     
==========================================
+ Hits        19916    19931      +15     
+ Misses       2004     1981      -23     
+ Partials      544      543       -1     

Impacted Files	Coverage Δ
xdsl/ir/core.py	88.37% <100.00%> (ø)
xdsl/utils/diagnostic.py	84.00% <100.00%> (ø)

... and 7 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[webmiche]

Can you add a test showing what this does exactly? Looks like a good idea o/w 👍

[superlopuh]

I had a look into writing the test, and it's a bit hard to do. The main difference is in the python output, you get two stack traces, one leading to the underlying error, and one from the newly raised verification error.

[webmiche]

Yes, that's what I expected. I guess one way of doing that would be spawning a subprocess and getting its output. Or maybe something with ast.eval? 🤔

Not sure we want either of those in the codebase though. Do you have something nice/small that I can jsut run locally to see the change?

[math-fehr]

Nice!

[superlopuh]

>>> b = TestOp(operands=((),), result_types=((),), regions=((Return(),),))
>>> b.verify()
Traceback (most recent call last):
  File "/Users/sasha/Developer/xdslproject/xdsl/xdsl/ir/core.py", line 816, in verify
    self.verify_()
  File "/Users/sasha/Developer/xdslproject/xdsl/xdsl/irdl.py", line 1784, in verify_
    op_def.verify(self)
  File "/Users/sasha/Developer/xdslproject/xdsl/xdsl/irdl.py", line 1179, in verify
    trait.verify(op)
  File "/Users/sasha/Developer/xdslproject/xdsl/xdsl/traits.py", line 59, in verify
    raise VerifyException(
xdsl.utils.exceptions.VerifyException: 'func.return' expects parent op 'func.func'

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/Users/sasha/Developer/xdslproject/xdsl/xdsl/ir/core.py", line 812, in verify
    region.verify()
  File "/Users/sasha/Developer/xdslproject/xdsl/xdsl/ir/core.py", line 1690, in verify
    block.verify()
  File "/Users/sasha/Developer/xdslproject/xdsl/xdsl/ir/core.py", line 1392, in verify
    operation.verify()
  File "/Users/sasha/Developer/xdslproject/xdsl/xdsl/ir/core.py", line 818, in verify
    self.emit_error(
  File "/Users/sasha/Developer/xdslproject/xdsl/xdsl/ir/core.py", line 989, in emit_error
    diagnostic.raise_exception(message, self, exception_type, underlying_error)
  File "/Users/sasha/Developer/xdslproject/xdsl/xdsl/utils/diagnostic.py", line 42, in raise_exception
    raise exception_type(message + "\n\n" + f.getvalue()) from underlying_error
xdsl.utils.exceptions.VerifyException: Operation does not verify: 'func.return' expects parent op 'func.func'

"test.op"() ({
  "func.return"() : () -> ()
  ^^^^^^^^^^^^^-----------------------------------------------------------
  | Operation does not verify: 'func.return' expects parent op 'func.func'
  ------------------------------------------------------------------------
}) : () -> ()


>>> 

[superlopuh]

As of right now, main only returns the second error and call stack, which is less useful

[webmiche]

Okay, thanks 👍