more specific warnings

pandas-dev · attack68 · Nov 12, 2021 · Nov 12, 2021 · Nov 12, 2021 · Nov 12, 2021
commit d859877d18fdcb39c1df46bfc7c2d4d1f90de81f
diff --git a/pandas/core/frame.py b/pandas/core/frame.py
@@ -2911,14 +2911,51 @@ def to_html(
         Styler.to_html : Render a DataFrame to HTML with conditional formatting.
         to_string : Convert DataFrame to a string.
         """
-        msg = (
+        # Warnings are shown in 1.4.0 in preparation for signature changes in 2.0.0
+        warnings_default_none = {
+            "classes": "replaced by `table_attributes`",
+            "sparsify": "replaced by `sparse_index` and `sparse_columns`",
+            "max_cols": "replaced by `max_columns` for consistency",
+            "formatters": "replaced by `formatter` accepted by `Styler.format`",
+            "float_format": "replaced by `precision`, `decimal`, and `thousands`",
+            "border": "removed as deprecated HTML, suggested to use CSS",
+            "col_space": "removed, suggested to use CSS `min-width: 100px;`",
+            "justify": "removed, suggested to use CSS",
+        }
+
+        warnings_default_false = {
+            "render_links": "removed due to limited functionality",
+            "notebook": "removed as a legacy argument",
+            "show_dimensions": "removed, suggested to use `caption=f'{df.shape}'`",
+        }
+
+        warnings_default_true = {
+            "bold_rows": "replaced by `bold_headers` controlling index and columns",
+        }
+
+        warning_msg = (
             "In future versions `DataFrame.to_html` is expected to utilise the base "
             "implementation of `Styler.to_html` for formatting and rendering. "
-            "The arguments signature may therefore change. It is recommended instead "
-            "to use `DataFrame.style.to_html` which also contains additional "
-            "functionality."
+            "The arguments signature may therefore change. You are specifically using "
+            "the following arguments: "
         )
-        warnings.warn(msg, FutureWarning, stacklevel=find_stack_level())
+        warning_flag = False
+
+        for kwarg, msg in warnings_default_none.items():
+            if locals()[kwarg] is not None:
+                warning_flag = True
+                warning_msg += f"\n    `{kwarg}`, which may be {msg}."
+        for kwarg, msg in warnings_default_false.items():
+            if locals()[kwarg] is True:
+                warning_flag = True
+                warning_msg += f"\n    `{kwarg}`, which may be {msg}."
+        for kwarg, msg in warnings_default_true.items():
+            if locals()[kwarg] is False:
+                warning_flag = True
+                warning_msg += f"\n    `{kwarg}`, which may be {msg}."
+
+        if warning_flag:
+            warnings.warn(warning_msg, FutureWarning, stacklevel=find_stack_level())
 
         if justify is not None and justify not in fmt._VALID_JUSTIFY_PARAMETERS:
             raise ValueError("Invalid value for justify parameter")

diff --git a/pandas/tests/io/formats/test_format.py b/pandas/tests/io/formats/test_format.py
@@ -3299,7 +3299,6 @@ def test_repr_html_ipython_config(ip):
 
 
 @pytest.mark.filterwarnings("ignore:In future versions `DataFrame.to_latex`")
-@pytest.mark.filterwarnings("ignore:In future versions `DataFrame.to_html`")
 @pytest.mark.parametrize("method", ["to_string", "to_html", "to_latex"])
 @pytest.mark.parametrize(
     "encoding, data",
@@ -3321,7 +3320,7 @@ def test_filepath_or_buffer_arg(
         ):
             getattr(df, method)(buf=filepath_or_buffer, encoding=encoding)
     elif encoding == "foo":
-        expected_warning = FutureWarning if method in ["to_latex", "to_html"] else None
+        expected_warning = FutureWarning if method in ["to_latex"] else None
         with tm.assert_produces_warning(expected_warning):
             with pytest.raises(LookupError, match="unknown encoding"):
                 getattr(df, method)(buf=filepath_or_buffer, encoding=encoding)

diff --git a/pandas/tests/io/formats/test_to_html.py b/pandas/tests/io/formats/test_to_html.py
@@ -876,14 +876,48 @@ def test_to_html_float_format_object_col(datapath):
     assert result == expected
 
 
-def test_future_warning():
+@pytest.mark.parametrize(
+    "kw1, kw1_val, kw1_msg",
+    [
+        ("classes", "text", "replaced by `table_attributes`"),
+        ("sparsify", True, "replaced by `sparse_index` and `sparse_columns`"),
+        ("max_cols", 1, "replaced by `max_columns` for consistency"),
+        ("formatters", [None], "replaced by `formatter` accepted by `Styler.format`"),
+        ("float_format", "txt", "replaced by `precision`, `decimal`, and `thousands`"),
+        ("border", 10, "removed as deprecated HTML, suggested to use CSS"),
+        ("col_space", 1, "removed, suggested to use CSS `min-width: 100px;`"),
+        ("justify", "right", "removed, suggested to use CSS"),
+    ],
+)
+@pytest.mark.parametrize(
+    "kw2, kw2_val, kw2_msg",
+    [
+        ("render_links", True, "removed due to limited functionality"),
+        ("notebook", True, "removed as a legacy argument"),
+        ("show_dimensions", True, "removed, suggested to use `caption=f'{df.shape}'`"),
+        (
+            "bold_rows",
+            False,
+            "replaced by `bold_headers` controlling index and columns",
+        ),
+    ],
+)
+def test_future_warning(kw1, kw1_val, kw1_msg, kw2, kw2_val, kw2_msg):
     df = DataFrame([[1]])
     msg = (
         "In future versions `DataFrame.to_html` is expected to utilise the base "
         "implementation of `Styler.to_html` for formatting and rendering. "
-        "The arguments signature may therefore change. It is recommended instead "
-        "to use `DataFrame.style.to_html` which also contains additional "
-        "functionality."
+        "The arguments signature may therefore change. You are specifically using "
+        "the following arguments: "
     )
+    msg += f"\\n    `{kw1}`, which may be {kw1_msg}."
+    msg += f"\\n    `{kw2}`, which may be {kw2_msg}."
+
     with tm.assert_produces_warning(FutureWarning, match=msg):
+        df.to_html(**{kw1: kw1_val, kw2: kw2_val})
+
+
+def test_no_future_warning():
+    df = DataFrame([[1]])
+    with tm.assert_produces_warning(None):
         df.to_html()