Add generate subparser to pylint-config

Author: DanielNoord

pylint/config/_pylint_config/__init__.py

@@ -7,4 +7,5 @@
 Everything in this module is private.
 """
 
+from pylint.config._pylint_config.main import _handle_pylint_config_commands  # noqa
 from pylint.config._pylint_config.setup import _register_generate_config_options  # noqa

pylint/config/_pylint_config/generate_command.py

@@ -0,0 +1,40 @@
+# Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
+# For details: https://github.com/PyCQA/pylint/blob/main/LICENSE
+# Copyright (c) https://github.com/PyCQA/pylint/blob/main/CONTRIBUTORS.txt
+
+"""Everything related to the 'pylint-config generate' command."""
+
+
+from __future__ import annotations
+
+import warnings
+from typing import TYPE_CHECKING
+
+from pylint.config._pylint_config import utils
+from pylint.config._pylint_config.help_message import get_subparser_help
+
+if TYPE_CHECKING:
+    from pylint.lint.pylinter import PyLinter
+
+
+def generate_interactive_config(linter: PyLinter) -> None:
+    print("Starting interactive pylint configuration generation")
+
+    format_type = utils.get_and_validate_format()
+
+    if format_type == "toml":
+        linter._generate_config_file()
+    else:
+        with warnings.catch_warnings():
+            warnings.filterwarnings("ignore", category=DeprecationWarning)
+            linter.generate_config(skipsections=("Commands",))
+
+
+def handle_generate_command(linter: PyLinter) -> int:
+    """Handle 'pylint-config generate'."""
+    # Interactively generate a pylint configuration
+    if linter.config.interactive:
+        generate_interactive_config(linter)
+        return 0
+    print(get_subparser_help(linter, "generate"))
+    return 32

pylint/config/_pylint_config/main.py

@@ -0,0 +1,25 @@
+# Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
+# For details: https://github.com/PyCQA/pylint/blob/main/LICENSE
+# Copyright (c) https://github.com/PyCQA/pylint/blob/main/CONTRIBUTORS.txt
+
+"""Everything related to the 'pylint-config' command."""
+
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from pylint.config._pylint_config.generate_command import handle_generate_command
+from pylint.config._pylint_config.help_message import get_help
+
+if TYPE_CHECKING:
+    from pylint.lint.pylinter import PyLinter
+
+
+def _handle_pylint_config_commands(linter: PyLinter) -> int:
+    """Handle whichever command is passed to 'pylint-config'."""
+    if linter.config.config_subcommand == "generate":
+        return handle_generate_command(linter)
+
+    print(get_help(linter._arg_parser))
+    return 32

pylint/config/_pylint_config/utils.py

@@ -0,0 +1,33 @@
+# Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
+# For details: https://github.com/PyCQA/pylint/blob/main/LICENSE
+# Copyright (c) https://github.com/PyCQA/pylint/blob/main/CONTRIBUTORS.txt
+
+"""Utils for the 'pylint-config' command."""
+
+
+import sys
+
+if sys.version_info >= (3, 8):
+    from typing import Literal
+else:
+    from typing_extensions import Literal
+
+
+SUPPORTED_FORMATS = {"t", "toml", "i", "ini"}
+
+
+def get_and_validate_format() -> Literal["toml", "ini"]:
+    """Make sure that the output format is either .toml or .ini."""
+    # pylint: disable-next=bad-builtin
+    format_type = input(
+        "Please choose the format of configuration, (T)oml or (I)ni (.cfg): "
+    ).lower()
+
+    if format_type not in SUPPORTED_FORMATS:
+        raise ValueError(
+            f"Format should be one of {', '.join(i.capitalize() for i in sorted(SUPPORTED_FORMATS))}"
+        )
+
+    if format_type.startswith("t"):
+        return "toml"
+    return "ini"

pylint/lint/run.py

@@ -13,6 +13,7 @@
 
 from pylint import config
 from pylint.config._pylint_config import (
+    _handle_pylint_config_commands,
     _register_generate_config_options,
 )
 from pylint.config.config_initialization import _config_initialization
@@ -149,6 +150,17 @@ def __init__(
             linter, args, reporter, config_file=self._rcfile, verbose_mode=self.verbose
         )
 
+        # Handle the 'pylint-config' command
+        if self._is_pylint_config:
+            warnings.warn(
+                "NOTE: The 'pylint-config' command is experimental and usage can change",
+                UserWarning,
+            )
+            code = _handle_pylint_config_commands(linter)
+            if exit:
+                sys.exit(code)
+            return
+
         # Display help messages if there are no files to lint
         if not args:
             print(linter.help())

tests/config/pylint_config/test_pylint_config_generate.py

@@ -0,0 +1,69 @@
+# Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
+# For details: https://github.com/PyCQA/pylint/blob/main/LICENSE
+# Copyright (c) https://github.com/PyCQA/pylint/blob/main/CONTRIBUTORS.txt
+
+"""Test for the 'pylint-config generate' command."""
+
+
+import warnings
+
+import pytest
+from pytest import CaptureFixture, MonkeyPatch
+
+from pylint.lint.run import _PylintConfigRun as Run
+
+
+def test_generate_interactive_exitcode(monkeypatch: MonkeyPatch) -> None:
+    """Check that we exit correctly based on different parameters."""
+    # Monkeypatch everything we don't want to check in this test
+    monkeypatch.setattr(
+        "pylint.config._pylint_config.utils.get_and_validate_format", lambda: "toml"
+    )
+
+    with warnings.catch_warnings():
+        warnings.filterwarnings("ignore", message="NOTE:.*", category=UserWarning)
+        with pytest.raises(SystemExit) as ex:
+            Run(["generate", "--interactive"])
+        assert ex.value.code == 0
+
+        Run(["generate", "--interactive"], exit=False)
+
+
+def test_format_of_output(
+    monkeypatch: MonkeyPatch, capsys: CaptureFixture[str]
+) -> None:
+    """Check that we output the correct format."""
+    # Set the answers needed for the input() calls
+    answers = iter(["T", "toml", "TOML", "I", "INI", "TOMLINI"])
+    monkeypatch.setattr("builtins.input", lambda x: next(answers))
+
+    with warnings.catch_warnings():
+        warnings.filterwarnings("ignore", message="NOTE:.*", category=UserWarning)
+        # Check 'T'
+        Run(["generate", "--interactive"], exit=False)
+        captured = capsys.readouterr()
+        assert "[tool.pylint.main]" in captured.out
+
+        # Check 'toml'
+        Run(["generate", "--interactive"], exit=False)
+        captured = capsys.readouterr()
+        assert "[tool.pylint.main]" in captured.out
+
+        # Check 'TOML'
+        Run(["generate", "--interactive"], exit=False)
+        captured = capsys.readouterr()
+        assert "[tool.pylint.main]" in captured.out
+
+        # Check 'I'
+        Run(["generate", "--interactive"], exit=False)
+        captured = capsys.readouterr()
+        assert "[MAIN]" in captured.out
+
+        # Check 'INI'
+        Run(["generate", "--interactive"], exit=False)
+        captured = capsys.readouterr()
+        assert "[MAIN]" in captured.out
+
+        # Check 'TOMLINI'
+        with pytest.raises(ValueError, match="Format should be one.*"):
+            Run(["generate", "--interactive"], exit=False)