Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions src/obspec_utils/obspec.py
Original file line number Diff line number Diff line change
Expand Up @@ -306,6 +306,19 @@ def tell(self) -> int:
"""
return self._position

def close(self) -> None:
"""Close the reader and release the read-ahead buffer."""
self._buffer = b""
self._buffer_start = 0

def __enter__(self) -> "BufferedStoreReader":
"""Enter the context manager."""
return self

def __exit__(self, exc_type, exc_val, exc_tb) -> None:
"""Exit the context manager and close the reader."""
self.close()


class EagerStoreReader:
"""
Expand Down Expand Up @@ -412,6 +425,18 @@ def tell(self) -> int:
"""Return the current position in the cached file."""
return self._buffer.tell()

def close(self) -> None:
"""Close the reader and release the in-memory buffer."""
self._buffer = io.BytesIO(b"")

def __enter__(self) -> "EagerStoreReader":
"""Enter the context manager."""
return self

def __exit__(self, exc_type, exc_val, exc_tb) -> None:
"""Exit the context manager and close the reader."""
self.close()


class ParallelStoreReader:
"""
Expand Down Expand Up @@ -604,6 +629,18 @@ def tell(self) -> int:
"""
return self._position

def close(self) -> None:
"""Close the reader and release the chunk cache."""
self._cache.clear()

def __enter__(self) -> "ParallelStoreReader":
"""Enter the context manager."""
return self

def __exit__(self, exc_type, exc_val, exc_tb) -> None:
"""Exit the context manager and close the reader."""
self.close()


__all__: list[str] = [
"ReadableFile",
Expand Down
42 changes: 42 additions & 0 deletions tests/test_registry.py
Original file line number Diff line number Diff line change
Expand Up @@ -601,3 +601,45 @@ def test_eager_reader_chunk_boundaries():
# Verify chunk sizes
lengths = [r.length for r in trace.requests]
assert lengths == [4, 4, 2]


@pytest.mark.parametrize("ReaderClass", ALL_READERS)
def test_reader_context_manager(ReaderClass):
"""Test that readers work as context managers and release resources."""
memstore = MemoryStore()
memstore.put("test.txt", b"hello world")

with ReaderClass(memstore, "test.txt") as reader:
assert reader.read(5) == b"hello"
assert reader.tell() == 5

# After exiting context, internal buffers should be cleared
if hasattr(reader, "_buffer"):
if isinstance(reader._buffer, bytes):
assert reader._buffer == b""
else:
# BytesIO - check it's empty
assert reader._buffer.getvalue() == b""
if hasattr(reader, "_cache"):
assert len(reader._cache) == 0


@pytest.mark.parametrize("ReaderClass", ALL_READERS)
def test_reader_close(ReaderClass):
"""Test that readers can be explicitly closed."""
memstore = MemoryStore()
memstore.put("test.txt", b"hello world")

reader = ReaderClass(memstore, "test.txt")
assert reader.read(5) == b"hello"

reader.close()

# After close, internal buffers should be cleared
if hasattr(reader, "_buffer"):
if isinstance(reader._buffer, bytes):
assert reader._buffer == b""
else:
assert reader._buffer.getvalue() == b""
if hasattr(reader, "_cache"):
assert len(reader._cache) == 0
Loading