Fix IndexError in apache_beam.utils.processes when pip subprocess fails with short command

[shaheeramjad]

Problem

When a pip subprocess fails and the command is passed as a short list (e.g. ['python', '-m', 'pip', 'install', 'pkg']), the exception handler in sdks/python/apache_beam/utils/processes.py raised IndexError instead of the intended RuntimeError with traceback and pip output.

The pip-specific branch used a hardcoded index 6 for the "package name" when formatting the error message (.format(..., args[0][6], ...)). For pip install <pkg> the command list has only 5 elements (indices 0–4), so args[0][6] caused IndexError and users saw a crash instead of a clear error message.

Solution

• Added _pip_package_from_args(args)
  Returns a safe string for the "package" field: uses args[0][6] only when args is a tuple, args[0] is a list/tuple, and len(args[0]) > 6; otherwise returns "see output below".

• Guarded the pip branch
  Replaced (args[0][2] == "pip") with len(args[0]) > 2 and args[0][2] == "pip" so we never index args[0][2] on a short list.

• Updated call, check_call, and check_output
  All three now use _pip_package_from_args(args) instead of args[0][6] when building the pip error message.

Files changed

• sdks/python/apache_beam/utils/processes.py

  • New helper _pip_package_from_args(args) (with docstring).
  • Pip branch in call, check_call, and check_output: length check + use of helper for package string.

• sdks/python/apache_beam/utils/processes_test.py

  • TestErrorHandlingCheckCall.test_check_call_pip_short_command_no_index_error
  • TestErrorHandlingCheckOutput.test_check_output_pip_short_command_no_index_error
  • TestErrorHandlingCall.test_call_pip_short_command_no_index_error
    Each test uses a short pip command (['python', '-m', 'pip', 'install', 'nonexistent-package-xyz']), triggers CalledProcessError, and asserts that a RuntimeError is raised (not IndexError) and that the message contains the subprocess output and "see output below".

Testing

• All 12 tests in apache_beam.utils.processes_test pass, including the 3 new tests and the existing ones (e.g. long pip command with package at index 6).
• Run: python -m unittest apache_beam.utils.processes_test -v

Backward compatibility

• Behavior is unchanged for commands with 7+ elements (e.g. existing pip download --dest /var <pkg> ... still shows the package name at index 6).
• Only the previously broken case (short command) is fixed; no API or contract changes.

Related

• Fixes IndexError in apache_beam.utils.processes when pip subprocess fails with short command (e.g. pip install <pkg>) #37515
• Component: Python SDK

---

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 @shaheeramjad, 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 significantly improves the error handling within Apache Beam's Python SDK by addressing a critical IndexError that could occur during pip subprocess failures. The changes ensure that users receive a meaningful RuntimeError with relevant output, rather than an application crash, when pip commands with short argument lists fail. This enhances the stability and diagnostic capabilities of the system without altering existing API contracts.

Highlights

• Bug Fix: IndexError in Pip Subprocess Error Handling: Resolved an IndexError that occurred in apache_beam.utils.processes when a pip subprocess failed with a short command list (e.g., ['python', '-m', 'pip', 'install', 'pkg']). Previously, this would crash the application instead of raising a RuntimeError with a descriptive message.
• New Helper Function: _pip_package_from_args: Introduced a new internal helper function, _pip_package_from_args, to safely extract the package name from the command arguments. This function now returns 'see output below' if the command list is too short to prevent IndexError.
• Enhanced Robustness in Pip Command Checks: Added explicit length checks (len(args[0]) > 2) before attempting to access args[0][2] to determine if the command is a 'pip' command, further preventing IndexError with malformed or short command lists.
• Updated Subprocess Call Functions: Modified call, check_call, and check_output functions to utilize the new _pip_package_from_args helper when constructing error messages for failed pip subprocesses.
• New Test Cases: Added three new test cases (test_check_call_pip_short_command_no_index_error, test_check_output_pip_short_command_no_index_error, test_call_pip_short_command_no_index_error) to apache_beam.utils.processes_test.py to specifically validate the fix for short pip commands.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

• CHANGES.md
  • Added an entry documenting the fix for IndexError in apache_beam.utils.processes when pip subprocess fails with short command.
• sdks/python/apache_beam/utils/processes.py
  • Introduced _pip_package_from_args(args) to safely extract package names for pip error messages.
  • Modified call, check_call, and check_output to include length checks for args[0] and use _pip_package_from_args when formatting pip-related RuntimeError messages.
• sdks/python/apache_beam/utils/processes_test.py
  • Added test_check_call_pip_short_command_no_index_error to verify check_call handles short pip commands without IndexError.
  • Added test_check_output_pip_short_command_no_index_error to verify check_output handles short pip commands without IndexError.
  • Added test_call_pip_short_command_no_index_error to verify call handles short pip commands without IndexError.

Activity

• The pull request was authored by shaheeramjad.
• The changes address and fix issue #37515.
• The CHANGES.md file has been updated to reflect this bugfix.
• New tests have been added to cover the specific scenario of short pip commands, and all 12 existing tests in apache_beam.utils.processes_test continue to pass.
• The changes maintain backward compatibility, only fixing previously broken behavior without altering existing functionality for longer commands.

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

[shaheeramjad]

Hi @damccorm Can you review it
Regards !!

[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

[shaheeramjad]

assign set of reviewers

[github-actions]

Assigning reviewers:

R: @shunping 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).

[damccorm]

Hey @shaheeramjad I'll defer to Shunping as the assigned reviewer - in general, all PRs should get auto-assigned reviewers

[github-actions]

Reminder, please take a look at this pr: @shunping

[shunping]

Thanks for contributing to Beam, @shaheeramjad!

I went back to check processes.py and found the code for error handling there was introduced a few years ago at 04db8f5

To me, it is very fragile to parse the package name from the argument list, because we can easily make up a example that won't fit. It may be easier to just remove the specific parsing logic for pip and just raise a general traceback.

[shunping]

Please see the inline comments

[shunping]

Looks like we need to re-evaluate a few failed tests because we get rid of the code path to parse the pip install package.

• TestErrorHandlingCheckCall.test_check_call_pip_install_non_existing_package
• TestErrorHandlingCheckCall.test_check_call_pip_short_command_no_index_error
• TestErrorHandlingCheckOutput.test_check_output_pip_install_non_existing_package
• TestErrorHandlingCheckOutput.test_check_output_pip_short_command_no_index_error
• TestErrorHandlingCall.test_call_pip_short_command_no_index_error
• TestErrorHandlingCall.test_check_output_pip_install_non_existing_package

[shaheeramjad]

@shunping Can You Review Now ?

[shunping]

@shunping Can You Review Now ?

Please fix the tests mentioned in #37536 (comment)

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 57.01%. Comparing base (d6920de) to head (fce90a9).
⚠️ Report is 89 commits behind head on master.

Additional details and impacted files

@@              Coverage Diff              @@
##             master   #37536       +/-   ##
=============================================
+ Coverage     40.06%   57.01%   +16.95%     
  Complexity     3404     3404               
=============================================
  Files          1177     1178        +1     
  Lines        187083   187495      +412     
  Branches       3581     3581               
=============================================
+ Hits          74947   106908    +31961     
+ Misses       108744    77195    -31549     
  Partials       3392     3392               

Flag	Coverage Δ
python	80.43% <100.00%> (+40.74%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[shaheeramjad]

@shunping Can You Review Now ?

Please fix the tests mentioned in #37536 (comment)

@shunping Can you check now ?

[shunping]

Looks good. Please fix the formatting issue found in the Precommit test.