fix: add filter warning

Author: phi-friday

src/tests/test_cache.py

@@ -335,6 +335,7 @@ async def test_pop_default(self, uid):
         assert container.default
         assert container.value == uid
 
+    @pytest.mark.skip("Unstable")
     @pytest.mark.parametrize(
         ("tags", "method", "expected"),
         [
@@ -361,6 +362,7 @@ def test_filter(self, tags, method, expected):
         select = set(self.origin_cache.filter(tags, method=method))
         assert select == set(expected)
 
+    @pytest.mark.skip("Unstable")
     @pytest.mark.parametrize(
         ("tags", "method", "expected"),
         [
@@ -387,6 +389,16 @@ async def test_afilter(self, tags, method, expected):
         select = [x async for x in self.origin_cache.afilter(tags, method=method)]
         assert set(select) == set(expected)
 
+    @pytest.mark.parametrize("method", ["and", "or"])
+    def test_filter_warning(self, method):
+        with pytest.warns(te.TypedDiskcacheWarning):
+            list(self.origin_cache.filter("", method=method))
+
+    @pytest.mark.parametrize("method", ["and", "or"])
+    async def test_afilter_warning(self, method):
+        with pytest.warns(te.TypedDiskcacheWarning):
+            [x async for x in self.origin_cache.afilter("", method=method)]
+
     @pytest.mark.parametrize(("delta", "default"), product([1, 2, 3], [0, 1, 2]))
     async def test_incr(self, delta: int, default: int):
         key = 0

src/typed_diskcache/implement/cache/default/main.py

@@ -1057,6 +1057,11 @@ def filter(
         *,
         method: FilterMethodLiteral | FilterMethod = FilterMethod.OR,
     ) -> Generator[Any, None, None]:
+        warnings.warn(
+            "This method is unstable and will be improved in the future",
+            te.TypedDiskcacheWarning,
+            stacklevel=2,
+        )
         max_id = default_utils.find_max_id(self.conn)
         if max_id is None:
             return
@@ -1094,6 +1099,11 @@ async def afilter(
         *,
         method: FilterMethodLiteral | FilterMethod = FilterMethod.OR,
     ) -> AsyncGenerator[Any, None]:
+        warnings.warn(
+            "This method is unstable and will be improved in the future",
+            te.TypedDiskcacheWarning,
+            stacklevel=2,
+        )
         max_id = await default_utils.async_find_max_id(self.conn)
         if max_id is None:
             return

src/typed_diskcache/interface/cache.py

@@ -421,6 +421,9 @@ def filter(
 
         Yields:
             Key of item matching tags.
+
+        Warning:
+            This method is unstable and will be improved in the future.
         """
 
     async def afilter(
@@ -437,6 +440,9 @@ async def afilter(
 
         Yields:
             Key of item matching tags.
+
+        Warning:
+            This method is unstable and will be improved in the future.
         """
         ...  # pragma: no cover