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

Add instructions on how you can debug Breeze easily #35101

Merged
merged 1 commit into from
Oct 21, 2023

Conversation

potiuk
Copy link
Member

@potiuk potiuk commented Oct 21, 2023

It could be unclear how to debug Breeze using IDE debuggers, this change provides an explanation including screenshot from PyCharm.


^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in newsfragments.

@potiuk
Copy link
Member Author

potiuk commented Oct 21, 2023

Since we are going to work on more of changes similar to #35086 I've figured that it might be non-obvious how to easily configure your IDE to run debugging sessions - without involving remote debugger or using ipython or "print debugging".

It's rather easy - but it's not something you'd usually do when you develop Pythin script. Breeze is an installable package which has automated upgrade checks and uses click to pass commands, so you need to use module and add SKIP_UPGRADE_CHECK variable in "IDE "debugger".

I added screenshot and explanation about it in Breeze docs. Might be also helpful to pull in others who would like to

@potiuk potiuk requested a review from uranusjr October 21, 2023 14:29
Copy link
Contributor

@eladkal eladkal left a comment

Choose a reason for hiding this comment

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

Nice!

Copy link
Contributor

@amoghrajesh amoghrajesh left a comment

Choose a reason for hiding this comment

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

Nice! Some nits which you can ignore as well

It could be unclear how to debug Breeze using IDE debuggers, this
change provides an explanation including screenshot from PyCharm.
@potiuk potiuk force-pushed the add-instructions-on-how-to-debug-breeze branch from 07425c4 to 5feb592 Compare October 21, 2023 15:47
@potiuk potiuk merged commit 5973c6a into apache:main Oct 21, 2023
@potiuk potiuk deleted the add-instructions-on-how-to-debug-breeze branch October 21, 2023 15:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants