-
Notifications
You must be signed in to change notification settings - Fork 4.4k
Fix warning message #36703
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
base: master
Are you sure you want to change the base?
Fix warning message #36703
Conversation
Summary of ChangesHello @Abacn, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request resolves an issue where a warning message was not being displayed correctly due to improper argument handling in the logging function. The change ensures that the warning message's components are unpacked as individual arguments, allowing the logger to format and present the message as intended. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
e99d528 to
6ff3ffd
Compare
|
Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control. If you'd like to restart, comment |
| has_yield = True | ||
| if lstripped_line.startswith("return ") or lstripped_line.startswith( | ||
| elif lstripped_line.rstrip() == "return": | ||
| has_return_none = True |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe we can even skip this case? It seems like the only potentially problematic case is when they're expecting None to be processed downstream, in this case I think they probably have correct expectations
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah, updated. now both "return" and "return sth" will go to "has_return" (we still need to track all return statements to issue warning in the case both yield and return are used)
| if has_yield and has_return: | ||
| elif lstripped_line.startswith("return ") or lstripped_line.startswith( | ||
| "return("): | ||
| if lstripped_line.startswith("return None"): |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| if lstripped_line.startswith("return None"): | |
| if lstripped_line == "return None": |
I actually think we want to do this, because return None, 'foo' is actually a valid way to return a Tuple
|
|
||
| if not has_yield and not has_return: | ||
| _LOGGER.warning(return_none_warning) | ||
| if not has_yield and not has_return and has_return_none: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can this condition now just be:
if has_return_none
We already know that if has_return_none is true, then has_yield is false (otherwise we would've early returned). I think even if there is a mix of return and return None, we probably still want the warning.
| "Process method returned None (element won't be emitted): %s." | ||
| " Check if intended.", | ||
| fn.__self__.__class__) | ||
| print(has_yield, has_return, has_return_none) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need to print this tuple?
| "return("): | ||
| if lstripped_line.startswith("return None"): | ||
| has_return_none = True | ||
| else: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we can get rid of this else and always set has_return to True here (related to comment about condition below)
The following kind of DoFn no longer issue warning:
#28061 was meant to warn this scenario:
in addition, the formatting of current warning message is wrong. log.warning(("%s", 's',)) will output
("%s", 's',), not formatted stringPlease add a meaningful description for your change here
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, commentfixes #<ISSUE NUMBER>instead.CHANGES.mdwith noteworthy changes.See the Contributor Guide for more tips on how to make review process smoother.
To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md
GitHub Actions Tests Status (on master branch)
See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.