You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@beam.apache.org by "ian-Liaozy (via GitHub)" <gi...@apache.org> on 2025/11/14 20:06:13 UTC
[PR] Provide more contextual error message for PyCoder [beam]
ian-Liaozy opened a new pull request, #36825:
URL: https://github.com/apache/beam/pull/36825
Fixes #36824
**Description:**
Improve error messages by providing more contextual debugging information. Modify the `VarIntCoderImpl` class to catch the `OverflowError` and provide a more informative message.
**Fix/Changes::**
1. **Modified `encode_to_stream(self, value, out, nested)` in `coder_impl.py`:**
* Wrapped the call to out.write_var_int64(value) in a try...except OverflowError block.
* If an OverflowError occurs, a new OverflowError is raised with a message explicitly stating:
* The value causing the error.
* That the VarIntCoder is limited to the 64-bit signed integer range.
2. **`estimate_size(self, value, nested=False)` in `coder_impl.py`:**
* Wrapped the call to `get_varint_size(value)` in a try...except `OverflowError` block.
* If an `OverflowError` occurs, it means the value is too large to even calculate the varint size, so a more specific `OverflowError` is raised.
**Impact of these Changes:**
1. When a Python integer larger than what can be represented by a signed 64-bit integer is passed to a Beam pipeline and a `VarIntCoder` is used, the user will now get a much clearer error message.
2. The message will immediately point to the size limitation of the coder, making it much easier to debug issues.
3. This improves the user experience by making the error message more actionable and less cryptic.
------------------------
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] 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](https://www.apache.org/licenses/icla.pdf).
See the [Contributor Guide](https://beam.apache.org/contribute) for more tips on [how to make review process smoother](https://github.com/apache/beam/blob/master/CONTRIBUTING.md#make-the-reviewers-job-easier).
To check the build health, please visit [https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md](https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md)
GitHub Actions Tests Status (on master branch)
------------------------------------------------------------------------------------------------
[](https://github.com/apache/beam/actions?query=workflow%3A%22Build+python+source+distribution+and+wheels%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Python+Tests%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Java+Tests%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Go+tests%22+branch%3Amaster+event%3Aschedule)
See [CI.md](https://github.com/apache/beam/blob/master/CI.md) for more information about GitHub Actions CI or the [workflows README](https://github.com/apache/beam/blob/master/.github/workflows/README.md) to see a list of phrases to trigger workflows.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Provide more contextual error message for PyCoder [beam]
Posted by "jrmccluskey (via GitHub)" <gi...@apache.org>.
jrmccluskey merged PR #36825:
URL: https://github.com/apache/beam/pull/36825
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Provide more contextual error message for PyCoder [beam]
Posted by "gemini-code-assist[bot] (via GitHub)" <gi...@apache.org>.
gemini-code-assist[bot] commented on PR #36825:
URL: https://github.com/apache/beam/pull/36825#issuecomment-3534379377
## Summary of Changes
Hello @ian-Liaozy, I'm Gemini Code Assist[^1]! 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 improves the robustness and user-friendliness of Apache Beam's Python `VarIntCoder` by enhancing its error handling. It ensures that when integer values exceed the 64-bit signed integer limit, users receive clear, informative error messages that pinpoint the issue and its constraints, rather than cryptic `OverflowError` exceptions. This change makes it easier for developers to understand and resolve data type limitations within their pipelines.
### Highlights
* **Enhanced Error Messages**: The `VarIntCoderImpl` now provides more contextual and actionable error messages when an `OverflowError` occurs during encoding or size estimation. The new messages explicitly state the problematic integer value and clarify that the coder is limited to 64-bit signed integers.
* **Improved Debugging Experience**: By catching `OverflowError` in both `encode_to_stream` and `estimate_size` methods, the system now guides users directly to the cause of the error (value exceeding 64-bit signed integer range), significantly reducing debugging time for issues related to large integer values in Beam pipelines.
<details>
<summary><b>Using Gemini Code Assist</b></summary>
<br>
The full guide for Gemini Code Assist can be found on our [documentation page](https://developers.google.com/gemini-code-assist/docs/review-github-code), here are some quick tips.
<b>Invoking Gemini</b>
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.
<b>Customization</b>
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](https://developers.google.com/gemini-code-assist/docs/customize-gemini-behavior-github).
<b>Limitations & Feedback</b>
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with :thumbsup: and :thumbsdown: 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](https://google.qualtrics.com/jfe/form/SV_2cyuGuTWsEw84yG).
<b>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](https://cloud.google.com/products/gemini/code-assist).</b>
</details>
[^1]: Review the [Privacy Notices](https://policies.google.com/privacy), [Generative AI Prohibited Use Policy](https://policies.google.com/terms/generative-ai/use-policy), [Terms of Service](https://policies.google.com/terms), and learn how to configure Gemini Code Assist in GitHub [here](https://developers.google.com/gemini-code-assist/docs/customize-gemini-behavior-github). Gemini can make mistakes, so double check it and [use code with caution](https://support.google.com/legal/answer/13505487).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Provide more contextual error message for PyCoder [beam]
Posted by "ian-Liaozy (via GitHub)" <gi...@apache.org>.
ian-Liaozy commented on PR #36825:
URL: https://github.com/apache/beam/pull/36825#issuecomment-3534488186
assign set of reviewers
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Provide more contextual error message for PyCoder [beam]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #36825:
URL: https://github.com/apache/beam/pull/36825#issuecomment-3534490729
Assigning reviewers:
R: @jrmccluskey 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).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Provide more contextual error message for PyCoder [beam]
Posted by "ian-Liaozy (via GitHub)" <gi...@apache.org>.
ian-Liaozy commented on PR #36825:
URL: https://github.com/apache/beam/pull/36825#issuecomment-3543515784
Hi @jrmccluskey, all tests pass now.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Provide more contextual error message for PyCoder [beam]
Posted by "ian-Liaozy (via GitHub)" <gi...@apache.org>.
ian-Liaozy commented on PR #36825:
URL: https://github.com/apache/beam/pull/36825#issuecomment-3534382463
Question: I didn't existing tests code for coder_impl.py, should I add the test code or it is fine?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Provide more contextual error message for PyCoder [beam]
Posted by "ian-Liaozy (via GitHub)" <gi...@apache.org>.
ian-Liaozy commented on PR #36825:
URL: https://github.com/apache/beam/pull/36825#issuecomment-3543051029
Hi @jrmccluskey I checked the Lint check log and [build scan](https://develocity.apache.org/s/stryhpnb4ase2), it seems to be not because my code changes.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org