type dataframe.replace

pandas-stubs/core/frame.pyi

@@ -799,23 +799,53 @@ class DataFrame(NDFrame, OpsMixin, _GetItemHack):
     @overload
     def replace(
         self,
-        to_replace=...,
-        value: Scalar | NAType | Sequence | Mapping | Pattern | None = ...,
+        to_replace: (
+            Scalar
+            | NAType
+            | Sequence[Scalar | Pattern]
+            | Mapping[Hashable, Scalar | Pattern]
+            | Pattern
+            | None
+        ) = ...,
+        value: (
+            Scalar | NAType | Sequence[Scalar] | Mapping[Hashable, Scalar] | None
+        ) = ...,
         *,
         inplace: Literal[True],
         limit: int | None = ...,
-        regex=...,
+        regex: (
+            bool
+            | str
+            | Pattern
+            | Sequence[str | Pattern]
+            | Mapping[Hashable, str | Pattern]
+        ) = ...,
         method: ReplaceMethod = ...,
     ) -> None: ...
     @overload
     def replace(
         self,
-        to_replace=...,
-        value: Scalar | NAType | Sequence | Mapping | Pattern | None = ...,
+        to_replace: (
+            Scalar
+            | NAType
+            | Sequence[Scalar | Pattern]
+            | Mapping[Hashable, Scalar | Pattern]
+            | Pattern
+            | None
+        ) = ...,
+        value: (
+            Scalar | NAType | Sequence[Scalar] | Mapping[Hashable, Scalar] | None
+        ) = ...,
         *,
         inplace: Literal[False] = ...,
         limit: int | None = ...,
-        regex=...,
+        regex: (
+            bool
+            | str
+            | Pattern
+            | Sequence[str | Pattern]
+            | Mapping[Hashable, str | Pattern]
+        ) = ...,
         method: ReplaceMethod = ...,
     ) -> Self: ...
     def shift(

tests/test_frame.py

@@ -14,6 +14,7 @@
 import io
 import itertools
 from pathlib import Path
+import re
 import string
 import sys
 from typing import (
@@ -2570,6 +2571,38 @@ def test_types_replace() -> None:
     assert assert_type(df.replace(1, 2, inplace=True), None) is None
 
 
+def test_dataframe_replace() -> None:
+    df = pd.DataFrame({"col1": ["a", "ab", "ba"]})
+    pattern = re.compile(r"^a.*")
+    check(assert_type(df.replace("a", "x"), pd.DataFrame), pd.DataFrame)
+    check(assert_type(df.replace(pattern, "x"), pd.DataFrame), pd.DataFrame)
+    check(
+        assert_type(df.replace({"col1": "a"}, {"col1": "x"}), pd.DataFrame),
+        pd.DataFrame,
+    )
+    check(
+        assert_type(df.replace({"col1": pattern}, {"col1": "x"}), pd.DataFrame),
+        pd.DataFrame,
+    )
+    check(assert_type(df.replace(["a"], ["x"]), pd.DataFrame), pd.DataFrame)
+    check(assert_type(df.replace([pattern], ["x"]), pd.DataFrame), pd.DataFrame)
+    check(assert_type(df.replace("^a.*", "x", regex=True), pd.DataFrame), pd.DataFrame)
+    check(assert_type(df.replace(value="x", regex="^a."), pd.DataFrame), pd.DataFrame)
+    check(assert_type(df.replace(value="x", regex=["^a."]), pd.DataFrame), pd.DataFrame)
+    check(
+        assert_type(df.replace(value="x", regex={"col1": "^a."}), pd.DataFrame),
+        pd.DataFrame,
+    )
+    check(assert_type(df.replace(value="x", regex=pattern), pd.DataFrame), pd.DataFrame)
+    check(
+        assert_type(df.replace(value="x", regex=[pattern]), pd.DataFrame), pd.DataFrame
+    )
+    check(
+        assert_type(df.replace(value="x", regex={"col1": pattern}), pd.DataFrame),
+        pd.DataFrame,
+    )
+
+
 def test_loop_dataframe() -> None:
     # GH 70
     df = pd.DataFrame({"x": [1, 2, 3]})