Merge pull request #1007 from rchiodo/rchiodo/allow_adapter_debugging

Add DEBUGPY_TRACE_DEBUGPY variable to allow debugpy to debug itself

Author: rchiodo

src/debugpy/common/log.py

@@ -58,7 +58,7 @@ def __init__(self, filename, file, levels=LEVELS, close_file=True):
                 platform.machine(),
                 platform.python_implementation(),
                 platform.python_version(),
-                64 if sys.maxsize > 2**32 else 32,
+                64 if sys.maxsize > 2 ** 32 else 32,
                 debugpy.__version__,
                 _to_files=[self],
             )

src/debugpy/common/messaging.py

@@ -21,6 +21,7 @@
 import threading
 
 from debugpy.common import json, log, util
+from debugpy.common.util import hide_thread_from_debugger
 
 
 class JsonIOError(IOError):
@@ -1148,8 +1149,8 @@ def start(self):
         self._parser_thread = threading.Thread(
             target=self._parse_incoming_messages, name=f"{self} message parser"
         )
-        self._parser_thread.pydev_do_not_trace = True
-        self._parser_thread.is_pydev_daemon_thread = True
+
+        hide_thread_from_debugger(self._parser_thread)
         self._parser_thread.daemon = True
         self._parser_thread.start()
 

src/debugpy/common/sockets.py

@@ -7,6 +7,7 @@
 import threading
 
 from debugpy.common import log
+from debugpy.common.util import hide_thread_from_debugger
 
 
 def create_server(host, port=0, backlog=socket.SOMAXCONN, timeout=None):
@@ -115,8 +116,7 @@ def accept_worker():
 
     thread = threading.Thread(target=accept_worker)
     thread.daemon = True
-    thread.pydev_do_not_trace = True
-    thread.is_pydev_daemon_thread = True
+    hide_thread_from_debugger(thread)
     thread.start()
 
     return listener

src/debugpy/common/util.py

@@ -148,3 +148,17 @@ def srcnameof(obj):
         name += ")"
 
     return name
+
+
+def hide_debugpy_internals():
+    """Returns True if the caller should hide something from debugpy."""
+    return "DEBUGPY_TRACE_DEBUGPY" not in os.environ
+
+
+def hide_thread_from_debugger(thread):
+    """Disables tracing for the given thread if DEBUGPY_TRACE_DEBUGPY is not set.
+    DEBUGPY_TRACE_DEBUGPY is used to debug debugpy with debugpy
+    """
+    if hide_debugpy_internals():
+        thread.pydev_do_not_trace = True
+        thread.is_pydev_daemon_thread = True

src/debugpy/server/api.py

@@ -14,7 +14,7 @@
 from debugpy.common import json, log, sockets
 from _pydevd_bundle.pydevd_constants import get_global_debugger
 from pydevd_file_utils import absolute_path
-
+from debugpy.common.util import hide_debugpy_internals
 
 _tls = threading.local()
 
@@ -129,9 +129,10 @@ def debug(address, **kwargs):
             "patch_multiprocessing": _config.get("subProcess", True),
         }
 
-        debugpy_path = os.path.dirname(absolute_path(debugpy.__file__))
-        settrace_kwargs["dont_trace_start_patterns"] = (debugpy_path,)
-        settrace_kwargs["dont_trace_end_patterns"] = (str("debugpy_launcher.py"),)
+        if hide_debugpy_internals():
+            debugpy_path = os.path.dirname(absolute_path(debugpy.__file__))
+            settrace_kwargs["dont_trace_start_patterns"] = (debugpy_path,)
+            settrace_kwargs["dont_trace_end_patterns"] = (str("debugpy_launcher.py"),)
 
         try:
             return func(address, settrace_kwargs, **kwargs)

src/debugpy/server/cli.py

@@ -109,7 +109,7 @@ def do(arg, it):
             port = int(port)
         except Exception:
             port = -1
-        if not (0 <= port < 2**16):
+        if not (0 <= port < 2 ** 16):
             raise ValueError("invalid port number")
 
         options.mode = mode