renamed

Author: czaloom

src/valor_lite/cache/ephemeral.py

@@ -4,7 +4,7 @@
 import pyarrow as pa
 
 
-class EphemeralCache:
+class MemoryCache:
     def __init__(self, table: pa.Table):
         self._table = table
 
@@ -13,7 +13,7 @@ def count_rows(self) -> int:
         return self._table.num_rows
 
 
-class EphemeralCacheWriter(EphemeralCache):
+class MemoryCacheWriter(MemoryCache):
     def __init__(
         self,
         table: pa.Table,
@@ -147,22 +147,22 @@ def __exit__(self, exc_type, exc_val, exc_tb):
         self.flush()
 
 
-class EphemeralCacheReader:
+class MemoryCacheReader:
     def __init__(
         self,
-        cache: EphemeralCacheWriter,
+        cache: MemoryCacheWriter,
     ):
         self._cache = cache
         self._schema = self._cache._schema
 
     @classmethod
-    def load(cls, cache: EphemeralCacheWriter):
+    def load(cls, cache: MemoryCacheWriter):
         """
         Load cache from table.
 
         Parameters
         ----------
-        cache : EphemeralCacheWriter
+        cache : MemoryCacheWriter
             A cache writer containing the ephemeral cache.
         """
         return cls(cache=cache)

src/valor_lite/cache/persistent.py

@@ -11,7 +11,7 @@
 import pyarrow.parquet as pq
 
 
-class PersistentCache:
+class FileCache:
     def __init__(self, path: str | Path):
         self._path = Path(path)
 
@@ -80,7 +80,7 @@ def get_dataset_files(self) -> list[Path]:
         ]
 
 
-class PersistentCacheWriter(PersistentCache):
+class FileCacheWriter(FileCache):
     def __init__(
         self,
         path: str | Path,
@@ -298,7 +298,7 @@ def __exit__(self, exc_type, exc_val, exc_tb):
         self.flush()
 
 
-class PersistentCacheReader(PersistentCache):
+class FileCacheReader(FileCache):
     def __init__(
         self,
         path: str | Path,
@@ -308,7 +308,7 @@ def __init__(
         self._path = Path(path)
 
     @classmethod
-    def load(cls, path: str | Path | PersistentCache):
+    def load(cls, path: str | Path | FileCache):
         """
         Load cache from disk.
 
@@ -317,7 +317,7 @@ def load(cls, path: str | Path | PersistentCache):
         path : str | Path
             Where the cache is stored.
         """
-        if isinstance(path, PersistentCache):
+        if isinstance(path, FileCache):
             path = path.path
         path = Path(path)
         if not path.exists():

tests/common/test_ephemeral_cache.py

@@ -1,10 +1,7 @@
 import numpy as np
 import pyarrow as pa
 
-from valor_lite.cache.ephemeral import (
-    EphemeralCacheReader,
-    EphemeralCacheWriter,
-)
+from valor_lite.cache.ephemeral import MemoryCacheReader, MemoryCacheWriter
 
 
 def test_cache_reader():
@@ -16,7 +13,7 @@ def test_cache_reader():
             ("some_str", pa.string()),
         ]
     )
-    with EphemeralCacheWriter.create(
+    with MemoryCacheWriter.create(
         schema=schema,
         batch_size=batch_size,
     ) as writer:
@@ -33,7 +30,7 @@ def test_cache_reader():
         writer.write_table(tbl)
         assert writer.count_rows() == 101
 
-    reader = EphemeralCacheReader.load(writer)
+    reader = MemoryCacheReader.load(writer)
     assert reader.count_rows() == 101
     for tbl in reader.iterate_tables():
         assert tbl["some_int"].to_pylist() == [i for i in range(101)]
@@ -45,7 +42,7 @@ def test_cache_reader():
 
 def test_cache_write_batch():
     batch_size = 10
-    with EphemeralCacheWriter.create(
+    with MemoryCacheWriter.create(
         schema=pa.schema(
             [
                 ("some_int", pa.int64()),
@@ -64,7 +61,7 @@ def test_cache_write_batch():
                 }
             )
 
-    reader = EphemeralCacheReader(writer)
+    reader = MemoryCacheReader(writer)
     assert reader.count_rows() == 1000
     for tbl in reader.iterate_tables():
         assert tbl["some_int"].to_pylist() == [i for i in range(1000)]
@@ -74,7 +71,7 @@ def test_cache_write_batch():
 
 def test_cache_write_rows():
     batch_size = 10
-    with EphemeralCacheWriter.create(
+    with MemoryCacheWriter.create(
         schema=pa.schema(
             [
                 ("some_int", pa.int64()),
@@ -99,7 +96,7 @@ def test_cache_write_rows():
             writer.write_rows([])
             assert len(writer._buffer) == buffer_size
 
-    reader = EphemeralCacheReader.load(writer)
+    reader = MemoryCacheReader.load(writer)
     assert reader.count_rows() == 1000
     for tbl in reader.iterate_tables():
         assert tbl["some_int"].to_pylist() == [i for i in range(1000)]
@@ -109,7 +106,7 @@ def test_cache_write_rows():
 
 def test_cache_write_table():
     batch_size = 10
-    with EphemeralCacheWriter.create(
+    with MemoryCacheWriter.create(
         schema=pa.schema(
             [
                 ("some_int", pa.int64()),
@@ -137,7 +134,7 @@ def test_cache_write_table():
         writer.write_table(tbl)
         assert writer.count_rows() == 202
 
-        reader = EphemeralCacheReader.load(writer)
+        reader = MemoryCacheReader.load(writer)
 
     for tbl in reader.iterate_tables():
         assert tbl["some_int"].to_pylist() == [i for i in range(101)] + [
@@ -153,7 +150,7 @@ def test_cache_write_table():
 
 def test_cache_delete():
     batch_size = 10
-    with EphemeralCacheWriter.create(
+    with MemoryCacheWriter.create(
         schema=pa.schema(
             [
                 ("some_int", pa.int64()),
@@ -183,7 +180,7 @@ def test_cache_delete():
 
         writer.flush()
 
-        reader = EphemeralCacheReader.load(writer)
+        reader = MemoryCacheReader.load(writer)
         for tbl in reader.iterate_tables():
             assert tbl["some_int"].to_pylist() == [i for i in range(101)] + [
                 i for i in range(101)

tests/common/test_persistent_cache.py

@@ -6,14 +6,14 @@
 import pytest
 
 from valor_lite.cache.persistent import (
-    PersistentCache,
-    PersistentCacheReader,
-    PersistentCacheWriter,
+    FileCache,
+    FileCacheReader,
+    FileCacheWriter,
 )
 
 
 def test_cache_files_empty(tmp_path: Path):
-    cache = PersistentCache(tmp_path)
+    cache = FileCache(tmp_path)
     assert cache._path == tmp_path
     assert cache.get_files() == []
     assert cache.get_dataset_files() == []
@@ -22,7 +22,7 @@ def test_cache_files_empty(tmp_path: Path):
 
 def test_cache_files_does_not_exist(tmp_path: Path):
     path = tmp_path / "does_not_exist"
-    cache = PersistentCache(path)
+    cache = FileCache(path)
     assert cache._path == path
     assert cache.get_files() == []
     assert cache.get_dataset_files() == []
@@ -39,7 +39,7 @@ def test_cache_reader(tmp_path: Path):
             ("some_str", pa.string()),
         ]
     )
-    with PersistentCacheWriter.create(
+    with FileCacheWriter.create(
         path=tmp_path / "cache",
         schema=schema,
         batch_size=batch_size,
@@ -57,7 +57,7 @@ def test_cache_reader(tmp_path: Path):
         )
 
         writer.write_table(tbl)
-        reader = PersistentCacheReader.load(tmp_path / "cache")
+        reader = FileCacheReader.load(tmp_path / "cache")
         assert set(reader.get_files()) == set(
             [
                 tmp_path / "cache" / "000000.parquet",
@@ -99,7 +99,7 @@ def test_cache_reader(tmp_path: Path):
 def test_cache_reader_does_not_exist(tmp_path: Path):
     path = tmp_path / "does_not_exist"
     with pytest.raises(FileNotFoundError):
-        PersistentCacheReader.load(path)
+        FileCacheReader.load(path)
 
 
 def test_cache_reader_not_a_directory(tmp_path: Path):
@@ -108,7 +108,7 @@ def test_cache_reader_not_a_directory(tmp_path: Path):
         f.write("hello world")
 
     with pytest.raises(NotADirectoryError):
-        PersistentCacheReader.load(filepath)
+        FileCacheReader.load(filepath)
 
 
 def test_cache_reader_config_error(tmp_path: Path):
@@ -122,13 +122,13 @@ def test_cache_reader_config_error(tmp_path: Path):
         ]
     )
     path = tmp_path / "cache"
-    with PersistentCacheWriter.create(
+    with FileCacheWriter.create(
         path=path,
         schema=schema,
         batch_size=batch_size,
         rows_per_file=rows_per_file,
     ) as writer:
-        reader = PersistentCacheReader.load(writer.path)
+        reader = FileCacheReader.load(writer.path)
         assert reader.path == path
         assert len(reader.get_files()) == 1
         assert reader.get_files() == [path / ".cfg"]
@@ -141,13 +141,13 @@ def test_cache_reader_config_error(tmp_path: Path):
             json.dump({}, f, indent=2)
 
         with pytest.raises(KeyError):
-            PersistentCacheReader.load(writer.path)
+            FileCacheReader.load(writer.path)
 
 
 def test_cache_write_batch(tmp_path: Path):
     batch_size = 10
     rows_per_file = 100
-    with PersistentCacheWriter.create(
+    with FileCacheWriter.create(
         path=tmp_path / "cache",
         schema=pa.schema(
             [
@@ -170,7 +170,7 @@ def test_cache_write_batch(tmp_path: Path):
         writer.flush()
         assert len(writer.get_files()) == 11
 
-        reader = PersistentCacheReader.load(writer.path)
+        reader = FileCacheReader.load(writer.path)
         assert reader.count_rows() == 1000
         for idx, tbl in enumerate(reader.iterate_tables()):
             assert tbl["some_int"].to_pylist() == [
@@ -190,7 +190,7 @@ def test_cache_write_batch(tmp_path: Path):
 def test_cache_write_rows(tmp_path: Path):
     batch_size = 10
     rows_per_file = 100
-    with PersistentCacheWriter.create(
+    with FileCacheWriter.create(
         path=tmp_path / "cache",
         schema=pa.schema(
             [
@@ -219,7 +219,7 @@ def test_cache_write_rows(tmp_path: Path):
         writer.flush()
         assert len(writer.get_files()) == 11
 
-        reader = PersistentCacheReader.load(writer.path)
+        reader = FileCacheReader.load(writer.path)
         assert reader.count_rows() == 1000
         for idx, tbl in enumerate(reader.iterate_tables()):
             assert tbl["some_int"].to_pylist() == [
@@ -239,7 +239,7 @@ def test_cache_write_rows(tmp_path: Path):
 def test_cache_write_table(tmp_path: Path):
     batch_size = 10
     rows_per_file = 100
-    with PersistentCacheWriter.create(
+    with FileCacheWriter.create(
         path=tmp_path / "cache",
         schema=pa.schema(
             [
@@ -267,7 +267,7 @@ def test_cache_write_table(tmp_path: Path):
         assert len(writer.get_files()) == 3
         writer.flush()
 
-        reader = PersistentCacheReader.load(writer.path)
+        reader = FileCacheReader.load(writer.path)
         assert reader.count_rows() == 202
         for tbl in reader.iterate_tables():
             assert tbl["some_int"].to_pylist() == [i for i in range(101)]
@@ -280,7 +280,7 @@ def test_cache_write_table(tmp_path: Path):
 def test_cache_delete(tmp_path: Path):
     batch_size = 10
     rows_per_file = 100
-    with PersistentCacheWriter.create(
+    with FileCacheWriter.create(
         path=tmp_path / "cache",
         schema=pa.schema(
             [
@@ -308,7 +308,7 @@ def test_cache_delete(tmp_path: Path):
         assert len(writer.get_files()) == 3
         writer.flush()
 
-        reader = PersistentCacheReader.load(path=writer.path)
+        reader = FileCacheReader.load(path=writer.path)
         assert reader.count_rows() == 202
         for tbl in reader.iterate_tables():
             assert tbl["some_int"].to_pylist() == [i for i in range(101)]