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

feat: add option to log when the server is listening when waiting for client, so that clients can trigger attaching #1700

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −0
Open

feat: add option to log when the server is listening when waiting for client, so that clients can trigger attaching #1700

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
4 changes: 4 additions & 0 deletions src/debugpy/server/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ class Options(object):
target: Union[str, None] = None
target_kind: Union[str, None] = None
wait_for_client = False
log_on_listening = True
adapter_access_token = None
config: Dict[str, Any] = {}

Expand Down Expand Up @@ -177,6 +178,7 @@ def do(arg, it):
("--listen", "<address>", set_address("listen")),
("--connect", "<address>", set_address("connect")),
("--wait-for-client", None, set_const("wait_for_client", True)),
("--log-on-listening", None, set_const("log_on_listening", True)),
("--configure-.+", "<value>", set_config),

# Switches that are used internally by the client or debugpy itself.
Expand Down Expand Up @@ -325,6 +327,8 @@ def start_debugging(argv_0):
raise AssertionError(repr(options.mode))

if options.wait_for_client:
if options.log_on_listening:
print(f"Listening for debugger connection on {options.address[0]}:{options.address[1]}")
Copy link
Contributor

Choose a reason for hiding this comment

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

This seems like a one off. I'm wondering if there's another way to solve this that would be more generic. What if you set the log level and log to stderr? Would that work?

Copy link
Contributor

Choose a reason for hiding this comment

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

If you did so you could put a log.debug here or something with a higher trace level so that it would only show up when the log level was high enough.

Copy link
Author

Choose a reason for hiding this comment

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

Stupid question, but is there a way to set log level? The only logging options are log-to-stderr and log-to=[file], neither of which set level.

Copy link
Contributor

Choose a reason for hiding this comment

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

log-to file seems to set the level to debug. I don't see a way to set the pydevd log level from debugpy besides that though. log-to-stderr does the same thing.

Copy link
Contributor

Choose a reason for hiding this comment

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

Could you use log-to file and have the problem matcher read the file instead?

Copy link
Author

Choose a reason for hiding this comment

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

No, problemMatcher doesn't support reading files. And that sounds like a more complex solution compared to the relatively reasonable/straightforward approach here.

Copy link
Author

Choose a reason for hiding this comment

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

--log-to-stderr technically works, but prints ~260 lines of excess logs. IMO this log should be INFO or WARN, so how can I set stdout log level to info?

Copy link
Contributor

Choose a reason for hiding this comment

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

Add another command line switch that sets the log level? --log-level=info?

debugpy.wait_for_client()

os.environ["DEBUGPY_RUNNING"] = "true"
Expand Down