Rename SuffixRange to SuffixByteRequest

Author: maxrjones

src/zarr/abc/store.py

@@ -40,14 +40,14 @@ class OffsetByteRequest:
 
 
 @dataclass
-class SuffixRange:
+class SuffixByteRequest:
     """Request up to the last `n` bytes"""
 
     suffix: int
     """The number of bytes from the suffix to request."""
 
 
-ByteRangeRequest: TypeAlias = ExplicitByteRequest | OffsetByteRequest | SuffixRange
+ByteRangeRequest: TypeAlias = ExplicitByteRequest | OffsetByteRequest | SuffixByteRequest
 
 
 class Store(ABC):
@@ -182,7 +182,7 @@ async def get(
 
             - ExplicitByteRequest(int, int): Request a specific range of bytes in the form (start, end). The end is exclusive. If the given range is zero-length or starts after the end of the object, an error will be returned. Additionally, if the range ends after the end of the object, the entire remainder of the object will be returned. Otherwise, the exact requested range will be returned.
             - OffsetByteRequest(int): Request all bytes starting from a given byte offset. This is equivalent to bytes={int}- as an HTTP header.
-            - SuffixRange(int): Request the last int bytes. Note that here, int is the size of the request, not the byte offset. This is equivalent to bytes=-{int} as an HTTP header.
+            - SuffixByteRequest(int): Request the last int bytes. Note that here, int is the size of the request, not the byte offset. This is equivalent to bytes=-{int} as an HTTP header.
 
         Returns
         -------

src/zarr/codecs/sharding.py

@@ -22,7 +22,7 @@
     ByteRangeRequest,
     ByteSetter,
     ExplicitByteRequest,
-    SuffixRange,
+    SuffixByteRequest,
 )
 from zarr.codecs.bytes import BytesCodec
 from zarr.codecs.crc32c_ import Crc32cCodec
@@ -708,7 +708,7 @@ async def _load_shard_index_maybe(
             )
         else:
             index_bytes = await byte_getter.get(
-                prototype=numpy_buffer_prototype(), byte_range=SuffixRange(shard_index_size)
+                prototype=numpy_buffer_prototype(), byte_range=SuffixByteRequest(shard_index_size)
             )
         if index_bytes is not None:
             return await self._decode_shard_index(index_bytes, chunks_per_shard)

src/zarr/storage/_fsspec.py

@@ -8,7 +8,7 @@
     ExplicitByteRequest,
     OffsetByteRequest,
     Store,
-    SuffixRange,
+    SuffixByteRequest,
 )
 from zarr.storage._common import _dereference_path
 
@@ -227,7 +227,7 @@ async def get(
                 value = prototype.buffer.from_bytes(
                     await self.fs._cat_file(path, start=byte_range.offset, end=None)
                 )
-            elif isinstance(byte_range, SuffixRange):
+            elif isinstance(byte_range, SuffixByteRequest):
                 value = prototype.buffer.from_bytes(
                     await self.fs._cat_file(path, start=-byte_range.suffix, end=None)
                 )
@@ -299,7 +299,7 @@ async def get_partial_values(
                 elif isinstance(byte_range, OffsetByteRequest):
                     starts.append(byte_range.offset)
                     stops.append(None)
-                elif isinstance(byte_range, SuffixRange):
+                elif isinstance(byte_range, SuffixByteRequest):
                     starts.append(-byte_range.suffix)
                     stops.append(None)
                 else:

src/zarr/storage/_local.py

@@ -12,7 +12,7 @@
     ExplicitByteRequest,
     OffsetByteRequest,
     Store,
-    SuffixRange,
+    SuffixByteRequest,
 )
 from zarr.core.buffer import Buffer
 from zarr.core.buffer.core import default_buffer_prototype
@@ -34,7 +34,7 @@ def _get(path: Path, prototype: BufferPrototype, byte_range: ByteRangeRequest |
             return prototype.buffer.from_bytes(f.read(byte_range.end - f.tell()))
         elif isinstance(byte_range, OffsetByteRequest):
             f.seek(byte_range.offset)
-        elif isinstance(byte_range, SuffixRange):
+        elif isinstance(byte_range, SuffixByteRequest):
             f.seek(max(0, size - byte_range.suffix))
         else:
             raise TypeError("Invalid format for ByteRangeRequest")

src/zarr/storage/_utils.py

@@ -4,7 +4,7 @@
 from pathlib import Path
 from typing import TYPE_CHECKING
 
-from zarr.abc.store import ExplicitByteRequest, OffsetByteRequest, SuffixRange
+from zarr.abc.store import ExplicitByteRequest, OffsetByteRequest, SuffixByteRequest
 
 if TYPE_CHECKING:
     from zarr.abc.store import ByteRangeRequest
@@ -62,7 +62,7 @@ def _normalize_byte_range_index(
     elif isinstance(byte_range, OffsetByteRequest):
         start = byte_range.offset
         stop = len(data) + 1
-    elif isinstance(byte_range, SuffixRange):
+    elif isinstance(byte_range, SuffixByteRequest):
         start = len(data) - byte_range.suffix
         stop = len(data) + 1
     return (start, stop)

src/zarr/storage/_zip.py

@@ -12,7 +12,7 @@
     ExplicitByteRequest,
     OffsetByteRequest,
     Store,
-    SuffixRange,
+    SuffixByteRequest,
 )
 from zarr.core.buffer import Buffer, BufferPrototype
 
@@ -157,7 +157,7 @@ def _get(
                 size = f.seek(0, os.SEEK_END)
                 if isinstance(byte_range, OffsetByteRequest):
                     f.seek(byte_range.offset)
-                elif isinstance(byte_range, SuffixRange):
+                elif isinstance(byte_range, SuffixByteRequest):
                     f.seek(max(0, size - byte_range.suffix))
                 else:
                     raise TypeError("Invalid format for ByteRangeRequest")

src/zarr/testing/store.py

@@ -19,7 +19,7 @@
     ExplicitByteRequest,
     OffsetByteRequest,
     Store,
-    SuffixRange,
+    SuffixByteRequest,
 )
 from zarr.core.buffer import Buffer, default_buffer_prototype
 from zarr.core.sync import _collect_aiterator
@@ -122,7 +122,7 @@ def test_store_supports_listing(self, store: S) -> None:
     @pytest.mark.parametrize("key", ["c/0", "foo/c/0.0", "foo/0/0"])
     @pytest.mark.parametrize("data", [b"\x01\x02\x03\x04", b""])
     @pytest.mark.parametrize(
-        "byte_range", [None, ExplicitByteRequest(1, 4), OffsetByteRequest(1), SuffixRange(1)]
+        "byte_range", [None, ExplicitByteRequest(1, 4), OffsetByteRequest(1), SuffixByteRequest(1)]
     )
     async def test_get(self, store: S, key: str, data: bytes, byte_range: ByteRangeRequest) -> None:
         """
@@ -189,7 +189,7 @@ async def test_set_many(self, store: S) -> None:
             [("c/0", ExplicitByteRequest(0, 2)), ("zarr.json", None)],
             [
                 ("c/0/0", ExplicitByteRequest(0, 2)),
-                ("c/0/1", SuffixRange(2)),
+                ("c/0/1", SuffixByteRequest(2)),
                 ("c/0/2", OffsetByteRequest(2)),
             ],
         ],