Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make the Debugger a singleton and do not reset the stopframe to None during postmortem. #667

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Make the Debugger a singleton and do not reset the stopframe to None during postmortem. #667

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5a3993e
Make the Debugger a singleton and do not reset the stopframe to None …
hwalinga Nov 29, 2024
9f1a22a
Have more precise control on when to no reset the stopframe.
hwalinga Nov 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 39 additions & 4 deletions pudb/debugger.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,15 +183,24 @@

# {{{ debugger interface

class Debugger(bdb.Bdb):
class Singleton(type):
_instance = None

def __call__(cls, *args, **kwargs):
if not cls._instance:
cls._instance = super(Singleton, cls).__call__(*args, **kwargs)
else:
cls._pytest_postmortem = True
return cls._instance


class Debugger(bdb.Bdb, metaclass=Singleton):
_current_debugger = []
_pytest_postmortem = False

def __init__(self, stdin=None, stdout=None, term_size=None, steal_output=False,
_continue_at_start=False, tty_file=None, **kwargs):

if Debugger._current_debugger:
raise ValueError("a Debugger instance already exists")

# Pass remaining kwargs to python debugger framework
bdb.Bdb.__init__(self, **kwargs)
self.ui = DebuggerUI(self, stdin=stdin, stdout=stdout, term_size=term_size)
Expand All @@ -214,6 +223,32 @@ def __init__(self, stdin=None, stdout=None, term_size=None, steal_output=False,
# Okay, now we have a debugger
self._current_debugger.append(self)
Comment on lines 223 to 224
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we get rid of _current_debugger in favor of the singleton mechanism?


def reset(self):
"""Set values of attributes as ready to start debugging.

Override from Bdb.reset()

When pytest starts a postmortem analysis, but the debugger is already active,
calling .reset() in src/_pytest/debugging.py::post_mortem
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add Github link to specific version?

causes the self.stopframe to be set to None.
This pauses the debugger somewhere in the source code of the debugger. See #67

We detect using _pytest_postmortem that this is the case and do not set the
stopframe to None then.

Related #607, #52
"""
import linecache
linecache.checkcache()
self.botframe = None
if not self._pytest_postmortem:
self.stopframe = None
else:
self._pytest_postmortem = False
self.returnframe = None
self.quitting = False
self.stoplineno = 0
Comment on lines +241 to +250
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be possible to call into Bdb.reset for some of this? We're already copy-pasting too much of Bdb's guts into pudb... (If not, add a comment why not.)


def __del__(self):
# according to https://stackoverflow.com/a/1481512/1054322, the garbage
# collector cannot be relied on to call this, so we call it explicitly
Expand Down
Loading