Skip to content

remove list_prefix deprecated method#37587

Open
derrickaw wants to merge 1 commit intoapache:masterfrom
derrickaw:20260212_deprecateListPrefix
Open

remove list_prefix deprecated method#37587
derrickaw wants to merge 1 commit intoapache:masterfrom
derrickaw:20260212_deprecateListPrefix

Conversation

@derrickaw
Copy link
Collaborator

@derrickaw derrickaw commented Feb 12, 2026

  1. Remove deprecated list_prefix method since deprecated going back to beam 2.45.
  2. Get rid of the deprecation warnings in test logs.

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 @derrickaw, 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 focuses on code cleanup and modernization by eradicating a deprecated file listing method across multiple cloud storage I/O connectors. The change ensures that all internal operations and tests now exclusively utilize the current and recommended file listing mechanism, thereby improving code hygiene and preventing future issues related to deprecated API usage.

Highlights

  • Removal of Deprecated Method: The list_prefix method, which was previously marked as deprecated since version 2.45.0, has been completely removed from s3io.py, blobstorageio.py, and gcsio.py.
  • Migration to list_files: All internal and test usages of the removed list_prefix method have been updated to use the recommended list_files method across S3, Azure Blob Storage, and GCS I/O implementations.
  • Deprecation Warning Elimination: By removing the deprecated method and updating its call sites, this change eliminates deprecation warnings that would appear in test logs, contributing to cleaner and more maintainable code.

🧠 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
  • sdks/python/apache_beam/io/aws/s3io.py
    • Removed the import of the deprecated annotation.
    • Deleted the list_prefix method.
    • Updated calls to list_prefix in copy_tree and delete_tree to use list_files and correctly unpack its generator output.
    • Adjusted a logging message to refer to list_files instead of list_prefix.
  • sdks/python/apache_beam/io/aws/s3io_test.py
    • Modified test_copy, test_copy_tree, test_rename, and test_delete to use dict(self.aws.list_files(...)) instead of self.aws.list_prefix(...) for compatibility.
    • Renamed test_list_prefix to test_list_files to reflect the updated method being tested.
    • Updated assertions in the renamed test_list_files to correctly compare the output of list_files.
  • sdks/python/apache_beam/io/azure/blobstorageio.py
    • Removed the import of the deprecated annotation.
    • Deleted the list_prefix method.
    • Updated calls to list_prefix in copy_tree and delete_tree to use list_files and correctly unpack its generator output.
    • Adjusted a logging message to refer to list_files instead of list_prefix.
  • sdks/python/apache_beam/io/external/xlang_bigqueryio_it_test.py
    • Updated the assert_iceberg_tables_created function to call gcs_io.list_files instead of gcs_io.list_prefix.
  • sdks/python/apache_beam/io/gcp/gcsio.py
    • Removed the import of the deprecated annotation.
    • Deleted the list_prefix method.
    • Updated calls to list_prefix in copytree to use list_files and correctly unpack its generator output.
    • Adjusted a logging message to refer to list_files instead of list_prefix.
  • sdks/python/apache_beam/io/gcp/gcsio_test.py
    • Renamed test_list_prefix to test_list_files to reflect the updated method being tested.
    • Updated assertions in the renamed test_list_files to correctly compare the output of list_files.
  • sdks/python/apache_beam/runners/interactive/cache_manager.py
    • Updated the size method to use sum(s for _, s in gcsio.GcsIO().list_files(path)) instead of sum(gcsio.GcsIO().list_prefix(path).values()).
Activity
  • No human activity (comments, reviews) has been recorded on this pull request yet.
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.

@codecov
Copy link

codecov bot commented Feb 12, 2026

Codecov Report

❌ Patch coverage is 0% with 5 lines in your changes missing coverage. Please review.
✅ Project coverage is 35.88%. Comparing base (d6390b8) to head (cac81f2).
⚠️ Report is 6 commits behind head on master.

Files with missing lines Patch % Lines
sdks/python/apache_beam/io/aws/s3io.py 0.00% 2 Missing ⚠️
sdks/python/apache_beam/io/azure/blobstorageio.py 0.00% 2 Missing ⚠️
sdks/python/apache_beam/io/gcp/gcsio.py 0.00% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff              @@
##             master   #37587      +/-   ##
============================================
- Coverage     35.89%   35.88%   -0.01%     
  Complexity     1691     1691              
============================================
  Files          1063     1063              
  Lines        166721   166720       -1     
  Branches       1227     1227              
============================================
- Hits          59837    59827      -10     
- Misses       104687   104696       +9     
  Partials       2197     2197              
Flag Coverage Δ
python 39.68% <0.00%> (-0.02%) ⬇️

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.

@derrickaw
Copy link
Collaborator Author

Run Python_ML PreCommit 3.10

@derrickaw
Copy link
Collaborator Author

Run Python_ML PreCommit 3.13

@derrickaw
Copy link
Collaborator Author

Run Python PreCommit 3.10

@derrickaw
Copy link
Collaborator Author

Run Python_ML PreCommit 3.12

@derrickaw
Copy link
Collaborator Author

Run Python_ML PreCommit 3.13

@derrickaw derrickaw marked this pull request as ready for review February 13, 2026 12:49
@derrickaw
Copy link
Collaborator Author

Run Yaml_Xlang_Direct PreCommit

@github-actions
Copy link
Contributor

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

@derrickaw
Copy link
Collaborator Author

Codecov check should be ignored since just removing code.

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.

1 participant