DEPR: make arguments keyword only in to_clipboard (#54634)

* made arguments keyword only

* added whatsnew

* deprecated nonkeyword arguments

* corrected typo

* Update pandas/core/generic.py

Co-authored-by: Matthew Roeschke <[email protected]>

* added test

---------

Co-authored-by: Matthew Roeschke <[email protected]>

Author: rsm-23

doc/source/whatsnew/v2.2.0.rst

@@ -92,6 +92,7 @@ Other API changes
 
 Deprecations
 ~~~~~~~~~~~~
+- Deprecated allowing non-keyword arguments in :meth:`DataFrame.to_clipboard`. (:issue:`54229`)
 - Deprecated allowing non-keyword arguments in :meth:`DataFrame.to_csv` except ``path_or_buf``. (:issue:`54229`)
 - Deprecated allowing non-keyword arguments in :meth:`DataFrame.to_hdf` except ``path_or_buf``. (:issue:`54229`)
 - Deprecated allowing non-keyword arguments in :meth:`DataFrame.to_html` except ``buf``. (:issue:`54229`)

pandas/core/generic.py

@@ -3096,6 +3096,9 @@ def to_pickle(
         )
 
     @final
+    @deprecate_nonkeyword_arguments(
+        version="3.0", allowed_args=["self"], name="to_clipboard"
+    )
     def to_clipboard(
         self, excel: bool_t = True, sep: str | None = None, **kwargs
     ) -> None:

pandas/tests/io/test_clipboard.py

@@ -471,3 +471,13 @@ def test_invalid_dtype_backend(self):
         )
         with pytest.raises(ValueError, match=msg):
             read_clipboard(dtype_backend="numpy")
+
+    def test_to_clipboard_pos_args_deprecation(self):
+        # GH-54229
+        df = DataFrame({"a": [1, 2, 3]})
+        msg = (
+            r"Starting with pandas version 3.0 all arguments of to_clipboard "
+            r"will be keyword-only."
+        )
+        with tm.assert_produces_warning(FutureWarning, match=msg):
+            df.to_clipboard(True, None)