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.

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

Conversation

jasondamour
Copy link

@jasondamour jasondamour commented Oct 12, 2024

This PR adds an option --log-on-listening to the CLI, which prints a message when waiting for client connection. This will allow clients (like VS Code) to trigger attaching only when a regex is matched.

Please advise on the name of the option, as well as if there's a better way to log to stdout.

… client, so that clients can trigger attaching
@@ -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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants