bugsnag-python icon indicating copy to clipboard operation
bugsnag-python copied to clipboard

stack_data, executing, and pure_eval

Open alexmojaki opened this issue 4 years ago • 5 comments

Hi! I've recently created a few libraries that are helpful for extracting information from frames and tracebacks, and I think they could be very useful to bugsnag.

  • executing can identify the exact AST node being executed by a frame in many cases. It's always disappointed me that Python only points to a line in each frame in tracebacks, especially when the expression/statement at fault spans many lines. Sometimes it can be really hard to interpret. Currently executing is used in IPython (in master, unreleased) to highlight the node, here's what it looks like:

ipython

  • executing can also infer a function __qualname__ from a code object, meaning your traceback can say lorem/ipsum.py in MyClass.__init__ at line 123 instead of just __init__, which is much more informative.
  • pure_eval can safely evaluate certain AST nodes without side effects, so that if the source for a frame contains expressions like self.foo and bar[key] their values can often be shown alongside plain variables.
  • stack_data collects data from tracebacks for the purpose of formatting and displaying them. It uses executing and pure_eval and also provides a lot of functionality of its own. I integratedstack_data into IPython which allowed removing a lot of flaky custom introspection code, fixing several bugs and making the code more maintainable.
  • stack_data identifies the locations of variables and evaluated expressions in the source lines. An intelligent UI could use this, for example, to allow the user to hover over a variable in source code to see its value rather than scroll through a list to find it.

I'll be honest, I've never used bugsnag before (in fact I only just learned about it) so I don't know exactly what would make sense. But I made a similar issue on sentry (https://github.com/getsentry/sentry-python/issues/748) and integrated a couple of these features in there and they seemed pretty happy, particularly with pure_eval. Seeing as you guys are an alternative to sentry, I thought it made sense to give you a heads up. I don't actually have time to integrate these myself, but I'd be happy to help with any questions you have.

alexmojaki avatar Jan 01 '21 15:01 alexmojaki

Hey @alexmojaki

Thanks for highlighting these libraries to us! We plan to take a look and see what we can make best use of.

Thanks again!

mattdyoung avatar Jan 07 '21 10:01 mattdyoung

Any progress on this? I think this would be a fantastic improvement.

chhabrakadabra avatar Mar 15 '22 13:03 chhabrakadabra

hey @chhabrakadabra - we're still tracking this internally and plan to take a look when priorities allow. We'll update this thread as soon as we have any more info 👍

luke-belton avatar Mar 16 '22 12:03 luke-belton

Anything outside people could contribute?

GuillaumeCrowdcomfort avatar Oct 07 '22 17:10 GuillaumeCrowdcomfort

Hi @GuillaumeCrowdcomfort - did you have anything specific in mind in terms of what you'd wish to contribute here?

luke-belton avatar Oct 18 '22 10:10 luke-belton