Introduce Beartype Dependency for Type Checking

[jrmccluskey]

Introduces Beartype into Beam Python for type checking as discussed in https://s.apache.org/beam-python-third-party-type-checking, uses the is_subhint() method over is_subclass() as a first step towards migrating more checks to Beartype.

---

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)

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]

Summary of Changes

Hello @jrmccluskey, I'm Gemini Code Assist¹! 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 integrates the beartype library into Apache Beam's Python SDK to enhance runtime type checking capabilities. The primary change involves migrating existing type consistency checks from issubclass() to beartype.door.is_subhint(), which is a foundational step towards more comprehensive type validation. The necessary beartype dependency has also been added to the project's setup configuration.

Highlights

• Dependency Management: The beartype library, specifically version 0.21.0 to 0.22.0, has been added as a new dependency in the setup.py file.
• Type Checking Logic Update: The is_consistent_with function in sdks/python/apache_beam/typehints/typehints.py now utilizes beartype.door.is_subhint() instead of the built-in issubclass() for type consistency checks.
• Error Handling Improvement: A try-except block has been introduced around the is_subhint() call to robustly handle any exceptions that might occur during the type consistency evaluation.

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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

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 issue 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]

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]

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).

[jrmccluskey]

R: @damccorm since Claude is out

[damccorm]

Should we gate this on a pipeline option so that users can disable this for now if they run into issues? Could be part of

beam/sdks/python/apache_beam/options/pipeline_options.py

Line 805 in b67c2aa

class TypeOptions(PipelineOptions):

[jrmccluskey]

I was thinking we would do that eventually once we were getting to where we'd skip things like normalize() calls, but considering that we'd need to do the plumbing for that anyway I'm not opposed to it. Seeing exactly how best to plumb that through will take a bit, but the bottom level having a use_beartype boolean parameter is a good starting point. As written now it's just off with no way to actually enable it, I will look at the actual pipeline option next (can do that either in this PR or in a follow-up, it's going to be next week either way)

[damccorm]

Sounds good - I'll leave it up to you whether you'd like it in this PR or a future one. To be clear, once we have a flag with the ability to turn this off I have no problem with defaulting to it on (assuming it passes test suites)

[damccorm]

Current state is good with me, or we can add a flag and flip the default to on

[jrmccluskey]

Game plan around this for ease more than any thing else is to get this in as-is to keep the internal import as simple as possible. I don't anticipate the beartype route here breaking anything internally but if this way, if there is a problem, it can be handled after getting the new dependency set up correctly. Plumbing through an option and changing the default after that seems like a reasonable choice.

[damccorm]

SGTM, thanks