Merge pull request #684 from prospector-dev/prospector-checks

Prospector checks

Author: sbrunner

.github/workflows/tests.yml

@@ -33,6 +33,8 @@ jobs:
           echo "Checking prospector can run; don't care about messages found, only that it runs successfully"
           poetry run prospector --quiet --zero-exit
           echo "Prospector ran successfully."
+      - name: Run Prospector checks
+        run: poetry run prospector --output=pylint
       - name: Check packaging
         run: |
           echo "Building packages"

.pre-commit-config.yaml

@@ -13,7 +13,7 @@ repos:
     rev: v3.17.0
     hooks:
       - id: pyupgrade
-        args: [--py38-plus]
+        args: [--py39-plus]
   - repo: https://github.com/psf/black
     rev: 24.8.0
     hooks:

.prospector.yml

@@ -29,13 +29,16 @@ pylint:
     - too-many-instance-attributes
     - too-many-function-args
     - too-many-statements
+    - too-many-positional-arguments
+    - no-else-return
 
 mccabe:
   run: false
 
 pycodestyle:
   disable:
     - E126
+    - E501 # line too long
 
 pydocstyle:
   run: false

prospector/config/__init__.py

@@ -2,12 +2,12 @@
 import re
 import sys
 from pathlib import Path
-from typing import Dict, List, Union
+from typing import Optional, Union
 
 try:  # Python >= 3.11
     import re._constants as sre_constants
 except ImportError:
-    import sre_constants
+    import sre_constants  # pylint: disable=deprecated-module
 
 from prospector import tools
 from prospector.autodetect import autodetect_libraries
@@ -26,7 +26,7 @@ class ProspectorConfig:
     # Also the 'too many instance attributes' warning is ignored, as this
     # is a config object and its sole purpose is to hold many properties!
 
-    def __init__(self, workdir: Path = None):
+    def __init__(self, workdir: Optional[Path] = None):
         self.config, self.arguments = self._configure_prospector()
         self.paths = self._get_work_path(self.config, self.arguments)
         self.explicit_file_mode = all(p.is_file for p in self.paths)
@@ -36,8 +36,8 @@ def __init__(self, workdir: Path = None):
         self.libraries = self._find_used_libraries(self.config, self.profile)
         self.tools_to_run = self._determine_tool_runners(self.config, self.profile)
         self.ignores = self._determine_ignores(self.config, self.profile, self.libraries)
-        self.configured_by: Dict[str, str] = {}
-        self.messages: List[Message] = []
+        self.configured_by: dict[str, str] = {}
+        self.messages: list[Message] = []
 
     def make_exclusion_filter(self):
         # Only close over the attributes required by the filter, rather
@@ -79,7 +79,7 @@ def get_tools(self, found_files):
             runners.append(tool)
         return runners
 
-    def replace_deprecated_tool_names(self) -> List[str]:
+    def replace_deprecated_tool_names(self) -> list[str]:
         # pep8 was renamed pycodestyle ; pep257 was renamed pydocstyle
         # for backwards compatibility, these have been deprecated but will remain until prospector v2
         deprecated_found = []
@@ -112,7 +112,7 @@ def _configure_prospector(self):
         config = mgr.retrieve(*cfg.build_default_sources())
         return config, mgr.arguments
 
-    def _get_work_path(self, config, arguments) -> List[Path]:
+    def _get_work_path(self, config, arguments) -> list[Path]:
         # Figure out what paths we're prospecting
         if config["path"]:
             paths = [Path(self.config["path"])]

prospector/finder.py

@@ -1,5 +1,6 @@
+from collections.abc import Iterable, Iterator
 from pathlib import Path
-from typing import Callable, Iterable, Iterator, List
+from typing import Callable, Optional
 
 from prospector.exceptions import PermissionMissing
 from prospector.pathutils import is_python_module, is_python_package, is_virtualenv
@@ -17,7 +18,7 @@ class FileFinder:
     is basically to know which files to pass to which tools to be inspected.
     """
 
-    def __init__(self, *provided_paths: Path, exclusion_filters: Iterable[Callable] = None):
+    def __init__(self, *provided_paths: Path, exclusion_filters: Optional[Iterable[Callable]] = None):
         """
         :param provided_paths:
             A list of Path objects to search for files and modules - can be either directories or files
@@ -44,7 +45,7 @@ def __init__(self, *provided_paths: Path, exclusion_filters: Iterable[Callable]
             if path.is_dir():
                 self._provided_dirs.append(path)
 
-    def make_syspath(self) -> List[Path]:
+    def make_syspath(self) -> list[Path]:
         paths = set()
         for path in self._provided_dirs:
             paths.add(path)
@@ -55,7 +56,7 @@ def make_syspath(self) -> List[Path]:
     def is_excluded(self, path: Path) -> bool:
         return any(filt(path) for filt in self._exclusion_filters)
 
-    def _filter(self, paths: Iterable[Path]) -> List[Path]:
+    def _filter(self, paths: Iterable[Path]) -> list[Path]:
         return [path for path in paths if not self.is_excluded(path)]
 
     def _walk(self, directory: Path) -> Iterator[Path]:
@@ -71,7 +72,7 @@ def _walk(self, directory: Path) -> Iterator[Path]:
                 yield path
 
     @property
-    def files(self) -> List[Path]:
+    def files(self) -> list[Path]:
         """
         List every individual file found from the given configuration.
 
@@ -89,7 +90,7 @@ def files(self) -> List[Path]:
         return self._filter(files)
 
     @property
-    def python_packages(self) -> List[Path]:
+    def python_packages(self) -> list[Path]:
         """
         Lists every directory found in the given configuration which is a python module (that is,
         contains an `__init__.py` file).
@@ -99,7 +100,7 @@ def python_packages(self) -> List[Path]:
         return self._filter(d for d in self.directories if is_python_package(d))
 
     @property
-    def python_modules(self) -> List[Path]:
+    def python_modules(self) -> list[Path]:
         """
         Lists every directory found in the given configuration which is a python module (that is,
         contains an `__init__.py` file).
@@ -109,7 +110,7 @@ def python_modules(self) -> List[Path]:
         return self._filter(f for f in self.files if is_python_module(f))
 
     @property
-    def directories(self) -> List[Path]:
+    def directories(self) -> list[Path]:
         """
         Lists every directory found from the given configuration, regardless of its contents.
 

prospector/formatters/base.py

@@ -3,12 +3,13 @@
 __all__ = ("Formatter",)
 
 from pathlib import Path
+from typing import Optional
 
 from prospector.message import Message
 
 
 class Formatter(ABC):
-    def __init__(self, summary, messages, profile, paths_relative_to: Path = None):
+    def __init__(self, summary, messages, profile, paths_relative_to: Optional[Path] = None):
         self.summary = summary
         self.messages = messages
         self.profile = profile

prospector/message.py

@@ -78,8 +78,8 @@ def make_tool_error_message(
     message: str,
     line: int = 0,
     character: int = 0,
-    module: str = None,
-    function: str = None,
+    module: Optional[str] = None,
+    function: Optional[str] = None,
 ) -> Message:
     location = Location(path=filepath, module=module, function=function, line=line, character=character)
     return Message(source=source, code=code, location=location, message=message)

prospector/profiles/profile.py

@@ -3,7 +3,7 @@
 import os
 import pkgutil
 from pathlib import Path
-from typing import Any, Dict, List, Optional, Tuple, Union
+from typing import Any, Optional, Union
 
 import yaml
 
@@ -14,7 +14,7 @@
 
 
 class ProspectorProfile:
-    def __init__(self, name: str, profile_dict: Dict[str, Any], inherit_order: List[str]):
+    def __init__(self, name: str, profile_dict: dict[str, Any], inherit_order: list[str]):
         self.name = name
         self.inherit_order = inherit_order
 
@@ -43,7 +43,7 @@ def __init__(self, name: str, profile_dict: Dict[str, Any], inherit_order: List[
             tool_conf = profile_dict.get(tool, {})
 
             # set the defaults for everything
-            conf: Dict[str, Any] = {"disable": [], "enable": [], "run": None, "options": {}}
+            conf: dict[str, Any] = {"disable": [], "enable": [], "run": None, "options": {}}
             # use the "old" tool name
             conf.update(tool_conf)
 
@@ -96,9 +96,9 @@ def as_yaml(self):
     @staticmethod
     def load(
         name_or_path: Union[str, Path],
-        profile_path: List[Path],
+        profile_path: list[Path],
         allow_shorthand: bool = True,
-        forced_inherits: Optional[List[str]] = None,
+        forced_inherits: Optional[list[str]] = None,
     ):
         # First simply load all of the profiles and those that it explicitly inherits from
         data, inherits = _load_and_merge(
@@ -333,10 +333,10 @@ def _append_profiles(name, profile_path, data, inherit_list, allow_shorthand=Fal
 
 def _load_and_merge(
     name_or_path: Union[str, Path],
-    profile_path: List[Path],
+    profile_path: list[Path],
     allow_shorthand: bool = True,
-    forced_inherits: List[str] = None,
-) -> Tuple[Dict[str, Any], List[str]]:
+    forced_inherits: Optional[list[str]] = None,
+) -> tuple[dict[str, Any], list[str]]:
     # First simply load all of the profiles and those that it explicitly inherits from
     data, inherit_list, shorthands_found = _load_profile(
         str(name_or_path),
@@ -419,12 +419,12 @@ def _transform_legacy(profile_dict):
 
 
 def _load_profile(
-    name_or_path,
-    profile_path,
-    shorthands_found=None,
-    already_loaded=None,
-    allow_shorthand=True,
-    forced_inherits=None,
+    name_or_path: Union[str, Path],
+    profile_path: list[Path],
+    shorthands_found: Optional[set[str]] = None,
+    already_loaded: Optional[list[Union[str, Path]]] = None,
+    allow_shorthand: bool = True,
+    forced_inherits: Optional[list[str]] = None,
 ):
     # recursively get the contents of the basic profile and those it inherits from
     base_contents = _load_content(name_or_path, profile_path)

prospector/run.py

@@ -189,7 +189,7 @@ def main():
 
     paths = config.paths
     if len(paths) > 1 and not all(os.path.isfile(path) for path in paths):
-        sys.stderr.write("\nIn multi-path mode, all inputs must be files, " "not directories.\n\n")
+        sys.stderr.write("\nIn multi-path mode, all inputs must be files, not directories.\n\n")
         get_parser().print_usage()
         sys.exit(2)
 

prospector/tools/profile_validator/__init__.py

@@ -4,7 +4,7 @@
 try:  # Python >= 3.11
     import re._constants as sre_constants
 except ImportError:
-    import sre_constants
+    import sre_constants  # pylint: disable=deprecated-module
 
 import yaml
 
@@ -170,7 +170,7 @@ def add_message(code, message, setting):
         if "pep257" in parsed:
             add_message(
                 CONFIG_DEPRECATED_CODE,
-                "pep257 tool has been renamed to 'pydocstyle'. " "The name pep257 will be removed in prospector 2.0+.",
+                "pep257 tool has been renamed to 'pydocstyle'. The name pep257 will be removed in prospector 2.0+.",
                 "pep257",
             )