deprecated non keyword arguments

rsm-23 · Aug 17, 2023 · e04e1f7 · e04e1f7
1 parent 7c9ba89
commit e04e1f7
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 1 deletion.
diff --git a/doc/source/whatsnew/v2.2.0.rst b/doc/source/whatsnew/v2.2.0.rst
@@ -92,7 +92,7 @@ Other API changes
 
 Deprecations
 ~~~~~~~~~~~~
--
+- Deprecated allowing non-keyword arguments in :meth:`DataFrame.to_pickle` except ``path``. (:issue:`54229`)
 -
 
 .. ---------------------------------------------------------------------------

diff --git a/pandas/core/generic.py b/pandas/core/generic.py
@@ -3017,6 +3017,9 @@ def to_sql(
         )
 
     @final
+    @deprecate_nonkeyword_arguments(
+        version=None, allowed_args=["self", "path"], name="to_pickle"
+    )
     @doc(
         storage_options=_shared_docs["storage_options"],
         compression_options=_shared_docs["compression_options"] % "path",

diff --git a/pandas/tests/generic/test_generic.py b/pandas/tests/generic/test_generic.py
@@ -460,3 +460,13 @@ def test_bool_dep(self) -> None:
         )
         with tm.assert_produces_warning(FutureWarning, match=msg_warn):
             DataFrame({"col": [False]}).bool()
+
+    def test_drop_pos_args_deprecation_for_to_pickle(self):
+        # GH-54229
+        df = DataFrame({"a": [1, 2, 3]})
+        msg = (
+            r"In a future version of pandas all arguments of to_pickle "
+            r"except for the argument 'path' will be keyword-only"
+        )
+        with tm.assert_produces_warning(FutureWarning, match=msg):
+            df.to_pickle("./dummy.pkl", "infer")