Skip to content

Conversation

@RafaelWO
Copy link
Contributor

@RafaelWO RafaelWO commented Jan 18, 2026

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.


📚 Documentation preview 📚:

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.
RafaelWO and others added 2 commits January 19, 2026 10:04
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>
@hugovk
Copy link
Member

hugovk commented Jan 19, 2026

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 sys page, perhaps it could also be regular text at the end of function description (just before "Availability: Unix, Windows").


Most platforms require elevated privileges to attach to another Python process.

.. note::
Copy link
Member

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.
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting review docs Documentation in the Doc dir skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

5 participants