fix signature of frame.filter (#964)

items can be ListLike
pandas-dev · Aug 2, 2024 · c88d050 · c88d050
1 parent 7e6aee4
commit c88d050
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/pandas-stubs/core/frame.pyi b/pandas-stubs/core/frame.pyi
@@ -1711,7 +1711,7 @@ class DataFrame(NDFrame, OpsMixin):
     ) -> DataFrame: ...
     def filter(
         self,
-        items: list | None = ...,
+        items: ListLike | None = ...,
         like: _str | None = ...,
         regex: _str | None = ...,
         axis: Axis | None = ...,

diff --git a/tests/test_frame.py b/tests/test_frame.py
@@ -319,6 +319,8 @@ def test_types_filter() -> None:
     df.filter(items=["col1"])
     df.filter(regex="co.*")
     df.filter(like="1")
+    # [PR 964] Docs state `items` is `list-like`
+    df.filter(items=("col2", "col2", 1, tuple([4])))
 
 
 def test_types_setting() -> None: