Skip to content

Conversation

@nikitagrover19
Copy link

Move Row to typehints/row.py, add compatibility alias in pvalue.py, update imports, and update CHANGES.md

This change reorganizes the Python SDK by moving the Row class into a dedicated module under apache_beam.typehints.
The goal is to improve module structure, reduce coupling, and better align Beam’s schema utilities with the type-hinting subsystem.

Description

This PR moves the Row implementation from apache_beam.pvalue into a new file, apache_beam.typehints.row.
This is a more appropriate location for a schema-aware, type-hinted data container and helps simplify the structure of pvalue.py.

To maintain full backward compatibility, pvalue.py now exposes a compatibility alias so that existing user code importing apache_beam.Row continues to work without modification.

Additional Updates

  • Updated apache_beam/init.py to re-export Row.
  • Updated imports wherever the previous module path was used.
  • Added an entry to CHANGES.md documenting the relocation.

This improves code organization and moves schema utilities closer to the rest of Beam’s type-hinting system, without breaking any public APIs.

Fixes #35095


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 @nikitagrover19, 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 refactors the Python SDK by relocating the Row class to a more semantically appropriate module within the type-hinting subsystem. This change enhances code organization and reduces coupling, while meticulously preserving backward compatibility for users. The move integrates schema-aware data containers more closely with Beam's type-hinting capabilities, ensuring a cleaner and more logical structure without impacting existing public APIs.

Highlights

  • Module Reorganization: The Row class has been moved from apache_beam.pvalue to a new, dedicated module: apache_beam.typehints.row. This aims to improve the module structure and better align schema utilities with the type-hinting subsystem.
  • Backward Compatibility: A compatibility alias for Row has been added to pvalue.py to ensure that existing user code importing apache_beam.Row continues to function without modification.
  • Import Updates: All necessary import statements across the codebase, including in apache_beam/__init__.py, have been updated to reflect the new location of the Row class.
  • Changelog Documentation: The CHANGES.md file has been updated to document the relocation of the Row class and the introduction of the compatibility alias.
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.

@github-actions
Copy link
Contributor

Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment assign set of reviewers

@github-actions
Copy link
Contributor

Assigning reviewers:

R: @claudevdm for label python.

Note: If you would like to opt out of this review, comment assign to next reviewer.

Available commands:

  • stop reviewer notifications - opt out of the automated review tooling
  • remind me after tests pass - tag the comment author after tests pass
  • waiting on author - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)

The PR bot will only process comments in the main thread (not review comments).

@nikitagrover19
Copy link
Author

/gemini review

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request refactors the Row class by moving it from pvalue.py to a new, more appropriate location in typehints/row.py. This is a good code organization improvement that enhances modularity. The changes maintain backward compatibility by providing an alias in the old location.

I've found a couple of issues in the moved Row class implementation that were likely pre-existing but are good to fix as part of this refactoring. Specifically, the __hash__ method is implemented in a way that will cause a TypeError at runtime, and the __eq__ method has an incorrect check for NamedTuple instances. I've also left a minor formatting suggestion for CHANGES.md.

Overall, the refactoring is well-executed. Addressing the identified issues will improve the robustness of the Row class.

return 'Row(%s)' % ', '.join('%s=%r' % kv for kv in self.__dict__.items())

def __hash__(self):
return hash(self.__dict__.items())
Copy link
Contributor

Choose a reason for hiding this comment

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

critical

The __hash__ method will raise a TypeError because dict.items() returns a view object, which is not hashable in Python 3. To fix this, you should convert the items to a hashable, ordered type like a tuple. Given that field order is important for Row objects, converting to a tuple is the correct approach.

Suggested change
return hash(self.__dict__.items())
return hash(tuple(self.__dict__.items()))

Comment on lines +78 to +79


Copy link
Contributor

Choose a reason for hiding this comment

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

medium

These extra blank lines can be removed for better readability and to keep the changelog concise.

Comment on lines +61 to +62
elif type(other) == type(NamedTuple):
other_dict = other._asdict()
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

The check type(other) == type(NamedTuple) is incorrect for identifying NamedTuple instances. typing.NamedTuple is a class factory, and instances of named tuples do not have NamedTuple as their type. A more robust way to check for namedtuple-like objects is to see if it's a tuple and has an _asdict method.

Suggested change
elif type(other) == type(NamedTuple):
other_dict = other._asdict()
elif isinstance(other, tuple) and hasattr(other, '_asdict'):
other_dict = other._asdict()

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.

[Feature Request]: Expose pvalue.Row in core.py rather than pvalue.py

1 participant