Skip to content
This repository was archived by the owner on Mar 31, 2026. It is now read-only.

Commit 3f12571

Browse files
committed
chore: add depreciation warning for generation_number
1 parent 2231120 commit 3f12571

2 files changed

Lines changed: 9 additions & 1 deletion

File tree

google/cloud/storage/asyncio/async_multi_range_downloader.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,10 @@ def __init__(
208208
"Cannot set both 'generation' and 'generation_number'. "
209209
"Use 'generation' for new code."
210210
)
211+
logger.warning(
212+
"'generation_number' is deprecated and will be removed in a future "
213+
"major release. Please use 'generation' instead."
214+
)
211215
generation = kwargs.pop("generation_number")
212216

213217
raise_if_no_fast_crc32c()

tests/unit/asyncio/test_async_multi_range_downloader.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -407,7 +407,7 @@ async def close_side_effect():
407407
)
408408
@pytest.mark.asyncio
409409
async def test_create_mrd_with_generation_number(
410-
self, mock_cls_async_read_object_stream
410+
self, mock_cls_async_read_object_stream, caplog
411411
):
412412
# Arrange
413413
mock_client = mock.MagicMock()
@@ -430,6 +430,10 @@ async def test_create_mrd_with_generation_number(
430430

431431
# Assert
432432
assert mrd.generation == _TEST_GENERATION_NUMBER
433+
assert len(caplog.records) == 1
434+
record = caplog.records[0]
435+
assert record.levelname == "WARNING"
436+
assert "'generation_number' is deprecated" in record.message
433437

434438
@pytest.mark.asyncio
435439
async def test_create_mrd_with_both_generation_and_generation_number(self):

0 commit comments

Comments
 (0)