Support globbing patterns for source-roots (#8281)

Co-authored-by: Andreas Finkler <3929834+DudeNr33@users.noreply.github.com>

Author: alexey-pelykh

doc/whatsnew/fragments/8290.feature

@@ -0,0 +1,3 @@
+Add globbing pattern support for ``--source-roots``.
+
+Closes #8290

pylint/config/argument.py

@@ -15,6 +15,7 @@
 import re
 import sys
 from collections.abc import Callable
+from glob import glob
 from typing import Any, Pattern, Sequence, Tuple, Union
 
 from pylint import interfaces
@@ -88,13 +89,13 @@ def _path_transformer(value: str) -> str:
     return os.path.expandvars(os.path.expanduser(value))
 
 
-def _paths_csv_transformer(value: str) -> Sequence[str]:
+def _glob_paths_csv_transformer(value: str) -> Sequence[str]:
     """Transforms a comma separated list of paths while expanding user and
-    variables.
+    variables and glob patterns.
     """
     paths: list[str] = []
     for path in _csv_transformer(value):
-        paths.append(os.path.expandvars(os.path.expanduser(path)))
+        paths.extend(glob(_path_transformer(path), recursive=True))
     return paths
 
 
@@ -148,7 +149,7 @@ def _regexp_paths_csv_transfomer(value: str) -> Sequence[Pattern[str]]:
     "confidence": _confidence_transformer,
     "non_empty_string": _non_empty_string_transformer,
     "path": _path_transformer,
-    "paths_csv": _paths_csv_transformer,
+    "glob_paths_csv": _glob_paths_csv_transformer,
     "py_version": _py_version_transformer,
     "regexp": _regex_transformer,
     "regexp_csv": _regexp_csv_transfomer,

pylint/config/option.py

@@ -117,7 +117,7 @@ def _py_version_validator(_: Any, name: str, value: Any) -> tuple[int, int, int]
     "string": utils._unquote,
     "int": int,
     "float": float,
-    "paths_csv": _csv_validator,
+    "glob_paths_csv": _csv_validator,
     "regexp": lambda pattern: re.compile(pattern or ""),
     "regexp_csv": _regexp_csv_validator,
     "regexp_paths_csv": _regexp_paths_csv_validator,
@@ -164,7 +164,7 @@ def _validate(value: Any, optdict: Any, name: str = "") -> Any:
 # pylint: disable=no-member
 class Option(optparse.Option):
     TYPES = optparse.Option.TYPES + (
-        "paths_csv",
+        "glob_paths_csv",
         "regexp",
         "regexp_csv",
         "regexp_paths_csv",
@@ -177,7 +177,7 @@ class Option(optparse.Option):
     )
     ATTRS = optparse.Option.ATTRS + ["hide", "level"]
     TYPE_CHECKER = copy.copy(optparse.Option.TYPE_CHECKER)
-    TYPE_CHECKER["paths_csv"] = _csv_validator
+    TYPE_CHECKER["glob_paths_csv"] = _csv_validator
     TYPE_CHECKER["regexp"] = _regexp_validator
     TYPE_CHECKER["regexp_csv"] = _regexp_csv_validator
     TYPE_CHECKER["regexp_paths_csv"] = _regexp_paths_csv_validator

pylint/lint/base_options.py

@@ -346,12 +346,13 @@ def _make_linter_options(linter: PyLinter) -> Options:
         (
             "source-roots",
             {
-                "type": "paths_csv",
+                "type": "glob_paths_csv",
                 "metavar": "<path>[,<path>...]",
                 "default": (),
-                "help": "Add paths to the list of the source roots. The source root is an absolute "
-                "path or a path relative to the current working directory used to "
-                "determine a package namespace for modules located under the source root.",
+                "help": "Add paths to the list of the source roots. Supports globbing patterns. "
+                "The source root is an absolute path or a path relative to the current working "
+                "directory used to determine a package namespace for modules located under the "
+                "source root.",
             },
         ),
         (

pylint/pyreverse/main.py

@@ -238,12 +238,12 @@
     (
         "source-roots",
         {
-            "type": "paths_csv",
+            "type": "glob_paths_csv",
             "metavar": "<path>[,<path>...]",
             "default": (),
-            "help": "Add paths to the list of the source roots. The source root is an absolute "
-            "path or a path relative to the current working directory used to "
-            "determine a package namespace for modules located under the source root.",
+            "help": "Add paths to the list of the source roots. Supports globbing patterns. The "
+            "source root is an absolute path or a path relative to the current working directory "
+            "used to determine a package namespace for modules located under the source root.",
         },
     ),
 )

tests/lint/unittest_lint.py

@@ -1208,6 +1208,20 @@ def test_recursive_ignore(ignore_parameter: str, ignore_parameter_value: str) ->
     assert module in linted_file_paths
 
 
+def test_source_roots_globbing() -> None:
+    run = Run(
+        [
+            "--source-roots",
+            join(REGRTEST_DATA_DIR, "pep420", "basic", "*"),
+            join(REGRTEST_DATA_DIR, "pep420", "basic", "project"),
+        ],
+        exit=False,
+    )
+    assert run.linter.config.source_roots == [
+        join(REGRTEST_DATA_DIR, "pep420", "basic", "project")
+    ]
+
+
 def test_recursive_implicit_namespace() -> None:
     run = Run(
         [