prospector 1.7.1__tar.gz → 1.14.0__tar.gz

{prospector-1.7.1 → prospector-1.14.0}/PKG-INFO

@@ -1,15 +1,15 @@
 Metadata-Version: 2.1
 Name: prospector
-Version: 1.7.1
-Summary: 
+Version: 1.14.0
+Summary: Prospector is a tool to analyse Python code by aggregating the result of other tools.
 Home-page: http://prospector.readthedocs.io
-License: GPLv2
+License: GPLv2+
 Keywords: pylint,prospector,static code analysis
 Author: Carl Crowder
 Author-email: git@carlcrowder.com
 Maintainer: Carl Crowder
 Maintainer-email: git@carlcrowder.com
-Requires-Python: >=3.6.2,<4.0
+Requires-Python: >=3.9,<4.0
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -17,35 +17,40 @@ Classifier: License :: OSI Approved :: GNU General Public License v2 or later (G
 Classifier: License :: Other/Proprietary License
 Classifier: Operating System :: Unix
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Topic :: Software Development :: Quality Assurance
 Provides-Extra: with_bandit
 Provides-Extra: with_everything
-Provides-Extra: with_frosted
 Provides-Extra: with_mypy
+Provides-Extra: with_pyright
 Provides-Extra: with_pyroma
+Provides-Extra: with_ruff
 Provides-Extra: with_vulture
+Requires-Dist: GitPython (>=3.1.27,<4.0.0)
 Requires-Dist: PyYAML
 Requires-Dist: bandit (>=1.5.1); extra == "with_bandit" or extra == "with_everything"
 Requires-Dist: dodgy (>=0.2.1,<0.3.0)
-Requires-Dist: frosted (>=1.4.1); extra == "with_frosted" or extra == "with_everything"
-Requires-Dist: mccabe (>=0.6.0,<0.7.0)
+Requires-Dist: mccabe (>=0.7.0,<0.8.0)
 Requires-Dist: mypy (>=0.600); extra == "with_mypy" or extra == "with_everything"
+Requires-Dist: packaging
 Requires-Dist: pep8-naming (>=0.3.3,<=0.10.0)
-Requires-Dist: pycodestyle (>=2.6.0,<2.9.0)
+Requires-Dist: pycodestyle (>=2.9.0)
 Requires-Dist: pydocstyle (>=2.0.0)
-Requires-Dist: pyflakes (>=2.2.0,<3)
-Requires-Dist: pylint (>=2.8.3)
+Requires-Dist: pyflakes (>=2.2.0)
+Requires-Dist: pylint (>=3.0)
 Requires-Dist: pylint-celery (==0.3)
-Requires-Dist: pylint-django (>=2.5,<2.6)
+Requires-Dist: pylint-django (>=2.6.1)
 Requires-Dist: pylint-flask (==0.6)
-Requires-Dist: pylint-plugin-utils (>=0.7,<0.8)
+Requires-Dist: pyright (>=1.1.3); extra == "with_pyright" or extra == "with_everything"
 Requires-Dist: pyroma (>=2.4); extra == "with_pyroma" or extra == "with_everything"
-Requires-Dist: requirements-detector (>=0.7,<0.8)
+Requires-Dist: requirements-detector (>=1.3.2)
+Requires-Dist: ruff; extra == "with_ruff" or extra == "with_everything"
 Requires-Dist: setoptconf-tmp (>=0.3.1,<0.4.0)
 Requires-Dist: toml (>=0.10.2,<0.11.0)
 Requires-Dist: vulture (>=1.5); extra == "with_vulture" or extra == "with_everything"
@@ -58,17 +63,14 @@ prospector
 .. image:: https://img.shields.io/pypi/v/prospector.svg
    :target: https://pypi.python.org/pypi/prospector
    :alt: Latest Version of Prospector
-.. image:: https://travis-ci.org/PyCQA/prospector.svg?branch=master
-   :target: https://travis-ci.org/PyCQA/prospector
+.. image:: https://github.com/PyCQA/prospector/actions/workflows/tests.yml/badge.svg
+   :target: https://github.com/PyCQA/prospector/actions/workflows/tests.yml
    :alt: Build Status
-.. image:: https://landscape.io/github/landscapeio/prospector/master/landscape.svg?style=flat
-   :target: https://landscape.io/github/landscapeio/prospector/master
-   :alt: Code Health
 .. image:: https://img.shields.io/coveralls/PyCQA/prospector.svg?style=flat
    :target: https://coveralls.io/r/PyCQA/prospector
    :alt: Test Coverage
 .. image:: https://readthedocs.org/projects/prospector/badge/?version=latest
-   :target: http://prospector.readthedocs.io/
+   :target: https://prospector.readthedocs.io/
    :alt: Documentation
 
 
@@ -79,10 +81,10 @@ Prospector is a tool to analyse Python code and output information about
 errors, potential problems, convention violations and complexity.
 
 It brings together the functionality of other Python analysis tools such as
-`Pylint <http://docs.pylint.org/>`_,
-`pep8 <http://pep8.readthedocs.org/en/latest/>`_,
+`Pylint <https://docs.pylint.org/>`_,
+`pycodestyle <https://pycodestyle.pycqa.org/>`_,
 and `McCabe complexity <https://pypi.python.org/pypi/mccabe>`_.
-See the `Supported Tools <http://prospector.readthedocs.io/en/latest/supported_tools.html>`_
+See the `Supported Tools <https://prospector.readthedocs.io/en/latest/supported_tools.html>`_
 documentation section for a complete list.
 
 The primary aim of Prospector is to be useful 'out of the box'. A common complaint of other
@@ -118,13 +120,13 @@ And for extras::
     poetry install -E with_everything
 
 For more detailed information on installing the tool, see the
-`installation section <http://prospector.readthedocs.io/en/latest/#installation>`_ of the tool's main page
+`installation section <https://prospector.readthedocs.io/en/latest/#installation>`_ of the tool's main page
 on ReadTheDocs.
 
 Documentation
 -------------
 
-Full `documentation is available at ReadTheDocs <http://prospector.readthedocs.io>`_.
+Full `documentation is available at ReadTheDocs <https://prospector.readthedocs.io>`_.
 
 Usage
 -----
@@ -156,7 +158,7 @@ Profiles
 
 Prospector is configurable using "profiles". These are composable YAML files with directives to
 disable or enable tools or messages. For more information, read
-`the documentation about profiles <http://prospector.readthedocs.io/en/latest/profiles.html>`_.
+`the documentation about profiles <https://prospector.readthedocs.io/en/latest/profiles.html>`_.
 
 If your code uses frameworks and libraries
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -205,9 +207,59 @@ text to your repositories' ``.pre-commit-config.yaml``::
 
     repos:
     -   repo: https://github.com/PyCQA/prospector
-        rev: 1.5.3.1 # The version of Prospector to use, if not 'master' for latest
+        rev: 1.10.0 # The version of Prospector to use, if not 'master' for latest
+        hooks:
+        -   id: prospector
+
+This only installs base prospector - if you also use optional tools, for example bandit and/or mypy, then you can add
+them to the hook configuration like so::
+
+    repos:
+    -   repo: https://github.com/PyCQA/prospector
+        rev: 1.10.0
         hooks:
         -   id: prospector
+            additional_dependencies:
+            - ".[with_mypy,with_bandit]"
+          - args: [
+            '--with-tool=mypy',
+            '--with-tool=bandit',
+            ]
+
+Additional dependencies can be `individually configured <https://prospector.landscape.io/en/master/profiles.html#individual-configuration-options>`_ in your `prospector.yml` file ::
+
+    # https://bandit.readthedocs.io/en/latest/config.html
+    bandit:
+    options:
+        skips:
+        - B201
+        - B601
+        - B610
+        - B611
+        - B703
+
+    # https://mypy.readthedocs.io/en/stable/command_line.html
+    mypy:
+    options:
+        ignore-missing-imports: true
+
+For prospector options which affect display only - those which are not configurable using a profile - these can be
+added as command line arguments to the hook. For example::
+
+    repos:
+    -   repo: https://github.com/PyCQA/prospector
+        rev: 1.10.0
+        hooks:
+        -   id: prospector
+            additional_dependencies:
+            -   ".[with_mypy,with_bandit]"
+            args:
+            -   --with-tool=mypy
+            -   --with-tool=bandit
+            -   --summary-only
+            -   --zero-exit
+
+
 
 License
 -------

{prospector-1.7.1 → prospector-1.14.0}/README.rst

@@ -4,17 +4,14 @@ prospector
 .. image:: https://img.shields.io/pypi/v/prospector.svg
    :target: https://pypi.python.org/pypi/prospector
    :alt: Latest Version of Prospector
-.. image:: https://travis-ci.org/PyCQA/prospector.svg?branch=master
-   :target: https://travis-ci.org/PyCQA/prospector
+.. image:: https://github.com/PyCQA/prospector/actions/workflows/tests.yml/badge.svg
+   :target: https://github.com/PyCQA/prospector/actions/workflows/tests.yml
    :alt: Build Status
-.. image:: https://landscape.io/github/landscapeio/prospector/master/landscape.svg?style=flat
-   :target: https://landscape.io/github/landscapeio/prospector/master
-   :alt: Code Health
 .. image:: https://img.shields.io/coveralls/PyCQA/prospector.svg?style=flat
    :target: https://coveralls.io/r/PyCQA/prospector
    :alt: Test Coverage
 .. image:: https://readthedocs.org/projects/prospector/badge/?version=latest
-   :target: http://prospector.readthedocs.io/
+   :target: https://prospector.readthedocs.io/
    :alt: Documentation
 
 
@@ -25,10 +22,10 @@ Prospector is a tool to analyse Python code and output information about
 errors, potential problems, convention violations and complexity.
 
 It brings together the functionality of other Python analysis tools such as
-`Pylint <http://docs.pylint.org/>`_,
-`pep8 <http://pep8.readthedocs.org/en/latest/>`_,
+`Pylint <https://docs.pylint.org/>`_,
+`pycodestyle <https://pycodestyle.pycqa.org/>`_,
 and `McCabe complexity <https://pypi.python.org/pypi/mccabe>`_.
-See the `Supported Tools <http://prospector.readthedocs.io/en/latest/supported_tools.html>`_
+See the `Supported Tools <https://prospector.readthedocs.io/en/latest/supported_tools.html>`_
 documentation section for a complete list.
 
 The primary aim of Prospector is to be useful 'out of the box'. A common complaint of other
@@ -64,13 +61,13 @@ And for extras::
     poetry install -E with_everything
 
 For more detailed information on installing the tool, see the
-`installation section <http://prospector.readthedocs.io/en/latest/#installation>`_ of the tool's main page
+`installation section <https://prospector.readthedocs.io/en/latest/#installation>`_ of the tool's main page
 on ReadTheDocs.
 
 Documentation
 -------------
 
-Full `documentation is available at ReadTheDocs <http://prospector.readthedocs.io>`_.
+Full `documentation is available at ReadTheDocs <https://prospector.readthedocs.io>`_.
 
 Usage
 -----
@@ -102,7 +99,7 @@ Profiles
 
 Prospector is configurable using "profiles". These are composable YAML files with directives to
 disable or enable tools or messages. For more information, read
-`the documentation about profiles <http://prospector.readthedocs.io/en/latest/profiles.html>`_.
+`the documentation about profiles <https://prospector.readthedocs.io/en/latest/profiles.html>`_.
 
 If your code uses frameworks and libraries
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -151,10 +148,60 @@ text to your repositories' ``.pre-commit-config.yaml``::
 
     repos:
     -   repo: https://github.com/PyCQA/prospector
-        rev: 1.5.3.1 # The version of Prospector to use, if not 'master' for latest
+        rev: 1.10.0 # The version of Prospector to use, if not 'master' for latest
         hooks:
         -   id: prospector
 
+This only installs base prospector - if you also use optional tools, for example bandit and/or mypy, then you can add
+them to the hook configuration like so::
+
+    repos:
+    -   repo: https://github.com/PyCQA/prospector
+        rev: 1.10.0
+        hooks:
+        -   id: prospector
+            additional_dependencies:
+            - ".[with_mypy,with_bandit]"
+          - args: [
+            '--with-tool=mypy',
+            '--with-tool=bandit',
+            ]
+
+Additional dependencies can be `individually configured <https://prospector.landscape.io/en/master/profiles.html#individual-configuration-options>`_ in your `prospector.yml` file ::
+
+    # https://bandit.readthedocs.io/en/latest/config.html
+    bandit:
+    options:
+        skips:
+        - B201
+        - B601
+        - B610
+        - B611
+        - B703
+
+    # https://mypy.readthedocs.io/en/stable/command_line.html
+    mypy:
+    options:
+        ignore-missing-imports: true
+
+For prospector options which affect display only - those which are not configurable using a profile - these can be
+added as command line arguments to the hook. For example::
+
+    repos:
+    -   repo: https://github.com/PyCQA/prospector
+        rev: 1.10.0
+        hooks:
+        -   id: prospector
+            additional_dependencies:
+            -   ".[with_mypy,with_bandit]"
+            args:
+            -   --with-tool=mypy
+            -   --with-tool=bandit
+            -   --summary-only
+            -   --zero-exit
+
+
+
 License
 -------
 

{prospector-1.7.1 → prospector-1.14.0}/prospector/__main__.py

@@ -1,6 +1,4 @@
-import sys
-
 from prospector.run import main
 
 if __name__ == "__main__":
-    sys.exit(main())
+    main()

{prospector-1.7.1 → prospector-1.14.0}/prospector/autodetect.py

@@ -1,11 +1,14 @@
 import os
 import re
 import warnings
+from pathlib import Path
+from typing import Union
 
 from requirements_detector import find_requirements
 from requirements_detector.detect import RequirementsNotFound
 
 from prospector import encoding
+from prospector.exceptions import PermissionMissing
 from prospector.pathutils import is_virtualenv
 
 POSSIBLE_LIBRARIES = ("django", "celery", "flask")
@@ -17,7 +20,7 @@ _IMPORT_REGEX = re.compile(r"^\s*import ([\._a-zA-Z0-9]+)$")
 _IMPORT_MULTIPLE_REGEX = re.compile(r"^\s*import ([\._a-zA-Z0-9]+(, ){1})+")
 
 
-def find_from_imports(file_contents):
+def find_from_imports(file_contents: str) -> set[str]:
     names = set()
     for line in file_contents.split("\n"):
         match = _IMPORT_MULTIPLE_REGEX.match(line)
@@ -40,57 +43,55 @@ def find_from_imports(file_contents):
     return names
 
 
-def find_from_path(path):
+def find_from_path(path: Path) -> set[str]:
     names = set()
-    max_possible = len(POSSIBLE_LIBRARIES)
 
-    for item in os.listdir(path):
-        item_path = os.path.abspath(os.path.join(path, item))
-        if os.path.isdir(item_path):
-            if is_virtualenv(item_path):
-                continue
-            names |= find_from_path(item_path)
-        elif not os.path.islink(item_path) and item_path.endswith(".py"):
-            try:
-                contents = encoding.read_py_file(item_path)
-                names |= find_from_imports(contents)
-            except encoding.CouldNotHandleEncoding as err:
-                # TODO: this output will break output formats such as JSON
-                warnings.warn("{0}: {1}".format(err.path, err.cause), ImportWarning)
-
-        if len(names) == max_possible:
-            # don't continue on recursing, there's no point!
-            break
+    try:
+        for item in path.iterdir():
+            if item.is_dir():
+                if is_virtualenv(item):
+                    continue
+                names |= find_from_path(item)
+            elif not item.is_symlink() and item.suffix == ".py":
+                try:
+                    contents = encoding.read_py_file(item)
+                    names |= find_from_imports(contents)
+                except encoding.CouldNotHandleEncoding as err:
+                    # TODO: this output will break output formats such as JSON
+                    warnings.warn(f"{err.path}: {err.__cause__}", ImportWarning, stacklevel=0)
+
+            if len(names) == len(POSSIBLE_LIBRARIES):
+                # don't continue on recursing, there's no point!
+                break
+    except PermissionError as err:
+        raise PermissionMissing(path) from err
 
     return names
 
 
-def find_from_requirements(path):
+def find_from_requirements(path: Union[str, Path]) -> set[str]:
     reqs = find_requirements(path)
-    names = []
+    names: set[str] = set()
     for requirement in reqs:
         if requirement.name is not None and requirement.name.lower() in POSSIBLE_LIBRARIES:
-            names.append(requirement.name.lower())
+            names.add(requirement.name.lower())
     return names
 
 
-def autodetect_libraries(path):
-
+def autodetect_libraries(path: Union[str, Path]) -> set[str]:
     if os.path.isfile(path):
         path = os.path.dirname(path)
         if path == "":
             path = "."
 
-    libraries = []
+    libraries: set[str] = set()
 
     try:
         libraries = find_from_requirements(path)
-
-    # pylint: disable=pointless-except
     except RequirementsNotFound:
         pass
 
     if len(libraries) < len(POSSIBLE_LIBRARIES):
-        libraries = find_from_path(path)
+        libraries = find_from_path(Path(path))
 
     return libraries

{prospector-1.7.1 → prospector-1.14.0}/prospector/blender.py

@@ -4,18 +4,22 @@
 # the same line. For example, both pyflakes and pylint will generate an
 # "Unused Import" warning on the same line. This is obviously redundant, so we
 # remove duplicates.
+import pkgutil
 from collections import defaultdict
+from pathlib import Path
+from typing import Optional
 
-import pkg_resources
 import yaml
 
+from prospector.message import Message
+
 __all__ = (
     "blend",
     "BLEND_COMBOS",
 )
 
 
-def blend_line(messages, blend_combos=None):
+def blend_line(messages: list[Message], blend_combos: Optional[list[list[tuple[str, str]]]] = None) -> list[Message]:
     """
     Given a list of messages on the same line, blend them together so that we
     end up with one message per actual problem. Note that we can still return
@@ -23,8 +27,8 @@ def blend_line(messages, blend_combos=None):
     the line.
     """
     blend_combos = blend_combos or BLEND_COMBOS
-    blend_lists = [[] for _ in range(len(blend_combos))]
-    blended = []
+    blend_lists: list[list[Message]] = [[] for _ in range(len(blend_combos))]
+    blended: list[Message] = []
 
     # first we split messages into each of the possible blendable categories
     # so that we have a list of lists of messages which can be blended together
@@ -52,6 +56,7 @@ def blend_line(messages, blend_combos=None):
     for blend_combo_idx, blend_list in enumerate(blend_lists):
         if len(blend_list) == 0:
             continue
+        # pylint:disable=cell-var-from-loop
         blend_list.sort(
             key=lambda msg: blend_combos[blend_combo_idx].index(
                 (msg.source, msg.code),
@@ -71,16 +76,16 @@ def blend_line(messages, blend_combos=None):
         # it will appear in two blend_lists. Therefore we mark anything not taken from the blend list
         # as "consumed" and then filter later, to avoid such cases.
         for now_used in blend_list[1:]:
-            now_used.used = True
+            now_used.used = True  # type: ignore[attr-defined]
 
     return [m for m in blended if not getattr(m, "used", False)]
 
 
-def blend(messages, blend_combos=None):
+def blend(messages: list[Message], blend_combos: Optional[list[list[tuple[str, str]]]] = None) -> list[Message]:
     blend_combos = blend_combos or BLEND_COMBOS
 
     # group messages by file and then line number
-    msgs_grouped = defaultdict(lambda: defaultdict(list))
+    msgs_grouped: dict[Optional[Path], dict[Optional[int], list[Message]]] = defaultdict(lambda: defaultdict(list))
 
     for message in messages:
         msgs_grouped[message.location.path][message.location.line].append(
@@ -96,18 +101,20 @@ def blend(messages, blend_combos=None):
     return out
 
 
-def get_default_blend_combinations():
-    combos = yaml.safe_load(pkg_resources.resource_string(__name__, "blender_combinations.yaml"))
+def get_default_blend_combinations() -> list[list[tuple[str, str]]]:
+    blender_combinations = pkgutil.get_data(__name__, "blender_combinations.yaml")
+    assert blender_combinations is not None
+    combos = yaml.safe_load(blender_combinations)
     combos = combos.get("combinations", [])
 
-    defaults = []
+    defaults: list[list[tuple[str, str]]] = []
     for combo in combos:
         toblend = []
         for msg in combo:
             toblend += msg.items()
-        defaults.append(tuple(toblend))
+        defaults.append(toblend)
 
-    return tuple(defaults)
+    return defaults
 
 
 BLEND_COMBOS = get_default_blend_combinations()