diff options
author | Daniƫl van Noord <13665637+DanielNoord@users.noreply.github.com> | 2021-10-24 12:48:19 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-10-24 12:48:19 +0200 |
commit | bfc8d32273102495ee1cfd8daa14d9b6693b11f7 (patch) | |
tree | 60785b9a4d5981f06ce2d09a8113803417cab479 /pylint | |
parent | 8eb7ff153e951f69b4d1ff3cbddc367c797c0aa4 (diff) | |
download | pylint-git-bfc8d32273102495ee1cfd8daa14d9b6693b11f7.tar.gz |
Normalize input of ``ignore-paths`` for all path types (#5201)
Closes #5194
Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
Diffstat (limited to 'pylint')
-rw-r--r-- | pylint/config/option.py | 18 | ||||
-rw-r--r-- | pylint/lint/expand_modules.py | 2 | ||||
-rw-r--r-- | pylint/lint/pylinter.py | 22 | ||||
-rw-r--r-- | pylint/utils/utils.py | 19 |
4 files changed, 52 insertions, 9 deletions
diff --git a/pylint/config/option.py b/pylint/config/option.py index 0a9a37069..7b3e3b1b1 100644 --- a/pylint/config/option.py +++ b/pylint/config/option.py @@ -3,7 +3,9 @@ import copy import optparse # pylint: disable=deprecated-module +import pathlib import re +from typing import List, Pattern from pylint import utils @@ -25,6 +27,19 @@ def _regexp_csv_validator(_, name, value): return [_regexp_validator(_, name, val) for val in _csv_validator(_, name, value)] +def _regexp_paths_csv_validator(_, name: str, value: str) -> List[Pattern[str]]: + patterns = [] + for val in _csv_validator(_, name, value): + patterns.append( + re.compile( + str(pathlib.PureWindowsPath(val)).replace("\\", "\\\\") + + "|" + + pathlib.PureWindowsPath(val).as_posix() + ) + ) + return patterns + + def _choice_validator(choices, name, value): if value not in choices: msg = "option %s: invalid value: %r, should be in %s" @@ -80,6 +95,7 @@ VALIDATORS = { "float": float, "regexp": lambda pattern: re.compile(pattern or ""), "regexp_csv": _regexp_csv_validator, + "regexp_paths_csv": _regexp_paths_csv_validator, "csv": _csv_validator, "yn": _yn_validator, "choice": lambda opt, name, value: _choice_validator(opt["choices"], name, value), @@ -122,6 +138,7 @@ class Option(optparse.Option): TYPES = optparse.Option.TYPES + ( "regexp", "regexp_csv", + "regexp_paths_csv", "csv", "yn", "multiple_choice", @@ -132,6 +149,7 @@ class Option(optparse.Option): TYPE_CHECKER = copy.copy(optparse.Option.TYPE_CHECKER) TYPE_CHECKER["regexp"] = _regexp_validator TYPE_CHECKER["regexp_csv"] = _regexp_csv_validator + TYPE_CHECKER["regexp_paths_csv"] = _regexp_paths_csv_validator TYPE_CHECKER["csv"] = _csv_validator TYPE_CHECKER["yn"] = _yn_validator TYPE_CHECKER["multiple_choice"] = _multiple_choices_validating_option diff --git a/pylint/lint/expand_modules.py b/pylint/lint/expand_modules.py index 1d4432322..cea4b5c17 100644 --- a/pylint/lint/expand_modules.py +++ b/pylint/lint/expand_modules.py @@ -43,7 +43,7 @@ def expand_modules( files_or_modules: List[str], ignore_list: List[str], ignore_list_re: List[Pattern], - ignore_list_paths_re: List[Pattern], + ignore_list_paths_re: List[Pattern[str]], ) -> Tuple[List[ModuleDescriptionDict], List[ErrorDescriptionDict]]: """take a list of files/modules/packages and return the list of tuple (file, module name) which have to be actually checked diff --git a/pylint/lint/pylinter.py b/pylint/lint/pylinter.py index 6e6ccd59b..3be78c46c 100644 --- a/pylint/lint/pylinter.py +++ b/pylint/lint/pylinter.py @@ -46,7 +46,14 @@ from pylint.typing import ( MessageLocationTuple, ModuleDescriptionDict, ) -from pylint.utils import ASTWalker, FileState, LinterStats, ModuleStats, utils +from pylint.utils import ( + ASTWalker, + FileState, + LinterStats, + ModuleStats, + get_global_option, + utils, +) from pylint.utils.pragma_parser import ( OPTION_PO, InvalidPragmaError, @@ -220,12 +227,12 @@ class PyLinter( ( "ignore-paths", { - "type": "regexp_csv", + "type": "regexp_paths_csv", "metavar": "<pattern>[,<pattern>...]", - "dest": "ignore_list_paths_re", - "default": (), - "help": "Add files or directories matching the regex patterns to the" - " ignore-list. The regex matches against paths.", + "default": [], + "help": "Add files or directories matching the regex patterns to the " + "ignore-list. The regex matches against paths and can be in " + "Posix or Windows format.", }, ), ( @@ -1101,7 +1108,7 @@ class PyLinter( modules, self.config.black_list, self.config.black_list_re, - self.config.ignore_list_paths_re, + self._ignore_paths, ) for error in errors: message = modname = error["mod"] @@ -1259,6 +1266,7 @@ class PyLinter( self.config.extension_pkg_whitelist ) self.stats.reset_message_count() + self._ignore_paths = get_global_option(self, "ignore-paths") def generate_reports(self): """close the whole package /module, it's time to make reports ! diff --git a/pylint/utils/utils.py b/pylint/utils/utils.py index 96f8a6acc..6c9f11298 100644 --- a/pylint/utils/utils.py +++ b/pylint/utils/utils.py @@ -56,16 +56,24 @@ GLOBAL_OPTION_LIST = Literal["ignored-modules"] GLOBAL_OPTION_PATTERN = Literal[ "no-docstring-rgx", "dummy-variables-rgx", "ignored-argument-names" ] +GLOBAL_OPTION_PATTERN_LIST = Literal["ignore-paths"] GLOBAL_OPTION_TUPLE_INT = Literal["py-version"] GLOBAL_OPTION_NAMES = Union[ GLOBAL_OPTION_BOOL, GLOBAL_OPTION_INT, GLOBAL_OPTION_LIST, GLOBAL_OPTION_PATTERN, + GLOBAL_OPTION_PATTERN_LIST, GLOBAL_OPTION_TUPLE_INT, ] T_GlobalOptionReturnTypes = TypeVar( - "T_GlobalOptionReturnTypes", bool, int, List[str], Pattern[str], Tuple[int, ...] + "T_GlobalOptionReturnTypes", + bool, + int, + List[str], + Pattern[str], + List[Pattern[str]], + Tuple[int, ...], ) @@ -223,6 +231,15 @@ def get_global_option( @overload def get_global_option( checker: "BaseChecker", + option: GLOBAL_OPTION_PATTERN_LIST, + default: Optional[List[Pattern[str]]] = None, +) -> List[Pattern[str]]: + ... + + +@overload +def get_global_option( + checker: "BaseChecker", option: GLOBAL_OPTION_TUPLE_INT, default: Optional[Tuple[int, ...]] = None, ) -> Tuple[int, ...]: |