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 debugger class configurable #1307

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

make debugger class configurable #1307

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
617100c
make debugger class configurable
smacke Dec 13, 2024
b18b069
address comments
smacke Dec 14, 2024
090522d
make compiler class configurable too
smacke Dec 15, 2024
6bd5782
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 15, 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
7 changes: 4 additions & 3 deletions ipykernel/ipkernel.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
from .comm.comm import BaseComm
from .comm.manager import CommManager
from .compiler import XCachingCompiler
from .debugger import Debugger, _is_debugpy_available
from .eventloops import _use_appnope
from .iostream import OutStream
from .kernelbase import Kernel as KernelBase
Expand Down Expand Up @@ -71,6 +72,8 @@ class IPythonKernel(KernelBase):
shell = Instance("IPython.core.interactiveshell.InteractiveShellABC", allow_none=True)
shell_class = Type(ZMQInteractiveShell)

debugger_class = Type(Debugger)
Copy link
Member

@jasongrout jasongrout Dec 13, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

You can also give this class as a full-specified dotted string (like in the shell instance above), so we could move the import above back to being an on-demand import in the class definition.

Copy link
Member

Choose a reason for hiding this comment

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

I think this should work:

Suggested change
debugger_class = Type(Debugger)
debugger_class = Type("ipykernel.debugger.Debugger")

Copy link
Author

@smacke smacke Dec 14, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Thanks for the suggestion; I think if I do this I can omit the import altogether?

EDIT: for Debugger, but not for _is_debugpy_available I guess


use_experimental_completions = Bool(
True,
help="Set this flag to False to deactivate the use of experimental IPython completion APIs.",
Expand Down Expand Up @@ -110,11 +113,9 @@ def __init__(self, **kwargs):

self.executing_blocking_code_in_main_shell = False

from .debugger import Debugger, _is_debugpy_available
Copy link
Member

Choose a reason for hiding this comment

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

It looks like #1223 intentionally introduced this lazy import. Let's make sure we're addressing the need there as well before making this an eager import at the top of the file.

Copy link
Member

Choose a reason for hiding this comment

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

In particular, does this change mean that python -m ipykernel install --sys-prefix has spurious warnings?

Copy link
Member

@jasongrout jasongrout Dec 13, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

CC @krassowski who made this lazy import change earlier this year.

Copy link
Member

Choose a reason for hiding this comment

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

Thanks for spotting, yes this is intentional to address #1198


# Initialize the Debugger
if _is_debugpy_available:
self.debugger = Debugger(
self.debugger = self.debugger_class(
self.log,
self.debugpy_socket,
self._publish_debug_event,
Expand Down
Loading