prospector 1.13.1__tar.gz → 1.13.3__tar.gz

{prospector-1.13.1 → prospector-1.13.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: prospector
-Version: 1.13.1
+Version: 1.13.3
 Summary: Prospector is a tool to analyse Python code by aggregating the result of other tools.
 Home-page: http://prospector.readthedocs.io
 License: GPLv2+

{prospector-1.13.1 → prospector-1.13.3}/prospector/blender.py

@@ -85,10 +85,9 @@ def blend(messages: list[Message], blend_combos: Optional[list[list[tuple[str, s
     blend_combos = blend_combos or BLEND_COMBOS
 
     # group messages by file and then line number
-    msgs_grouped: dict[Path, dict[int, list[Message]]] = defaultdict(lambda: defaultdict(list))
+    msgs_grouped: dict[Optional[Path], dict[Optional[int], list[Message]]] = defaultdict(lambda: defaultdict(list))
 
     for message in messages:
-        assert message.location.line is not None
         msgs_grouped[message.location.path][message.location.line].append(
             message,
         )

{prospector-1.13.1 → prospector-1.13.3}/prospector/formatters/base.py

@@ -28,7 +28,8 @@ class Formatter(ABC):
         raise NotImplementedError
 
     def _make_path(self, location: Location) -> Path:
-        return location.relative_path(self.paths_relative_to)
+        path_ = location.relative_path(self.paths_relative_to)
+        return Path() if path_ is None else path_
 
     def _message_to_dict(self, message: Message) -> dict[str, Any]:
         loc = {

{prospector-1.13.1 → prospector-1.13.3}/prospector/formatters/grouped.py

@@ -1,5 +1,6 @@
 from collections import defaultdict
 from pathlib import Path
+from typing import Optional
 
 from prospector.formatters.text import TextFormatter
 from prospector.message import Message
@@ -15,10 +16,9 @@ class GroupedFormatter(TextFormatter):
             "",
         ]
 
-        groups: dict[Path, dict[int, list[Message]]] = defaultdict(lambda: defaultdict(list))
+        groups: dict[Path, dict[Optional[int], list[Message]]] = defaultdict(lambda: defaultdict(list))
 
         for message in self.messages:
-            assert message.location.line is not None
             groups[self._make_path(message.location)][message.location.line].append(message)
 
         for filename in sorted(groups.keys()):

{prospector-1.13.1 → prospector-1.13.3}/prospector/formatters/pylint.py

@@ -28,16 +28,26 @@ class PylintFormatter(SummaryFormatter):
             # Missing function docstring
 
             template_location = (
-                "%(path)s"
+                ""
+                if message.location.path is None
+                else "%(path)s"
                 if message.location.line is None
                 else "%(path)s:%(line)s"
                 if message.location.character is None
                 else "%(path)s:%(line)s:%(character)s"
             )
             template_code = (
-                "%(code)s(%(source)s)" if message.location.function is None else "[%(code)s(%(source)s), %(function)s]"
+                "(%(source)s)"
+                if message.code is None
+                else "%(code)s(%(source)s)"
+                if message.location.function is None
+                else "[%(code)s(%(source)s), %(function)s]"
+            )
+            template = (
+                f"{template_location}: {template_code}: %(message)s"
+                if template_location
+                else f"{template_code}: %(message)s"
             )
-            template = f"{template_location}: {template_code}: %(message)s"
 
             output.append(
                 template

{prospector-1.13.1 → prospector-1.13.3}/prospector/message.py

@@ -3,9 +3,11 @@ from typing import Optional, Union
 
 
 class Location:
+    _path: Optional[Path]
+
     def __init__(
         self,
-        path: Union[Path, str],
+        path: Optional[Union[Path, str]],
         module: Optional[str],
         function: Optional[str],
         line: Optional[int],
@@ -15,6 +17,8 @@ class Location:
             self._path = path.absolute()
         elif isinstance(path, str):
             self._path = Path(path).absolute()
+        elif path is None:
+            self._path = None
         else:
             raise ValueError
         self.module = module or None
@@ -23,13 +27,15 @@ class Location:
         self.character = None if character == -1 else character
 
     @property
-    def path(self) -> Path:
+    def path(self) -> Optional[Path]:
         return self._path
 
-    def absolute_path(self) -> Path:
+    def absolute_path(self) -> Optional[Path]:
         return self._path
 
-    def relative_path(self, root: Optional[Path]) -> Path:
+    def relative_path(self, root: Optional[Path]) -> Optional[Path]:
+        if self._path is None:
+            return None
         return self._path.relative_to(root) if root else self._path
 
     def __repr__(self) -> str:
@@ -46,6 +52,13 @@ class Location:
     def __lt__(self, other: "Location") -> bool:
         if not isinstance(other, Location):
             raise ValueError
+
+        if self._path is None and other._path is None:
+            return False
+        if self._path is None:
+            return True
+        if other._path is None:
+            return False
         if self._path == other._path:
             if self.line == other.line:
                 return (self.character or -1) < (other.character or -1)

{prospector-1.13.1 → prospector-1.13.3}/prospector/postfilter.py

@@ -1,11 +1,10 @@
 from pathlib import Path
-from typing import List
 
 from prospector.message import Message
 from prospector.suppression import get_suppressions
 
 
-def filter_messages(filepaths: List[Path], messages: List[Message]) -> List[Message]:
+def filter_messages(filepaths: list[Path], messages: list[Message]) -> list[Message]:
     """
     This method post-processes all messages output by all tools, in order to filter
     out any based on the overall output.
@@ -29,7 +28,7 @@ def filter_messages(filepaths: List[Path], messages: List[Message]) -> List[Mess
     filtered = []
     for message in messages:
         # first get rid of the pylint informational messages
-        relative_message_path = Path(message.location.path)
+        relative_message_path = message.location.path
 
         if message.source == "pylint" and message.code in (
             "suppressed-message",

{prospector-1.13.1 → prospector-1.13.3}/prospector/suppression.py

@@ -24,6 +24,7 @@ import re
 import warnings
 from collections import defaultdict
 from pathlib import Path
+from typing import Optional
 
 from prospector import encoding
 from prospector.exceptions import FatalProspectorException
@@ -63,9 +64,11 @@ _PYLINT_EQUIVALENTS = {
 }
 
 
-def _parse_pylint_informational(messages: list[Message]) -> tuple[set[Path], dict[Path, dict[int, list[str]]]]:
-    ignore_files: set[Path] = set()
-    ignore_messages: dict[Path, dict[int, list[str]]] = defaultdict(lambda: defaultdict(list))
+def _parse_pylint_informational(
+    messages: list[Message],
+) -> tuple[set[Optional[Path]], dict[Optional[Path], dict[int, list[str]]]]:
+    ignore_files: set[Optional[Path]] = set()
+    ignore_messages: dict[Optional[Path], dict[int, list[str]]] = defaultdict(lambda: defaultdict(list))
 
     for message in messages:
         if message.source == "pylint":
@@ -86,15 +89,15 @@ def _parse_pylint_informational(messages: list[Message]) -> tuple[set[Path], dic
 
 def get_suppressions(
     filepaths: list[Path], messages: list[Message]
-) -> tuple[set[Path], dict[Path, set[int]], dict[Path, dict[int, set[tuple[str, str]]]]]:
+) -> tuple[set[Optional[Path]], dict[Path, set[int]], dict[Optional[Path], dict[int, set[tuple[str, str]]]]]:
     """
     Given every message which was emitted by the tools, and the
     list of files to inspect, create a list of files to ignore,
     and a map of filepath -> line-number -> codes to ignore
     """
-    paths_to_ignore: set[Path] = set()
+    paths_to_ignore: set[Optional[Path]] = set()
     lines_to_ignore: dict[Path, set[int]] = defaultdict(set)
-    messages_to_ignore: dict[Path, dict[int, set[tuple[str, str]]]] = defaultdict(lambda: defaultdict(set))
+    messages_to_ignore: dict[Optional[Path], dict[int, set[tuple[str, str]]]] = defaultdict(lambda: defaultdict(set))
 
     # first deal with 'noqa' style messages
     for filepath in filepaths:
@@ -113,12 +116,12 @@ def get_suppressions(
     # now figure out which messages were suppressed by pylint
     pylint_ignore_files, pylint_ignore_messages = _parse_pylint_informational(messages)
     paths_to_ignore |= pylint_ignore_files
-    for filepath, line in pylint_ignore_messages.items():
+    for pylint_filepath, line in pylint_ignore_messages.items():
         for line_number, codes in line.items():
             for code in codes:
-                messages_to_ignore[filepath][line_number].add(("pylint", code))
+                messages_to_ignore[pylint_filepath][line_number].add(("pylint", code))
                 if code in _PYLINT_EQUIVALENTS:
                     for equivalent in _PYLINT_EQUIVALENTS[code]:
-                        messages_to_ignore[filepath][line_number].add(equivalent)
+                        messages_to_ignore[pylint_filepath][line_number].add(equivalent)
 
     return paths_to_ignore, lines_to_ignore, messages_to_ignore

{prospector-1.13.1 → prospector-1.13.3}/prospector/tools/pylint/collector.py

@@ -1,5 +1,4 @@
 from io import StringIO
-from typing import List
 
 from pylint.exceptions import UnknownMessageError
 from pylint.message import Message as PylintMessage
@@ -35,5 +34,5 @@ class Collector(BaseReporter):
         message = Message("pylint", msg_symbol, loc, msg.msg)
         self._messages.append(message)
 
-    def get_messages(self) -> List[Message]:
+    def get_messages(self) -> list[Message]:
         return self._messages

{prospector-1.13.1 → prospector-1.13.3}/prospector/tools/ruff/__init__.py

@@ -47,6 +47,16 @@ class RuffTool(ToolBase):
         completed_process = subprocess.run(  # noqa: S603
             [self.ruff_bin, *self.ruff_args, *found_files.python_modules], capture_output=True
         )
+        if not completed_process.stdout:
+            messages.append(
+                Message(
+                    "ruff",
+                    "",
+                    Location(None, None, None, None, None),
+                    completed_process.stderr.decode(),
+                )
+            )
+            return messages
         for message in json.loads(completed_process.stdout):
             sub_message = {}
             if message.get("url"):

{prospector-1.13.1 → prospector-1.13.3}/prospector/tools/utils.py

@@ -4,8 +4,9 @@ from typing import Optional
 
 
 class CaptureStream(TextIOWrapper):
-    def __init__(self) -> None:
+    def __init__(self, tty: bool) -> None:
         self.contents = ""
+        self._tty = tty
 
     def write(self, text: str, /) -> int:
         self.contents += text
@@ -17,6 +18,9 @@ class CaptureStream(TextIOWrapper):
     def flush(self) -> None:
         pass
 
+    def isatty(self) -> bool:
+        return self._tty
+
 
 class CaptureOutput:
     _prev_streams = None
@@ -28,14 +32,16 @@ class CaptureOutput:
 
     def __enter__(self) -> "CaptureOutput":
         if self.hide:
+            is_a_tty = hasattr(sys.stdout, "isatty") and sys.stdout.isatty()
+
             self._prev_streams = (
                 sys.stdout,
                 sys.stderr,
                 sys.__stdout__,
                 sys.__stderr__,
             )
-            self.stdout = CaptureStream()
-            self.stderr = CaptureStream()
+            self.stdout = CaptureStream(is_a_tty)
+            self.stderr = CaptureStream(is_a_tty)
             sys.stdout, sys.__stdout__ = self.stdout, self.stdout  # type: ignore[misc]
             sys.stderr, sys.__stderr__ = self.stderr, self.stderr  # type: ignore[misc]
         return self

{prospector-1.13.1 → prospector-1.13.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "prospector"
-version = "1.13.1"
+version = "1.13.3"
 description = "Prospector is a tool to analyse Python code by aggregating the result of other tools."
 authors = ["Carl Crowder <git@carlcrowder.com>"]
 maintainers = ["Carl Crowder <git@carlcrowder.com>",
@@ -88,6 +88,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.ruff]
 line-length = 120
+target-version = "py39"
 
 [tool.ruff.lint]
 fixable = ["ALL"]

{prospector-1.13.1 → prospector-1.13.3}/setup.py

@@ -61,7 +61,7 @@ entry_points = \
 
 setup_kwargs = {
     'name': 'prospector',
-    'version': '1.13.1',
+    'version': '1.13.3',
     'description': 'Prospector is a tool to analyse Python code by aggregating the result of other tools.',
     'long_description': 'prospector\n==========\n\n.. image:: https://img.shields.io/pypi/v/prospector.svg\n   :target: https://pypi.python.org/pypi/prospector\n   :alt: Latest Version of Prospector\n.. image:: https://github.com/PyCQA/prospector/actions/workflows/tests.yml/badge.svg\n   :target: https://github.com/PyCQA/prospector/actions/workflows/tests.yml\n   :alt: Build Status\n.. image:: https://img.shields.io/coveralls/PyCQA/prospector.svg?style=flat\n   :target: https://coveralls.io/r/PyCQA/prospector\n   :alt: Test Coverage\n.. image:: https://readthedocs.org/projects/prospector/badge/?version=latest\n   :target: https://prospector.readthedocs.io/\n   :alt: Documentation\n\n\nAbout\n-----\n\nProspector is a tool to analyse Python code and output information about\nerrors, potential problems, convention violations and complexity.\n\nIt brings together the functionality of other Python analysis tools such as\n`Pylint <https://docs.pylint.org/>`_,\n`pycodestyle <https://pycodestyle.pycqa.org/>`_,\nand `McCabe complexity <https://pypi.python.org/pypi/mccabe>`_.\nSee the `Supported Tools <https://prospector.readthedocs.io/en/latest/supported_tools.html>`_\ndocumentation section for a complete list.\n\nThe primary aim of Prospector is to be useful \'out of the box\'. A common complaint of other\nPython analysis tools is that it takes a long time to filter through which errors are relevant\nor interesting to your own coding style. Prospector provides some default profiles, which\nhopefully will provide a good starting point and will be useful straight away, and adapts\nthe output depending on the libraries your project uses.\n\nInstallation\n------------\n\nProspector can be installed from PyPI using ``pip`` by running the following command::\n\n    pip install prospector\n\nOptional dependencies for Prospector, such as ``pyroma`` can also be installed by running::\n\n    pip install prospector[with_pyroma]\n\nSome shells (such as ``Zsh``, the default shell of macOS Catalina) require brackets to be escaped::\n\n    pip install prospector\\[with_pyroma\\]\n\nFor a list of all of the optional dependencies, see the optional extras section on the ReadTheDocs\npage on `Supported Tools Extras <https://prospector.readthedocs.io/en/latest/supported_tools.html#optional-extras>`_.\n\nFor local development, `poetry <https://python-poetry.org/>`_ is used. Check out the code, then run::\n\n    poetry install\n\nAnd for extras::\n\n    poetry install -E with_everything\n\nFor more detailed information on installing the tool, see the\n`installation section <https://prospector.readthedocs.io/en/latest/#installation>`_ of the tool\'s main page\non ReadTheDocs.\n\nDocumentation\n-------------\n\nFull `documentation is available at ReadTheDocs <https://prospector.readthedocs.io>`_.\n\nUsage\n-----\n\nSimply run prospector from the root of your project::\n\n    prospector\n\nThis will output a list of messages pointing out potential problems or errors, for example::\n\n    prospector.tools.base (prospector/tools/base.py):\n        L5:0 ToolBase: pylint - R0922\n        Abstract class is only referenced 1 times\n\nOptions\n```````\n\nRun ``prospector --help`` for a full list of options and their effects.\n\nOutput Format\n~~~~~~~~~~~~~\n\nThe default output format of ``prospector`` is designed to be human readable. For parsing\n(for example, for reporting), you can use the ``--output-format json`` flag to get JSON-formatted\noutput.\n\nProfiles\n~~~~~~~~\n\nProspector is configurable using "profiles". These are composable YAML files with directives to\ndisable or enable tools or messages. For more information, read\n`the documentation about profiles <https://prospector.readthedocs.io/en/latest/profiles.html>`_.\n\nIf your code uses frameworks and libraries\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nOften tools such as pylint find errors in code which is not an error, for example due to attributes of classes being\ncreated at run time by a library or framework used by your project.\nFor example, by default, pylint will generate an error for Django models when accessing ``objects``, as the\n``objects`` attribute is not part of the ``Model`` class definition.\n\nProspector mitigates this by providing an understanding of these frameworks to the underlying tools.\n\nProspector will try to intuit which libraries your project uses by\n`detecting dependencies <https://github.com/landscapeio/requirements-detector>`_ and automatically turning on\nsupport for the requisite libraries. You can see which adaptors were run in the metadata section of the report.\n\nIf Prospector does not correctly detect your project\'s dependencies, you can specify them manually from the commandline::\n\n    prospector --uses django celery\n\nAdditionally, if Prospector is automatically detecting a library that you do not in fact use, you can turn\noff autodetection completely::\n\n    prospector --no-autodetect\n\nNote that as far as possible, these adaptors have been written as plugins or augmentations for the underlying\ntools so that they can be used without requiring Prospector. For example, the Django support is available as a pylint plugin.\n\nStrictness\n~~~~~~~~~~\n\nProspector has a configurable \'strictness\' level which will determine how harshly it searches for errors::\n\n    prospector --strictness high\n\nPossible values are ``verylow``, ``low``, ``medium``, ``high``, ``veryhigh``.\n\nProspector does not include documentation warnings by default, but you can turn\nthis on using the ``--doc-warnings`` flag.\n\npre-commit\n----------\n\nIf you\'d like Prospector to be run automatically when making changes to files in your Git\nrepository, you can install `pre-commit <https://pre-commit.com/>`_ and add the following\ntext to your repositories\' ``.pre-commit-config.yaml``::\n\n    repos:\n    -   repo: https://github.com/PyCQA/prospector\n        rev: 1.10.0 # The version of Prospector to use, if not \'master\' for latest\n        hooks:\n        -   id: prospector\n\nThis only installs base prospector - if you also use optional tools, for example bandit and/or mypy, then you can add\nthem to the hook configuration like so::\n\n    repos:\n    -   repo: https://github.com/PyCQA/prospector\n        rev: 1.10.0\n        hooks:\n        -   id: prospector\n            additional_dependencies:\n            - ".[with_mypy,with_bandit]"\n          - args: [\n            \'--with-tool=mypy\',\n            \'--with-tool=bandit\',\n            ]\n\nAdditional dependencies can be `individually configured <https://prospector.landscape.io/en/master/profiles.html#individual-configuration-options>`_ in your `prospector.yml` file ::\n\n    # https://bandit.readthedocs.io/en/latest/config.html\n    bandit:\n    options:\n        skips:\n        - B201\n        - B601\n        - B610\n        - B611\n        - B703\n\n    # https://mypy.readthedocs.io/en/stable/command_line.html\n    mypy:\n    options:\n        ignore-missing-imports: true\n\nFor prospector options which affect display only - those which are not configurable using a profile - these can be\nadded as command line arguments to the hook. For example::\n\n    repos:\n    -   repo: https://github.com/PyCQA/prospector\n        rev: 1.10.0\n        hooks:\n        -   id: prospector\n            additional_dependencies:\n            -   ".[with_mypy,with_bandit]"\n            args:\n            -   --with-tool=mypy\n            -   --with-tool=bandit\n            -   --summary-only\n            -   --zero-exit\n\n\n\nLicense\n-------\n\nProspector is available under the GPLv2 License.\n',
     'author': 'Carl Crowder',