Skip to content

Conversation

@Abacn
Copy link
Contributor

@Abacn Abacn commented Oct 31, 2025

The following kind of DoFn no longer issue warning:

class DoFn:
  do_some_work # may intended for side effect for incoming elements and not intended to emit anything
class DoFn:
  if not a
    return # A valid filter pattern
  do_some_thing
  return some_output

#28061 was meant to warn this scenario:

class DoFn:
  do_some_work
  return None # user may assume it will emit a "None" downstream, which is not the case

in addition, the formatting of current warning message is wrong. log.warning(("%s", 's',)) will output ("%s", 's',), not formatted string

Please 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:

  • Mention the appropriate issue in your description (for example: 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, comment fixes #<ISSUE NUMBER> instead.
  • Update CHANGES.md with noteworthy changes.
  • If this contribution is large, please file an Apache Individual Contributor License Agreement.

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)

Build python source distribution and wheels
Python tests
Java tests
Go tests

See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @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

  • Warning Message Fix: Corrected the argument passing for _LOGGER.warning calls in _check_fn_use_yield_and_return by unpacking the return_none_warning variable, ensuring proper formatting of the warning message.
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@Abacn
Copy link
Contributor Author

Abacn commented Oct 31, 2025

@github-actions
Copy link
Contributor

Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control. If you'd like to restart, comment assign set of reviewers

has_yield = True
if lstripped_line.startswith("return ") or lstripped_line.startswith(
elif lstripped_line.rstrip() == "return":
has_return_none = True
Copy link
Contributor

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

Copy link
Contributor Author

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"):
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
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:
Copy link
Contributor

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)
Copy link
Contributor

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:
Copy link
Contributor

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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

2 participants