feat: add context manager to mrd by chandra-siri · Pull Request #1724 · googleapis/python-storage · GitHub
Skip to content
This repository was archived by the owner on Mar 31, 2026. It is now read-only.

feat: add context manager to mrd#1724

Merged
chandra-siri merged 2 commits into
mainfrom
context_manager
Jan 28, 2026
Merged

feat: add context manager to mrd#1724
chandra-siri merged 2 commits into
mainfrom
context_manager

Conversation

@chandra-siri

Copy link
Copy Markdown
Collaborator

feat: add context manager to mrd

@product-auto-label product-auto-label Bot added size: m Pull request size is medium. api: storage Issues related to the googleapis/python-storage API. labels Jan 26, 2026
@gemini-code-assist

Copy link
Copy Markdown
Contributor

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

Copy link
Copy Markdown
Contributor

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 introduces a convenient async context manager for AsyncMultiRangeDownloader, which is a great improvement for ensuring resources are properly managed. The implementation is correct and is accompanied by a new unit test and an update to a system test.

One suggestion for further improvement is to refactor the other system tests in tests/system/test_zonal.py that use AsyncMultiRangeDownloader to also adopt the new async with syntax. This would improve consistency and readability across the test suite.

I've also added a comment with suggestions to enhance the unit tests for the new context manager by covering some important edge cases.

Comment on lines +417 to +444

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

This is a good test for the happy path of the async context manager. To make it more robust, it would be beneficial to also test the behavior in edge cases.

Specifically, consider adding tests for:

  1. When open() fails (e.g., raises an exception). In this scenario, close() should not be called.
  2. When an exception is raised from within the async with block. In this case, close() should still be called to ensure cleanup.

Here are some examples of how you could structure these tests:

Test for open() failure:

@mock.patch("...")
@pytest.mark.asyncio
async def test_context_manager_no_close_on_open_failure(self, mock_grpc_client, mock_close, mock_open):
    mock_open.side_effect = ValueError("Failed to open")
    mrd = AsyncMultiRangeDownloader(
        mock_grpc_client, _TEST_BUCKET_NAME, _TEST_OBJECT_NAME
    )
    
    with pytest.raises(ValueError, match="Failed to open"):
        async with mrd:
            pytest.fail("This block should not be executed.")

    mock_open.assert_called_once()
    mock_close.assert_not_called()

Test for exception within the block:

@mock.patch("...")
@pytest.mark.asyncio
async def test_context_manager_closes_on_exception(self, mock_grpc_client, mock_close, mock_open):
    mrd = AsyncMultiRangeDownloader(
        mock_grpc_client, _TEST_BUCKET_NAME, _TEST_OBJECT_NAME
    )
    # set up side effects for open/close as in the existing test
    async def open_side_effect():
        mrd._is_stream_open = True
    mock_open.side_effect = open_side_effect
    
    with pytest.raises(RuntimeError, match="Oops"):
        async with mrd:
            raise RuntimeError("Oops")

    mock_open.assert_called_once()
    mock_close.assert_called_once()

@chandra-siri chandra-siri marked this pull request as ready for review January 27, 2026 13:20
@chandra-siri chandra-siri requested review from a team January 27, 2026 13:20
@chandra-siri chandra-siri requested a review from a team as a code owner January 27, 2026 13:20
@chandra-siri chandra-siri merged commit 5ac2808 into main Jan 28, 2026
18 of 19 checks passed
@chandra-siri chandra-siri deleted the context_manager branch January 28, 2026 10:06
chandra-siri added a commit that referenced this pull request Feb 2, 2026
PR created by the Librarian CLI to initialize a release. Merging this PR
will auto trigger a release.

Librarian Version: v1.0.2-0.20251119154421-36c3e21ad3ac
Language Image:
us-central1-docker.pkg.dev/cloud-sdk-librarian-prod/images-prod/python-librarian-generator@sha256:8e2c32496077054105bd06c54a59d6a6694287bc053588e24debe6da6920ad91
<details><summary>google-cloud-storage: 3.9.0</summary>

##
[3.9.0](v3.8.0...v3.9.0)
(2026-02-02)

### Features

* update generation for MRD (#1730)
([08bc708](08bc7082))

* add get_object method for async grpc client (#1735)
([0e5ec29](0e5ec29b))

* Add micro-benchmarks for reads comparing standard (regional) vs rapid
(zonal) buckets. (#1697)
([1917649](1917649f))

* Add support for opening via `write_handle` and fix `write_handle` type
(#1715)
([2bc15fa](2bc15fa5))

* add samples for appendable objects writes and reads
([2e1a1eb](2e1a1eb5))

* add samples for appendable objects writes and reads (#1705)
([2e1a1eb](2e1a1eb5))

* add context manager to mrd (#1724)
([5ac2808](5ac2808a))

* Move Zonal Buckets features of `_experimental` (#1728)
([74c9ecc](74c9ecc5))

* add default user agent for grpc (#1726)
([7b31946](7b319469))

* expose finalized_time in blob.py applicable for GET_OBJECT in ZB
(#1719)
([8e21a7f](8e21a7fe))

* expose `DELETE_OBJECT` in `AsyncGrpcClient` (#1718)
([c8dd7a0](c8dd7a0b))

* send `user_agent` to grpc channel (#1712)
([cdb2486](cdb2486b))

* integrate writes strategy and appendable object writer (#1695)
([dbd162b](dbd162b3))

* Add micro-benchmarks for writes comparing standard (regional) vs rapid
(zonal) buckets. (#1707)
([dbe9d8b](dbe9d8b8))

* add support for `generation=0` to avoid overwriting existing objects
and add `is_stream_open` support (#1709)
([ea0f5bf](ea0f5bf8))

* add support for `generation=0` to prevent overwriting existing objects
([ea0f5bf](ea0f5bf8))

* add `is_stream_open` property to AsyncAppendableObjectWriter for
stream status check
([ea0f5bf](ea0f5bf8))

### Bug Fixes

* receive eof while closing reads stream (#1733)
([2ef6339](2ef63396))

* update write handle on every recv() (#1716)
([5d9fafe](5d9fafe1))

* implement requests_done method to signal end of requests in async
streams. Gracefully close streams. (#1700)
([6c16079](6c160794))

* implement requests_done method to signal end of requests in async
streams. Gracefully close streams.
([6c16079](6c160794))

* instance grpc client once per process in benchmarks (#1725)
([721ea2d](721ea2dd))

* Fix formatting in setup.py dependencies list (#1713)
([cc4831d](cc4831d7))

* Change contructors of MRD and AAOW AsyncGrpcClient.grpc_client to
AsyncGrpcClient (#1727)
([e730bf5](e730bf50))

</details>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

api: storage Issues related to the googleapis/python-storage API. size: m Pull request size is medium.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants