Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
9 changes: 8 additions & 1 deletion Doc/howto/remote_debugging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,14 @@ execute Python code remotely.

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

.. note::
Copy link
Copy Markdown
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 :)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Sounds good, added in 52a4439 :)


You can disable remote debugging support in a Python interpreter by (1) setting the
:envvar:`PYTHON_DISABLE_REMOTE_DEBUG` environment variable to any value before
starting the interpreter, (2) using the :option:`-X disable_remote_debug`
command-line option, or (3) compiling Python with the :option:`--without-remote-debug`
build flag.
Comment thread
RafaelWO marked this conversation as resolved.
Outdated

.. _permission-requirements:

Permission requirements
Expand Down Expand Up @@ -614,4 +622,3 @@ To inject and execute a Python script in a remote process:
6. Set ``_PY_EVAL_PLEASE_STOP_BIT`` in the ``eval_breaker`` field.
7. Resume the process (if suspended). The script will execute at the next safe
evaluation point.

Comment thread
picnixz marked this conversation as resolved.
8 changes: 8 additions & 0 deletions Doc/library/sys.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1997,6 +1997,14 @@ always available. Unless explicitly noted otherwise, all variables are read-only
interpreter is pre-release (alpha, beta, or release candidate) then the
local and remote interpreters must be the same exact version.

Comment on lines 1998 to 1999
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

What do you think about adding a reference to the HOWTO here? For example:

See also :ref:`remote-debugging` for information about the remote debugging protocol.

.. note::

You can disable remote debugging support in a Python interpreter by (1) setting
the :envvar:`PYTHON_DISABLE_REMOTE_DEBUG` environment variable to any value before
starting the interpreter, (2) using the :option:`-X disable_remote_debug`
command-line option, or (3) compiling Python with the
:option:`--without-remote-debug` build flag.
Comment thread
RafaelWO marked this conversation as resolved.
Outdated

.. audit-event:: sys.remote_exec pid script_path

When the code is executed in the remote process, an
Expand Down
Loading