debugpy 1.8.1__zip → 1.8.3__zip

{debugpy-1.8.1 → debugpy-1.8.3}/src/debugpy/public_api.py

@@ -38,7 +38,7 @@ def _api(cancelable=False):
                 wrapped = getattr(api, f.__name__)
                 return wrapped.cancel(*args, **kwargs)
 
-            wrapper.cancel = cancel
+            wrapper.cancel = cancel # pyright: ignore
 
         return wrapper
 
@@ -46,7 +46,7 @@ def _api(cancelable=False):
 
 
 @_api()
-def log_to(__path: str) -> None:
+def log_to(__path: str | typing.TextIO) -> None:
     """Generate detailed debugpy logs in the specified directory.
 
     The directory must already exist. Several log files are generated,
@@ -117,7 +117,7 @@ def listen(
     adapter that it starts. Use `wait_for_client` to block execution
     until the client connects.
     """
-
+    ...
 
 @_api()
 def connect(__endpoint: Endpoint | int, *, access_token: str | None = None) -> Endpoint:
@@ -135,7 +135,7 @@ def connect(__endpoint: Endpoint | int, *, access_token: str | None = None) -> E
     adapter that it connects to. Use `wait_for_client` to block
     execution until the client connects.
     """
-
+    ...
 
 @_api(cancelable=True)
 def wait_for_client() -> None:
@@ -153,6 +153,7 @@ def is_client_connected() -> bool:
     """True if a client is connected to the debug adapter that is
     debugging this process.
     """
+    ...
 
 
 @_api()

{debugpy-1.8.1 → debugpy-1.8.3}/src/debugpy/server/cli.py

@@ -7,6 +7,7 @@ import os
 import re
 import sys
 from importlib.util import find_spec
+from typing import Any, Union, Tuple, Dict
 
 # debugpy.__main__ should have preloaded pydevd properly before importing this module.
 # Otherwise, some stdlib modules above might have had imported threading before pydevd
@@ -18,6 +19,7 @@ import pydevd
 from _pydevd_bundle import pydevd_runpy as runpy
 
 import debugpy
+import debugpy.server
 from debugpy.common import log
 from debugpy.server import api
 
@@ -41,13 +43,14 @@ Usage: debugpy --listen | --connect
 
 class Options(object):
     mode = None
-    address = None
+    address: Union[Tuple[str, int], None] = None
     log_to = None
     log_to_stderr = False
-    target = None
-    target_kind = None
+    target: Union[str, None] = None
+    target_kind: Union[str, None] = None
     wait_for_client = False
     adapter_access_token = None
+    config: Dict[str, Any] = {}
 
 
 options = Options()
@@ -139,7 +142,7 @@ def set_config(arg, it):
     options.config[name] = value
 
 
-def set_target(kind, parser=(lambda x: x), positional=False):
+def set_target(kind: str, parser=(lambda x: x), positional=False):
     def do(arg, it):
         options.target_kind = kind
         target = parser(arg if positional else next(it))
@@ -155,6 +158,7 @@ def set_target(kind, parser=(lambda x: x), positional=False):
                     import locale
 
                     target = target.decode(locale.getpreferredencoding(False))
+
         options.target = target
 
     return do
@@ -187,23 +191,68 @@ switches = [
 ]
 # fmt: on
 
-
+# Consume all the args from argv
 def consume_argv():
     while len(sys.argv) >= 2:
         value = sys.argv[1]
         del sys.argv[1]
         yield value
 
+# Consume all the args from a given list
+def consume_args(args: list):
+    if (args is sys.argv):
+        yield from consume_argv()
+    else:
+        while args:
+            value = args[0]
+            del args[0]
+            yield value
 
-def parse_argv():
+# Parse the args from the command line, then from the environment.
+# Args from the environment are only used if they are not already set from the command line.
+def parse_args():
+
+    # keep track of the switches we've seen so far
     seen = set()
-    it = consume_argv()
+
+    parse_args_from_command_line(seen)
+    parse_args_from_environment(seen)
+
+    # if the target is not set, or is empty, this is an error
+    if options.target is None or options.target == "":
+        raise ValueError("missing target: " + TARGET)
+
+    if options.mode is None:
+        raise ValueError("either --listen or --connect is required")
+    if options.adapter_access_token is not None and options.mode != "connect":
+        raise ValueError("--adapter-access-token requires --connect")
+    if options.target_kind == "pid" and options.wait_for_client:
+        raise ValueError("--pid does not support --wait-for-client")
+
+    assert options.target_kind is not None
+    assert options.address is not None
+
+def parse_args_from_command_line(seen: set):
+    parse_args_helper(sys.argv, seen)
+
+def parse_args_from_environment(seenFromCommandLine: set):
+    args = os.environ.get("DEBUGPY_EXTRA_ARGV")
+    if (not args):
+        return
+
+    argsList = args.split()
+
+    seenFromEnvironment = set()
+    parse_args_helper(argsList, seenFromCommandLine, seenFromEnvironment, True)
+
+def parse_args_helper(args: list, seenFromCommandLine: set, seenFromEnvironment: set = set(), isFromEnvironment=False):
+    iterator = consume_args(args)
 
     while True:
         try:
-            arg = next(it)
+            arg = next(iterator)
         except StopIteration:
-            raise ValueError("missing target: " + TARGET)
+            break
 
         switch = arg
         if not switch.startswith("-"):
@@ -214,34 +263,37 @@ def parse_argv():
         else:
             raise ValueError("unrecognized switch " + switch)
 
-        if switch in seen:
-            raise ValueError("duplicate switch " + switch)
+        # if we're parsing from the command line, and we've already seen the switch on the command line, this is an error
+        if (not isFromEnvironment and switch in seenFromCommandLine):
+            raise ValueError("duplicate switch on command line: " + switch)
+        # if we're parsing from the environment, and we've already seen the switch in the environment, this is an error
+        elif (isFromEnvironment and switch in seenFromEnvironment):
+            raise ValueError("duplicate switch from environment: " + switch)
+        # if we're parsing from the environment, and we've already seen the switch on the command line, skip it, since command line takes precedence
+        elif (isFromEnvironment and switch in seenFromCommandLine):
+            continue
+        # otherwise, the switch is new, so add it to the appropriate set
         else:
-            seen.add(switch)
+            if (isFromEnvironment):
+                seenFromEnvironment.add(switch)
+            else:
+                seenFromCommandLine.add(switch)
 
+        # process the switch, running the corresponding action
         try:
-            action(arg, it)
+            action(arg, iterator)
         except StopIteration:
             assert placeholder is not None
             raise ValueError("{0}: missing {1}".format(switch, placeholder))
         except Exception as exc:
             raise ValueError("invalid {0} {1}: {2}".format(switch, placeholder, exc))
 
-        if options.target is not None:
+        # If we're parsing the command line, we're done after we've processed the target
+        # Otherwise, we need to keep parsing until all args are consumed, since the target may be set from the command line
+        # already, but there might be additional args in the environment that we want to process.
+        if (not isFromEnvironment and options.target is not None):
             break
 
-    if options.mode is None:
-        raise ValueError("either --listen or --connect is required")
-    if options.adapter_access_token is not None and options.mode != "connect":
-        raise ValueError("--adapter-access-token requires --connect")
-    if options.target_kind == "pid" and options.wait_for_client:
-        raise ValueError("--pid does not support --wait-for-client")
-
-    assert options.target is not None
-    assert options.target_kind is not None
-    assert options.address is not None
-
-
 def start_debugging(argv_0):
     # We need to set up sys.argv[0] before invoking either listen() or connect(),
     # because they use it to report the "process" event. Thus, we can't rely on
@@ -252,9 +304,9 @@ def start_debugging(argv_0):
 
     debugpy.configure(options.config)
 
-    if options.mode == "listen":
+    if options.mode == "listen" and options.address is not None:
         debugpy.listen(options.address)
-    elif options.mode == "connect":
+    elif options.mode == "connect" and options.address is not None:
         debugpy.connect(options.address, access_token=options.adapter_access_token)
     else:
         raise AssertionError(repr(options.mode))
@@ -272,7 +324,7 @@ def run_file():
     # parent directory to sys.path. Thus, importing other modules from the
     # same directory is broken unless sys.path is patched here.
 
-    if os.path.isfile(target):
+    if target is not None and os.path.isfile(target):
         dir = os.path.dirname(target)
         sys.path.insert(0, dir)
     else:
@@ -293,7 +345,7 @@ def run_module():
     # actually invoking it.
     argv_0 = sys.argv[0]
     try:
-        spec = find_spec(options.target)
+        spec = None if options.target is None else find_spec(options.target)
         if spec is not None:
             argv_0 = spec.origin
     except Exception:
@@ -318,16 +370,19 @@ def run_module():
 
 
 def run_code():
-    # Add current directory to path, like Python itself does for -c.
-    sys.path.insert(0, str(""))
-    code = compile(options.target, str("<string>"), str("exec"))
+    if options.target is not None:
+        # Add current directory to path, like Python itself does for -c.
+        sys.path.insert(0, str(""))
+        code = compile(options.target, str("<string>"), str("exec"))
 
-    start_debugging(str("-c"))
+        start_debugging(str("-c"))
 
-    log.describe_environment("Pre-launch environment:")
-    log.info("Running code:\n\n{0}", options.target)
+        log.describe_environment("Pre-launch environment:")
+        log.info("Running code:\n\n{0}", options.target)
 
-    eval(code, {})
+        eval(code, {})
+    else:
+        log.error("No target to run.")
 
 
 def attach_to_pid():
@@ -402,7 +457,7 @@ attach_pid_injected.attach(setup);
 def main():
     original_argv = list(sys.argv)
     try:
-        parse_argv()
+        parse_args()
     except Exception as exc:
         print(str(HELP) + str("\nError: ") + str(exc), file=sys.stderr)
         sys.exit(2)
@@ -421,13 +476,14 @@ def main():
     )
 
     try:
-        run = {
-            "file": run_file,
-            "module": run_module,
-            "code": run_code,
-            "pid": attach_to_pid,
-        }[options.target_kind]
-        run()
+        if options.target_kind is not None:
+            run = {
+                "file": run_file,
+                "module": run_module,
+                "code": run_code,
+                "pid": attach_to_pid,
+            }[options.target_kind]
+            run()
     except SystemExit as exc:
         log.reraise_exception(
             "Debuggee exited via SystemExit: {0!r}", exc.code, level="debug"

{debugpy-1.8.1 → debugpy-1.8.3/src/debugpy.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: debugpy
-Version: 1.8.1
+Version: 1.8.3
 Summary: An implementation of the Debug Adapter Protocol for Python
 Home-page: https://aka.ms/debugpy
 Author: Microsoft Corporation

{debugpy-1.8.1 → debugpy-1.8.3}/src/debugpy.egg-info/SOURCES.txt

@@ -14,6 +14,7 @@ src/debugpy/public_api.py
 src/debugpy.egg-info/PKG-INFO
 src/debugpy.egg-info/SOURCES.txt
 src/debugpy.egg-info/dependency_links.txt
+src/debugpy.egg-info/entry_points.txt
 src/debugpy.egg-info/top_level.txt
 src/debugpy/_vendored/__init__.py
 src/debugpy/_vendored/_pydevd_packaging.py
@@ -180,6 +181,7 @@ src/debugpy/_vendored/pydevd/pydev_ipython/inputhookgtk3.py
 src/debugpy/_vendored/pydevd/pydev_ipython/inputhookpyglet.py
 src/debugpy/_vendored/pydevd/pydev_ipython/inputhookqt4.py
 src/debugpy/_vendored/pydevd/pydev_ipython/inputhookqt5.py
+src/debugpy/_vendored/pydevd/pydev_ipython/inputhookqt6.py
 src/debugpy/_vendored/pydevd/pydev_ipython/inputhooktk.py
 src/debugpy/_vendored/pydevd/pydev_ipython/inputhookwx.py
 src/debugpy/_vendored/pydevd/pydev_ipython/matplotlibtools.py

debugpy-1.8.3/src/debugpy.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+debugpy = debugpy.server.cli:main

debugpy-1.8.1/src/debugpy/__main__.py

@@ -1,39 +0,0 @@
-# Copyright (c) Microsoft Corporation. All rights reserved.
-# Licensed under the MIT License. See LICENSE in the project root
-# for license information.
-
-import sys
-
-
-if __name__ == "__main__":
-    # debugpy can also be invoked directly rather than via -m. In this case, the first
-    # entry on sys.path is the one added automatically by Python for the directory
-    # containing this file. This means that import debugpy will not work, since we need
-    # the parent directory of debugpy/ to be in sys.path, rather than debugpy/ itself.
-    #
-    # The other issue is that many other absolute imports will break, because they
-    # will be resolved relative to debugpy/ - e.g. `import debugger` will then try
-    # to import debugpy/debugger.py.
-    #
-    # To fix both, we need to replace the automatically added entry such that it points
-    # at parent directory of debugpy/ instead of debugpy/ itself, import debugpy with that
-    # in sys.path, and then remove the first entry entry altogether, so that it doesn't
-    # affect any further imports we might do. For example, suppose the user did:
-    #
-    #   python /foo/bar/debugpy ...
-    #
-    # At the beginning of this script, sys.path will contain "/foo/bar/debugpy" as the
-    # first entry. What we want is to replace it with "/foo/bar', then import debugpy
-    # with that in effect, and then remove the replaced entry before any more
-    # code runs. The imported debugpy module will remain in sys.modules, and thus all
-    # future imports of it or its submodules will resolve accordingly.
-    if "debugpy" not in sys.modules:
-        # Do not use dirname() to walk up - this can be a relative path, e.g. ".".
-        sys.path[0] = sys.path[0] + "/../"
-        import debugpy  # noqa
-
-        del sys.path[0]
-
-    from debugpy.server import cli
-
-    cli.main()