Remove ParserExtensionInterface.add_cli_options

Author: hukkin

docs/users/changelog.md

@@ -7,6 +7,7 @@ Note that there is currently no guarantee for a stable Markdown formatting style
 
 - Removed
   - `mdformat.codepoints.ASCII_WHITESPACE` (deprecated since 0.7.20)
+  - `mdformat.plugins.ParserExtensionInterface.add_cli_options` (deprecated since 0.7.19)
 - Fixed
   - Read UTF-8 from standard input on all systems.
     Thank you, [Christopher Prohm](https://github.com/chmp), for the PR.

src/mdformat/_cli.py

@@ -283,20 +283,6 @@ def make_arg_parser(
         dest="codeformatters",
         help=argparse.SUPPRESS,
     )
-    for plugin in parser_extensions.values():
-        if hasattr(plugin, "add_cli_options"):
-            import warnings
-
-            plugin_file, plugin_line = get_source_file_and_line(plugin)
-            warnings.warn_explicit(
-                "`mdformat.plugins.ParserExtensionInterface.add_cli_options`"
-                " is deprecated."
-                " Please use `add_cli_argument_group`.",
-                DeprecationWarning,
-                filename=plugin_file,
-                lineno=plugin_line,
-            )
-            plugin.add_cli_options(parser)
     for plugin_id, plugin in parser_extensions.items():
         if hasattr(plugin, "add_cli_argument_group"):
             group = parser.add_argument_group(title=f"{plugin_id} plugin")

src/mdformat/plugins.py

@@ -51,14 +51,6 @@ class ParserExtensionInterface(Protocol):
     # (optional)
     POSTPROCESSORS: Mapping[str, Postprocess]
 
-    @staticmethod
-    def add_cli_options(parser: argparse.ArgumentParser) -> None:
-        """DEPRECATED - use `add_cli_argument_group` instead.
-
-        Add options to the mdformat CLI, to be stored in
-        mdit.options["mdformat"] (optional)
-        """
-
     @staticmethod
     def add_cli_argument_group(group: argparse._ArgumentGroup) -> None:
         """Add an argument group to mdformat CLI and add arguments to it.

tests/test_plugins.py

@@ -172,39 +172,6 @@ def test_table(monkeypatch):
     )
 
 
-class ExamplePluginWithCli:
-    """A plugin that adds CLI options."""
-
-    @staticmethod
-    def update_mdit(mdit: MarkdownIt):
-        mdit.enable("table")
-
-    @staticmethod
-    def add_cli_options(parser: argparse.ArgumentParser) -> None:
-        parser.add_argument("--o1", type=str)
-        parser.add_argument("--o2", type=str, default="a")
-        parser.add_argument("--o3", dest="arg_name", type=int)
-
-
-def test_cli_options(monkeypatch, tmp_path):
-    """Test that CLI arguments added by plugins are correctly added to the
-    options dict."""
-    monkeypatch.setitem(PARSER_EXTENSIONS, "table", ExamplePluginWithCli)
-    file_path = tmp_path / "test_markdown.md"
-    file_path.touch()
-
-    with patch.object(MDRenderer, "render", return_value="") as mock_render:
-        assert run((str(file_path), "--o1", "other", "--o3", "4")) == 0
-
-    (call_,) = mock_render.call_args_list
-    posargs = call_[0]
-    # Options is the second positional arg of MDRender.render
-    opts = posargs[1]
-    assert opts["mdformat"]["o1"] == "other"
-    assert opts["mdformat"]["o2"] == "a"
-    assert opts["mdformat"]["arg_name"] == 4
-
-
 class ExamplePluginWithGroupedCli:
     """A plugin that adds CLI options."""