-
-
Notifications
You must be signed in to change notification settings - Fork 33.9k
gh-143993: Document ways to disable remote debugging support #143994
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.
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
base: main
Are you sure you want to change the base?
Conversation
Although PEP 768 mentions how to disable the mechanism of remote debugging, it is not documented in the Python docs. This change adds a note on how to disable remote debugging support in a Python interpreter to the remote debugging how-to and to the sys.remote_exec docs.
In remote_rebugging.rst Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
in sys.rst Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
|
Thanks for the PR! It's a good idea to document these three methods together. @pablogsal What do you think about the placement and prominence of these?
Maybe they don't need to be highlighted in a note admonition and could be regular text? In the HOWTO, it could perhaps to its own section with a header, which will make it easier to share. In the |
|
|
||
| Most platforms require elevated privileges to attach to another Python process. | ||
|
|
||
| .. note:: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This probably deserves its own little section that appears in the sidebar :)
| To disable remote debugging support, use any of the following: | ||
|
|
||
| * Set the :envvar:`PYTHON_DISABLE_REMOTE_DEBUG` environment variable to | ||
| any value before starting the interpreter. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would prefer suggesting a specific value such as 1.
Although PEP 768 mentions how to disable the mechanism of remote debugging, it is not documented in the Python docs.
This change adds a note on how to disable remote debugging support in a Python interpreter to the remote debugging how-to and to the
sys.remote_execdocs.📚 Documentation preview 📚: