Add automatically generated options

Author: Pierre-Sassoulas

pydocstringformatter/formatting/__init__.py

@@ -1,11 +1,14 @@
 __all__ = ["FORMATTERS"]
 
+from typing import List
+
+from pydocstringformatter.formatting.base import Formatter
 from pydocstringformatter.formatting.formatter import (
     BeginningQuotesFormatter,
     ClosingQuotesFormatter,
 )
 
-FORMATTERS = [
+FORMATTERS: List[Formatter] = [
     BeginningQuotesFormatter(),
     ClosingQuotesFormatter(),
 ]

pydocstringformatter/formatting/base.py

@@ -5,7 +5,7 @@
 class Formatter:
     """Base class for docstring formatter"""
 
-    optional: bool = False
+    optional = False
     name: str
 
     @abc.abstractmethod

pydocstringformatter/run.py

@@ -9,13 +9,17 @@
 from typing import List, Union
 
 from pydocstringformatter import __version__, formatting, utils
+from pydocstringformatter.formatting import FORMATTERS
 
 
 class _Run:
     """Main class that represent a run of the program"""
 
     def __init__(self, argv: Union[List[str], None]) -> None:
         self.arg_parser = utils._register_arguments(__version__)
+        self.arg_parser = utils._register_arguments_formatters(
+            self.arg_parser, FORMATTERS
+        )
         self.config = argparse.Namespace()
 
         if argv := argv or sys.argv[1:]:
@@ -46,10 +50,11 @@ def _format_file(self, filename: Path) -> bool:
 
         for index, tokeninfo in enumerate(tokens):
             new_tokeninfo = tokeninfo
-
+            formatter_options = vars(self.config)
             if utils._is_docstring(new_tokeninfo, tokens[index - 1]):
                 for formatter in formatting.FORMATTERS:
-                    new_tokeninfo = formatter.treat_token(new_tokeninfo)
+                    if formatter_options[formatter.name]:
+                        new_tokeninfo = formatter.treat_token(new_tokeninfo)
             changed_tokens.append(new_tokeninfo)
 
             if tokeninfo != new_tokeninfo:

pydocstringformatter/utils/__init__.py

@@ -2,6 +2,7 @@
     _parse_command_line_arguments,
     _parse_toml_file,
     _register_arguments,
+    _register_arguments_formatters,
 )
 from pydocstringformatter.utils.exceptions import (
     ParsingError,
@@ -20,4 +21,5 @@
     "ParsingError",
     "_parse_toml_file",
     "TomlParsingError",
+    "_register_arguments_formatters",
 ]

pydocstringformatter/utils/argument_parsing.py

@@ -4,6 +4,7 @@
 
 import tomli
 
+from pydocstringformatter.formatting.base import Formatter
 from pydocstringformatter.utils.exceptions import TomlParsingError, UnrecognizedOption
 
 OPTIONS_TYPES = {"write": "store_true"}
@@ -19,24 +20,40 @@ def _parse_command_line_arguments(
 def _register_arguments(version: str) -> argparse.ArgumentParser:
     """Create an argument parser and add all supported arguments"""
     parser = argparse.ArgumentParser(prog="pydocstringformatter")
-
     parser.add_argument("files", nargs="*", type=str)
-
     parser.add_argument(
         "-w",
         "--write",
         action="store_true",
         help="Write the changes to file instead of printing the files to stdout",
     )
-
     parser.add_argument(
         "-v",
         "--version",
         action="version",
         version=version,
         help="Show version number and exit",
     )
+    return parser
+
 
+def _register_arguments_formatters(
+    parser: argparse.ArgumentParser, formatters: List[Formatter]
+) -> argparse.ArgumentParser:
+    """Register a list of formatters, so they can all be deactivated or activated."""
+    for formatter in formatters:
+        name = formatter.name
+        help_text = f"ctivate the {name} formatter"
+        parser.add_argument(
+            f"--{name}",
+            action="store_true",
+            dest=name,
+            default=not formatter.optional,
+            help=f"A{help_text} : {formatter.__doc__}",
+        )
+        parser.add_argument(
+            f"--no-{name}", action="store_false", dest=name, help=f"Dea{help_text}"
+        )
     return parser
 
 

tests/test_run.py

@@ -12,9 +12,13 @@ def test_no_arguments(capsys: pytest.CaptureFixture[str]) -> None:
     """Test that we warn when no arguments are provided"""
     sys.argv = ["pydocstringformatter"]
     pydocstringformatter.run_docstring_formatter()
-    output = capsys.readouterr()
-    assert output.out.startswith("usage: pydocstringformatter [-h]")
-    assert not output.err
+    out, err = capsys.readouterr()
+    assert out.startswith("usage: pydocstringformatter [-h]")
+    assert "--beginning-quotes" in out
+    assert "Activate the beginning-quotes formatter" in out
+    assert "--no-beginning-quotes" in out
+    assert "Deactivate the beginning-quotes formatter" in out
+    assert not err
 
 
 def test_sys_agv_as_arguments(