Always set debugger to true in kernelspec #1191
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ianthomas23
force-pushed
the
kernelspec_debugger_true
branch
from
b2f7ab5
to
aca31d3
Compare
krassowski
reviewed
Feb 14, 2024
| @@ -66,7 +66,7 @@ def get_kernel_dict(extra_arguments: list[str] | None = None) -> dict[str, Any]: | |||
| "argv": make_ipkernel_cmd(extra_arguments=extra_arguments), | |||
| "display_name": "Python %i (ipykernel)" % sys.version_info[0], | |||
| "language": "python", | |||
| "metadata": {"debugger": _is_debugpy_available}, | |||
There was a problem hiding this comment.
I think _is_debugpy_available import/definition should have been removed as well?
There was a problem hiding this comment.
(I will include cleanup in a PR)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently the boolean
debuggerflag in the kernelspec file is determined at build time depending upon whetherdebugpyis installed or not. I think it should always beTrue, on the basis thatipykernelsupports a debugger in principle and the details of the available debugging are determined at runtime.This change has no effect on PyPI wheels or conda packages as the flag is always
Truein those, it only affects building from source. Becausedebugpyis a compulsory dependency in thepyproject.tomlthe flag is alwaysTrueexcept when doing an editable install with build isolation (pip install -e .) in which case it isFalse. This is the recommended approach for installing from source specified in theREADME.md, and is how I came across this problem.I have also updated
test_debugger.py. There is a CI run that explicitly doesn't havedebugpyinstalled and runstest_debugger.py, but unfortunately in this situation all the tests in that file are skipped. So this CI run only really tests that there is no debugger-related functionality in any of the other test files. I have changedtest_debugger.pyso that all tests are run regardless of whetherdebugpyis installed or not, and theasserts are different in each situation. Often withoutdebugpyinstalled the tests don't do anything particularly interesting, but they do confirm thatipykerneldoesn't block, or segfault, or raise an error in the non-debugpysituation.The
test_debugger.pytests are a little less readable now because of the newifstatements. An alternative approach would be to keeptest_debugger.pyas it is and add a newtest_not_debugger.pyfile.