Preserve reader_protocol only

Author: haochengxia

libCacheSim-python/libcachesim/__init__.pyi

@@ -3,7 +3,7 @@ from typing import bool, int, str, tuple
 from collections.abc import Iterator
 
 from .libcachesim_python import ReqOp, TraceType, SamplerType
-from .protocols import ReaderProtocol, CacheProtocol
+from .protocols import ReaderProtocol
 
 class Request:
     clock_time: int
@@ -59,8 +59,8 @@ class Cache:
     def get_n_obj(self) -> int: ...
     def print_cache(self) -> str: ...
 
-class CacheBase(CacheProtocol):
-    """Base class implementing CacheProtocol"""
+class CacheBase:
+    """Base class for all cache implementations"""
     def __init__(self, _cache: Cache): ...
     def get(self, req: Request) -> bool: ...
     def find(self, req: Request, update_cache: bool = True) -> CacheObject: ...
@@ -219,6 +219,7 @@ def create_zipf_requests(
     start_obj_id: int = 0,
     seed: int | None = None,
 ) -> Iterator[Request]: ...
+
 def create_uniform_requests(
     num_objects: int,
     num_requests: int,
@@ -230,8 +231,9 @@ def create_uniform_requests(
 
 # Analyzer
 class TraceAnalyzer:
-    def __init__(self, analyzer): ...
-    def analyze(self, reader: ReaderProtocol, output_path: str, analysis_param, analysis_option) -> None: ...
+    def __init__(self, analyzer, reader: ReaderProtocol, output_path: str, analysis_param, analysis_option): ...
+    def run(self) -> None: ...
+    def cleanup(self) -> None: ...
 
 # Utilities
 class Util:

libCacheSim-python/libcachesim/cache.py

@@ -40,11 +40,11 @@
     c_process_trace,
 )
 
-from .protocols import CacheProtocol, ReaderProtocol
+from .protocols import ReaderProtocol
 
 
-class CacheBase(CacheProtocol):
-    """Base class for all cache implementations that implements CacheProtocol"""
+class CacheBase(ABC):
+    """Base class for all cache implementations"""
 
     _cache: Cache  # Internal C++ cache object
 

libCacheSim-python/libcachesim/protocols.py

@@ -1,71 +1,34 @@
-from __future__ import annotations
-
-from typing import Protocol, TYPE_CHECKING
-
-if TYPE_CHECKING:
-    from .libcachesim_python import Request, CacheObject, Reader, Analyzer
-
-
-class CacheProtocol(Protocol):
-    def get(self, req: Request) -> bool: ...
-
-    def find(self, req: Request, update_cache: bool = True) -> CacheObject: ...
-
-    def can_insert(self, req: Request) -> bool: ...
+"""
+Reader protocol for libCacheSim Python bindings.
 
-    def insert(self, req: Request) -> CacheObject: ...
+ReaderProtocol defines the interface contract for trace readers,
+enabling different implementations (Python/C++) to work interchangeably.
+"""
 
-    def need_eviction(self, req: Request) -> bool: ...
-
-    def evict(self, req: Request) -> CacheObject: ...
-
-    def remove(self, obj_id: int) -> bool: ...
-
-    def to_evict(self, req: Request) -> CacheObject: ...
-
-    def get_occupied_byte(self) -> int: ...
-
-    def get_n_obj(self) -> int: ...
-
-    def print_cache(self) -> str: ...
+from __future__ import annotations
+from typing import Protocol, runtime_checkable, TYPE_CHECKING
 
-    def process_trace(self, reader: "ReaderProtocol", start_req: int = 0, max_req: int = -1) -> tuple[float, float]: ...
+if TYPE_CHECKING:
+    from .libcachesim_python import Request
 
-    # Properties
-    @property
-    def cache_size(self) -> int: ...
 
-    @property
-    def cache_name(self) -> str: ...
+@runtime_checkable
+class ReaderProtocol(Protocol):
+    """Protocol for trace readers
 
+    This protocol ensures that different reader implementations
+    (SyntheticReader, TraceReader) can be used interchangeably.
+    """
 
-class ReaderProtocol(Protocol):
     def get_num_of_req(self) -> int: ...
-
     def read_one_req(self, req: Request) -> Request: ...
-
     def reset(self) -> None: ...
-
     def close(self) -> None: ...
-
-    def clone(self) -> ReaderProtocol: ...
-
+    def clone(self) -> "ReaderProtocol": ...
     def read_first_req(self, req: Request) -> Request: ...
-
     def read_last_req(self, req: Request) -> Request: ...
-
     def skip_n_req(self, n: int) -> int: ...
-
     def read_one_req_above(self, req: Request) -> Request: ...
-
     def go_back_one_req(self) -> None: ...
-
     def set_read_pos(self, pos: float) -> None: ...
-
     def get_read_pos(self) -> float: ...
-
-
-class AnalyzerProtocol(Protocol):
-    def run(self) -> None: ...
-
-    def cleanup(self) -> None: ...

libCacheSim-python/libcachesim/trace_analyzer.py

@@ -1,6 +1,10 @@
 """Wrapper of Analyzer"""
+from __future__ import annotations
 
-from .protocols import ReaderProtocol, AnalyzerProtocol
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from .protocols import ReaderProtocol
 
 from .libcachesim_python import (
     Analyzer,
@@ -9,7 +13,7 @@
 )
 
 
-class TraceAnalyzer(AnalyzerProtocol):
+class TraceAnalyzer:
     _analyzer: Analyzer
 
     def __init__(

libCacheSim-python/libcachesim/util.py

@@ -1,9 +1,11 @@
 """Wrapper misc functions"""
+from __future__ import annotations
 
 from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
-    from .protocols import CacheProtocol, ReaderProtocol
+    from .protocols import ReaderProtocol
+    from .cache import CacheBase
 
 from .libcachesim_python import convert_to_oracleGeneral, convert_to_lcs, c_process_trace
 
@@ -28,9 +30,7 @@ def convert_to_lcs(reader, ofilepath, output_txt=False, remove_size_change=False
         return convert_to_lcs(reader, ofilepath, output_txt, remove_size_change, lcs_ver)
 
     @staticmethod
-    def process_trace(
-        cache: "CacheProtocol", reader: "ReaderProtocol", start_req: int = 0, max_req: int = -1
-    ) -> tuple[float, float]:
+    def process_trace(cache: CacheBase, reader: ReaderProtocol, start_req: int = 0, max_req: int = -1) -> tuple[float, float]:
         """
         Process a trace with a cache.
 
@@ -44,7 +44,7 @@ def process_trace(
             tuple[float, float]: The object miss ratio and byte miss ratio.
         """
         # Check if reader is C++ reader
-        if not hasattr(reader, "c_reader") or not reader.c_reader:
+        if not hasattr(reader, 'c_reader') or not reader.c_reader:
             raise ValueError("Reader must be a C++ reader")
 
         return c_process_trace(cache._cache, reader._reader, start_req, max_req)