Skip to content
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.

Sign up for GitHub

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

Jump to bottom

dap-python: support debugging of 3rd modules #386

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

dap-python: support debugging of 3rd modules #386

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 15 additions & 3 deletions dap-python.el
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,9 @@ overriden in individual `dap-python' launch configurations."
(plist-get conf :program)
(buffer-file-name)))
(module (plist-get conf :module))
(debugger (plist-get conf :debugger)))
(debugger (plist-get conf :debugger))
(justmycode (plist-get conf :justMyCode))
(debug-options (plist-get conf :debugOptions)))
(cl-remf conf :debugger)
(pcase (or debugger dap-python-debugger)
('ptvsd
Expand All @@ -216,7 +218,12 @@ overriden in individual `dap-python' launch configurations."
(plist-put conf :debugServer debug-port)
(plist-put conf :port debug-port)
(plist-put conf :hostName host)
(plist-put conf :host host)))
(plist-put conf :host host)
(when (and (not (null justmycode))
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
(when (and (not (null justmycode))
(when (and justmycode

Chaining not and null if only the result's truthynesss matters is redundant and non-idiomatic.

Copy link
Member

Choose a reason for hiding this comment

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

FYI, not and null are aliases.

(equal justmycode :json-false))
(setq debug-options (cl-pushnew "DebugStdLib" debug-options :test #'equal))
(plist-put conf :debugOptions debug-options)
Copy link
Member

Choose a reason for hiding this comment

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

This will create a duplicate if :debugOptions is specified, with this version being overriden (it will show up twice in the JSON communcation). '(:debugOptions ...) -> '(:debugOptions (DebugStdLib . ...) :debugOptions ...)

(cl-remf conf :justMyCode))))
('debugpy
;; If certain properties are nil, issues will arise, as debugpy expects
;; them to unspecified instead. Some templates in this file set such
Expand All @@ -238,7 +245,12 @@ overriden in individual `dap-python' launch configurations."
(cl-remf conf :module))
(unless (plist-get conf :cwd)
(cl-remf conf :cwd))

(when (and debug-options
(sequencep debug-options)
(seq-contains debug-options "DebugStdLib")
(null justmycode))
(warn "DebugStdLib is deprecated, use justMyCode, please consider to update your configuration.")
Copy link
Member

Choose a reason for hiding this comment

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

Why the backwards compatibility considerations here? :debugOptions is introduced with this PR, so there cannot be a config in the wild using it.

Copy link
Member

Choose a reason for hiding this comment

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

I'd just drop that warning altogether. You could state in the README somewhere that :debugOptions is ptsvd-specific, and that :justMyCode is the preferred way to go about this, since it is portable.

(plist-put conf :justMyCode :json-false))
(plist-put conf :dap-server-path
(list python-executable "-m" "debugpy.adapter"))))
(plist-put conf :program program)
Expand Down
6 changes: 4 additions & 2 deletions docs/page/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,9 @@ settings.

A template named "Python :: Run Configuration" will appear, which
will execute the currently visited module. This will fall short
whenever you need to specify arguments, environment variables or
execute a setuptools based script. In such case, define a template:
whenever you need to specify arguments, environment variables,
enable debugging of 3rd modules or execute a setuptools based script.
In such case, define a template:

``` elisp
(dap-register-debug-template "My App"
Expand All @@ -105,6 +106,7 @@ settings.
:cwd nil
:env '(("DEBUG" . "1"))
:target-module (expand-file-name "~/src/myapp/.env/bin/myapp")
:justMyCode :json-false
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
:justMyCode :json-false
:justMyCode nil

:justMyCode should be optional and off by default. Also, use, and make sure the user can use, nil in such cases since that is more idiomatic in ELisp, which lacks a dedicated false type. json-encoder-specifics shouldn't leak trough.

:request "launch"
:name "My App"))
```
Expand Down