prospector 1.15.3__tar.gz → 1.16.0__tar.gz

{prospector-1.15.3 → prospector-1.16.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: prospector
-Version: 1.15.3
+Version: 1.16.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+
@@ -46,7 +46,6 @@ Requires-Dist: pyflakes (>=2.2.0)
 Requires-Dist: pylint (>=3.0)
 Requires-Dist: pylint-celery (==0.3)
 Requires-Dist: pylint-django (>=2.6.1)
-Requires-Dist: pylint-flask (==0.6)
 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 (>=1.3.2)

{prospector-1.15.3 → prospector-1.16.0}/prospector/autodetect.py

@@ -11,7 +11,7 @@ from prospector import encoding
 from prospector.exceptions import PermissionMissing
 from prospector.pathutils import is_virtualenv
 
-POSSIBLE_LIBRARIES = ("django", "celery", "flask")
+POSSIBLE_LIBRARIES = ("django", "celery")
 
 
 # see http://docs.python.org/2/reference/lexical_analysis.html#identifiers

{prospector-1.15.3 → prospector-1.16.0}/prospector/blender_combinations.yaml

@@ -4,19 +4,22 @@
 #
 # Note that since not all tools will necessarily be run, the first message for
 # a line as sorted by the code list will be the one remaining after blending.
+#
+# We put at first the PyLint, mypy and Ruff codes because we can
+# ignore a specific code on a specific line.
 
 combinations:
   - # Unused Import
     - pylint: unused-import
     - pylint: W0611
+    - ruff: F401
     - pyflakes: F401
     - frosted: E101
-    - ruff: F401
 
   - # Syntax Error
-    - dodgy: diff
     - pylint: syntax-error
     - pylint: E0001
+    - dodgy: diff
     - pyflakes: F999
     - pep8: E901
     # expected an indented block
@@ -29,222 +32,222 @@ combinations:
   - # Undefined local variable
     - pylint: undefined-variable
     - pylint: E0602
+    - mypy: name-defined
+    - ruff: F821
     - pyflakes: F821
     - frosted: E303
-    - ruff: F821
-    - mypy: name-defined
 
   - # Unused variable
     - pylint: unused-variable
     - pylint: W0612
+    - ruff: F841
     - vulture: unused-variable
     - pyflakes: F841
     - frosted: E307
-    - ruff: F841
 
   - # Mixed tabs and spaces
+    - pylint: indentation-mixture
+    - ruff: D206
     - pep257: D206
     - pydocstyle: D206
     - pep8: E101
     - pycodestyle: E101
-    - pylint: indentation-mixture
-    - ruff: D206
 
   - # Import from __future__ not first import
     - pylint: misplaced-future
     - pylint: W0410
+    - ruff: F404
     - pyflakes: F404
     - frosted: E207
-    - ruff: F404
 
   - # Line too long
-    - pep8: E501
-    - pycodestyle: E501
     - pylint: line-too-long
     - pylint: C0301
+    - pep8: E501
+    - pycodestyle: E501
 
   - # Trailing whitespace
-    - pep8: W291
-    - pycodestyle: W291
     - pylint: trailing-whitespace
     - pylint: C0303
+    - pep8: W291
+    - pycodestyle: W291
 
   - # Blank line contains whitespace
-    - pep8: W293
-    - pycodestyle: W293
     - pylint: trailing-whitespace
     - pylint: C0303
+    - pep8: W293
+    - pycodestyle: W293
 
   - # No newline at end of file
-    - pep8: W292
-    - pycodestyle: W292
     - pylint: missing-final-newline
     - pylint: C0304
+    - pep8: W292
+    - pycodestyle: W292
 
   - # line ends with semi-colon
-    - pep8: E703
-    - pycodestyle: E703
     - pylint: unnecessary-semicolon
     - pylint: W0301
+    - pep8: E703
+    - pycodestyle: E703
 
   - # multiple statements on one line (colon)
-    - pep8: E701
-    - pycodestyle: E701
     - pylint: multiple-statements
     - pylint: C0321
+    - pep8: E701
+    - pycodestyle: E701
 
   - # multiple statements on one line (semicolon)
-    - pep8: E702
-    - pycodestyle: E702
     - pylint: multiple-statements
     - pylint: C0321
+    - pep8: E702
+    - pycodestyle: E702
 
   - # incorrect indentation
+    - pylint: bad-indentation
+    - pylint: W0311
+    - ruff: D207
     - pep257: D207
     - pydocstyle: D207
     - pep8: E111
     - pycodestyle: E111
-    - pylint: bad-indentation
-    - pylint: W0311
-    - ruff: D207
 
   - # incorrect indentation
+    - pylint: bad-indentation
+    - pylint: W0311
+    - ruff: D208
     - pep257: D208
     - pydocstyle: D208
     - pep8: E111
     - pycodestyle: E111
-    - pylint: bad-indentation
-    - pylint: W0311
-    - ruff: D208
 
   - # comma not followed by a space
-    - pep8: E231
-    - pycodestyle: E231
     - pylint: C0324
     - pylint: bad-whitespace
+    - pep8: E231
+    - pycodestyle: E231
 
   - # missing whitespace around operator
-    - pep8: E225
-    - pycodestyle: E225
     - pylint: C0322
     - pylint: bad-whitespace
-
-  - # missing whitespace around operator
     - pep8: E225
     - pycodestyle: E225
+
+  - # missing whitespace around operator
     - pylint: C0323
     - pylint: bad-whitespace
+    - pep8: E225
+    - pycodestyle: E225
 
   - # undefined name in __all__
     - pylint: undefined-all-variable
     - pylint: E0603
+    - ruff: F822
     - pyflakes: F822
     - frosted: E304
-    - ruff: F822
 
   - # duplicate argument in function definition
     - pylint: duplicate-argument-name
     - pylint: E0108
+    - ruff: F831
     - pyflakes: F831
     - frosted: E206
-    - ruff: F831
 
   - # redefinition of unused function
-    - pyflakes: F811
     - pylint: function-redefined
     - pylint: E0102
     - ruff: F811
+    - pyflakes: F811
 
   - # f-string is missing placeholders
     - pylint: f-string-without-interpolation
     - pylint: W1309
-    - pyflakes: F541
     - ruff: F541
+    - pyflakes: F541
 
   - # Duplicate key in dictionary
     - pylint: duplicate-key
     - pylint: W0109
-    - pyflakes: F601
     - ruff: F601
+    - pyflakes: F601
 
   - # More than one starred expression in assignment
     - pylint: too-many-star-expressions
     - pylint: E0112
-    - pyflakes: F622
     - ruff: F622
+    - pyflakes: F622
 
   - # Assert called on a tuple
     - pylint: assert-on-tuple
     - pylint: W0199
-    - pyflakes: F631
     - ruff: F631
+    - pyflakes: F631
 
   - # 'break' outside loop
     - pylint: not-in-loop
     - pylint: E0103
-    - pyflakes: F701
     - ruff: F701
+    - pyflakes: F701
 
   - # 'continue' not properly in loop
     - pylint: not-in-loop
     - pylint: E0103
-    - pyflakes: F702
     - ruff: F702
+    - pyflakes: F702
 
   - # 'continue' not supported inside 'finally' clause
     - pylint: continue-in-finally
     - pylint: E0116
-    - pyflakes: F703
     - ruff: F703
     - ruff: PLE0116
+    - pyflakes: F703
 
   - # Yield outside function
     - pylint: yield-outside-function
     - pylint: E0105
-    - pyflakes: F704
     - ruff: F704
+    - pyflakes: F704
 
   - # Return outside function
     - pylint: return-outside-function
     - pylint: E0104
-    - pyflakes: F706
     - ruff: F706
+    - pyflakes: F706
 
   - # default 'except:' must be last
     - pylint: bad-except-order
     - pylint: E0701
-    - pyflakes: F707
     - ruff: F707
+    - pyflakes: F707
 
   - # NotImplemented raised - should raise NotImplementedError
     - pylint: notimplemented-raised
     - pylint: E0711
-    - pyflakes: F901
     - ruff: F901
+    - pyflakes: F901
 
   - # first argument of a classmethod should be named 'cls'
-    - pep8: N804
-    - pycodestyle: N804
     - pylint: bad-classmethod-argument
     - pylint: C0202
     - ruff: N804
+    - pep8: N804
+    - pycodestyle: N804
 
   - # '<>' is deprecated, use '!='
+    - pylint: W0331
     - pep8: W603
     - pycodestyle: W603
-    - pylint: W0331
 
   - # backticks are deprecated, use 'repr()'
+    - pylint: W0333
     - pep8: W604
     - pycodestyle: W604
-    - pylint: W0333
 
   - # Redefining name from outer scope
     - pylint: redefined-outer-name
     - pylint: W0621
+    - ruff: F810
     - pyflakes: F810
     - frosted: E306
-    - ruff: F810
 
   - # Redefinition of unused variable
     - pylint: redefined-outer-name
@@ -254,9 +257,9 @@ combinations:
   - # Wildcard import
     - pylint: wildcard-import
     - pylint: W0614
+    - ruff: F403
     - pyflakes: F403
     - frosted: E103
-    - ruff: F403
 
   - # Return with argument inside generator
     - pylint: return-arg-in-generator
@@ -281,23 +284,23 @@ combinations:
   - # No exception type(s) specified
     - pylint: bare-except
     - pylint: W0702
-    - frosted: W101
-    - pep8: E722
-    - pycodestyle: E722
     - ruff: E722
     # try_except_pass
     - ruff: S110
+    - frosted: W101
+    - pep8: E722
+    - pycodestyle: E722
     - bandit: B110
 
   - # No exception type(s) specified
     - pylint: bare-except
     - pylint: W0702
-    - frosted: W101
-    - pep8: E722
-    - pycodestyle: E722
     - ruff: E722
     # try_except_continue
     - ruff: S112
+    - frosted: W101
+    - pep8: E722
+    - pycodestyle: E722
     - bandit: B112
 
   - # Do not catch blind exception: `Exception`
@@ -316,39 +319,39 @@ combinations:
     - ruff: TRY002
 
   - # Spaces around keyword/parameter equals
+    - pylint: bad-whitespace
     - pep8: E251
     - pycodestyle: E251
-    - pylint: bad-whitespace
 
   - # Missing space after a comma
+    - pylint: bad-whitespace
     - pep8: E231
     - pycodestyle: E231
-    - pylint: bad-whitespace
 
   - # redefinition of unused %r from line %r
+    - ruff: F811
     - pyflakes: F811
     - frosted: E301
-    - ruff: F811
 
   - # list comprehension redefines %r from line %r
+    - ruff: F812
     - pyflakes: F812
     - frosted: E302
-    - ruff: F812
 
   - # import %r from line %r shadowed by loop variable
+    - ruff: F402
     - pyflakes: F402
     - frosted: E102
-    - ruff: F402
 
   - # syntax error in doctest
+    - ruff: FL0007
     - pyflakes: FL0007
     - frosted: E401
-    - ruff: FL0007
 
   - # local variable %r referenced before assignment
+    - ruff: F823
     - pyflakes: F823
     - frosted: E305
-    - ruff: F823
 
   - # pep8-naming incorrectly suggests that the first argument of a metaclass __new__ method should be 'cls'
     - pylint: bad-mcs-classmethod-argument
@@ -357,71 +360,72 @@ combinations:
     - pycodestyle: N804
 
   - # class names should be camelcase
-    - pep8: N801
-    - pycodestyle: N801
     - pylint: invalid-name
     - pylint: C0103
+    - pep8: N801
+    - pycodestyle: N801
 
   - # function name should be lowercase
     - pylint: invalid-name
     - pylint: C0103
+    - ruff: N802
     - pep8: N802
     - pycodestyle: N802
-    - ruff: N802
 
   - # argument name should be lowercase
     - pylint: invalid-name
     - pylint: C0103
+    - ruff: N803
     - pep8: N803
     - pycodestyle: N803
-    - ruff: N803
 
   - # Variable in function should be lowercase
     - pylint: invalid-name
     - pylint: C0103
+    - ruff: N806
     - pep8: N806
     - pycodestyle: N806
-    - ruff: N806
 
   # too complex
   - #	Too many branches ({branches} > {max_branches})
     - pylint: too-many-branches
     - pylint: R0912
-    - mccabe: MC0001
     - ruff: PLR0912
+    - mccabe: MC0001
+
   - #	Too many statements ({statements} > {max_statements})
     - pylint: too-many-statements
     - pylint: R0915
-    - mccabe: MC0001
     - ruff: PLR0915
+    - mccabe: MC0001
 
   - # pep257 takes preference over pylint documentation warnings
-    - pep257: D100
-    - pydocstyle: D100
     - pylint: missing-docstring
     - pylint: C0111
     - ruff: D100
+    - pep257: D100
+    - pydocstyle: D100
 
   - # Missing docstring in public class
-    - pep257: D101
-    - pydocstyle: D101
     - pylint: missing-docstring
     - pylint: C0111
     - ruff: D101
+    - pep257: D101
+    - pydocstyle: D101
 
   - # Missing docstring in public method
-    - pep257: D102
-    - pydocstyle: D102
     - pylint: missing-docstring
     - pylint: C0111
     - ruff: D102
+    - pep257: D102
+    - pydocstyle: D102
 
   - # Missing docstring in public function
-    - pep257: D103
-    - pydocstyle: D103
     - pylint: missing-docstring
     - pylint: C0111
     - ruff: D103
+    - pep257: D103
+    - pydocstyle: D103
 
   - - pylint: singleton-comparison
     - pylint: C0221
@@ -430,9 +434,9 @@ combinations:
 
   - - pylint: subprocess-run-check
     - pylint: W1510
-    - bandit: B603
     - ruff: S603
     - ruff: PLW1510
+    - bandit: B603
 
   - # Private member accessed:
     - pylint: protected-access
@@ -591,8 +595,8 @@ combinations:
   # See: https://docs.astral.sh/ruff/rules/suspicious-eval-usage
   - - pylint: eval-used
     - pylint: W0123
-    - bandit: B307
     - ruff: S307
+    - bandit: B307
 
   - # {kind} name "{param_name}" does not reflect its {variance}; consider renaming it to "{replacement_name}"
     - pylint: type-name-incorrect-variance

{prospector-1.15.3 → prospector-1.16.0}/prospector/config/configuration.py

@@ -127,7 +127,7 @@ def build_command_line_source(
         "uses": {
             "flags": ["-u", "--uses"],
             "help": "A list of one or more libraries or frameworks that the"
-            " project uses. Possible values are: django, celery, flask. This will be"
+            " project uses. Possible values are: django, celery. This will be"
             " autodetected by default, but if autodetection doesn't"
             " work, manually specify them using this flag.",
         },

prospector-1.16.0/prospector/formatters/base_summary.py

@@ -0,0 +1,90 @@
+import os
+from pathlib import Path
+from typing import Optional
+
+from prospector.formatters.base import Formatter
+from prospector.message import Location, Message
+
+
+class SummaryFormatter(Formatter):
+    """
+    This abstract formatter is used to output a summary of the prospector run.
+    """
+
+    summary_labels = (
+        ("started", "Started", None),
+        ("completed", "Finished", None),
+        ("time_taken", "Time Taken", lambda x: f"{x} seconds"),
+        ("formatter", "Formatter", None),
+        ("profiles", "Profiles", None),
+        ("strictness", "Strictness", None),
+        ("libraries", "Libraries Used", ", ".join),
+        ("tools", "Tools Run", ", ".join),
+        ("adaptors", "Adaptors", ", ".join),
+        ("message_count", "Messages Found", None),
+        ("external_config", "External Config", None),
+    )
+
+    def render_summary(self) -> str:
+        output = [
+            "Check Information",
+            "=================",
+        ]
+
+        label_width = max(len(label[1]) for label in self.summary_labels)
+
+        for key, label, formatter in self.summary_labels:
+            if key in self.summary:
+                value = self.summary[key]
+                if formatter is not None:
+                    value = formatter(value)
+                output.append(f" {label.rjust(label_width)}: {value}")
+
+        return "\n".join(output)
+
+    def render_profile(self) -> str:
+        output = ["Profile", "=======", "", self.profile.as_yaml().strip()]
+
+        return "\n".join(output)
+
+    def get_ci_annotation(self, message: Message) -> Optional[str]:
+        intro = (
+            f"({message.source})"
+            if message.code is None
+            else f"{message.code}({message.source})"
+            if message.location.function is None
+            else f"[{message.code}({message.source}), {message.location.function}]"
+        )
+        ci_prefix = self._get_ci_prefix(message.location, intro)
+        if ci_prefix:
+            github_message = f"{ci_prefix}{intro}%0A{message.message.strip()}"
+            if message.doc_url:
+                github_message += f"%0ASee: {message.doc_url}"
+            return github_message
+        return None
+
+    def _get_ci_prefix(self, location: Location, title: str) -> Optional[str]:
+        if location.path is None:
+            return None
+        if os.environ.get("GITHUB_ACTIONS") == "true":
+            path = location.path
+            if "PROSPECTOR_FILE_PREFIX" in os.environ:
+                path = Path(os.environ["PROSPECTOR_FILE_PREFIX"]) / path
+            # pylint: disable-next=line-too-long
+            # See: https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-an-error-message
+            parameters = {
+                "file": path,
+                "line": location.line,
+                "title": title,
+            }
+            if location.line_end:
+                parameters["endLine"] = location.line_end
+            if location.character:
+                parameters["col"] = location.character
+            if location.character_end:
+                parameters["endColumn"] = location.character_end
+
+            parameters_str = ",".join(f"{key}={value}" for key, value in parameters.items())
+            return f"::error {parameters_str}::"
+
+        return None

{prospector-1.15.3 → prospector-1.16.0}/prospector/formatters/pylint.py

@@ -52,18 +52,23 @@ class PylintFormatter(SummaryFormatter):
             message_str = message.message.strip()
             if message.doc_url:
                 message_str += f" (See: {message.doc_url})"
-            output.append(
-                template
-                % {
-                    "path": self._make_path(message.location),
-                    "line": message.location.line,
-                    "character": message.location.character,
-                    "source": message.source,
-                    "code": message.code,
-                    "function": message.location.function,
-                    "message": message.message.strip(),
-                }
-            )
+            template_args = {
+                "path": self._make_path(message.location),
+                "line": message.location.line,
+                "character": message.location.character,
+                "source": message.source,
+                "code": message.code,
+                "function": message.location.function,
+                "message": message.message.strip(),
+            }
+            output.append(template % template_args)
+            if message.doc_url:
+                template_args["message"] = ""
+                indent = len(template % template_args)
+                output.append(f"{' ' * indent}See: {message.doc_url}")
+            ci_annotation = self.get_ci_annotation(message)
+            if ci_annotation:
+                output.append(ci_annotation)
         return output
 
     def render(self, summary: bool = True, messages: bool = True, profile: bool = False) -> str:

{prospector-1.15.3 → prospector-1.16.0}/prospector/formatters/text.py

@@ -24,6 +24,9 @@ class TextFormatter(SummaryFormatter):
         )
 
         output.append(f"    {message.message}")
+        ci_annotation = self.get_ci_annotation(message)
+        if ci_annotation:
+            output.append(ci_annotation)
 
         return "\n".join(output)
 

prospector-1.16.0/prospector/identify.py

@@ -0,0 +1,90 @@
+# Largely inspired by https://github.com/pre-commit/identify/blob/main/identify/identify.py#L178
+
+import errno
+import os
+import shlex
+import string
+from pathlib import Path
+from typing import IO
+
+printable = frozenset(string.printable)
+
+
+def _shebang_split(line: str) -> tuple[str, ...]:
+    try:
+        # shebangs aren't supposed to be quoted, though some tools such as
+        # setuptools will write them with quotes so we'll best-guess parse
+        # with shlex first
+        return tuple(shlex.split(line))
+    except ValueError:
+        # failing that, we'll do a more "traditional" shebang parsing which
+        # just involves splitting by whitespace
+        return tuple(line.split())
+
+
+def _parse_nix_shebang(
+    bytes_io: IO[bytes],
+    cmd: tuple[str, ...],
+) -> tuple[str, ...]:
+    while bytes_io.read(2) == b"#!":
+        next_line_b = bytes_io.readline()
+        try:
+            next_line = next_line_b.decode("UTF-8")
+        except UnicodeDecodeError:
+            return cmd
+
+        for c in next_line:
+            if c not in printable:
+                return cmd
+
+        line_tokens = _shebang_split(next_line.strip())
+        for i, token in enumerate(line_tokens[:-1]):
+            if token != "-i":  # noqa: S105
+                continue
+            # The argument to -i flag
+            cmd = (line_tokens[i + 1],)
+    return cmd
+
+
+def _parse_shebang(bytes_io: IO[bytes]) -> tuple[str, ...]:
+    """Parse the shebang from a file opened for reading binary."""
+    if bytes_io.read(2) != b"#!":
+        return ()
+    first_line_b = bytes_io.readline()
+    try:
+        first_line = first_line_b.decode("UTF-8")
+    except UnicodeDecodeError:
+        return ()
+
+    # Require only printable ascii
+    for c in first_line:
+        if c not in printable:
+            return ()
+
+    cmd = _shebang_split(first_line.strip())
+    if cmd[:2] == ("/usr/bin/env", "-S"):
+        cmd = cmd[2:]
+    elif cmd[:1] == ("/usr/bin/env",):
+        cmd = cmd[1:]
+
+    if cmd == ("nix-shell",):
+        return _parse_nix_shebang(bytes_io, cmd)
+
+    return cmd
+
+
+def parse_shebang_from_file(path: Path) -> tuple[str, ...]:
+    """Parse the shebang given a file path."""
+    if not path.exists():
+        return ()
+    if not os.access(path, os.X_OK):
+        return ()
+
+    try:
+        with path.open("rb") as f:
+            return _parse_shebang(f)
+    except OSError as e:
+        if e.errno == errno.EINVAL:
+            return ()
+        else:
+            raise

{prospector-1.15.3 → prospector-1.16.0}/prospector/pathutils.py

@@ -1,14 +1,28 @@
+import mimetypes
 import os
+import re
 from pathlib import Path
 
+from prospector import identify
+
+_PYTHON_COMMAND_RE = re.compile(r"^python[0-9]?$")
+
 
 def is_python_package(path: Path) -> bool:
     return path.is_dir() and (path / "__init__.py").exists()
 
 
 def is_python_module(path: Path) -> bool:
-    # TODO: is this too simple?
-    return path.suffix == ".py"
+    mimetype, encoding = mimetypes.guess_type(path)
+    del encoding
+    if mimetype == "text/x-python":
+        return True
+
+    executor = identify.parse_shebang_from_file(path)
+    if executor is not None and len(executor) > 0:
+        return _PYTHON_COMMAND_RE.match(Path(executor[0]).name) is not None
+
+    return False
 
 
 def is_virtualenv(path: Path) -> bool:

{prospector-1.15.3 → prospector-1.16.0}/prospector/profiles/profile.py

@@ -26,7 +26,7 @@ class ProspectorProfile:
         self.output_target = profile_dict.get("output-target")
         self.autodetect = profile_dict.get("autodetect", True)
         self.uses = [
-            uses for uses in _ensure_list(profile_dict.get("uses", [])) if uses in ("django", "celery", "flask")
+            uses for uses in _ensure_list(profile_dict.get("uses", [])) if uses in ("django", "celery")
         ]
         self.max_line_length = profile_dict.get("max-line-length")
 
@@ -133,7 +133,10 @@ def _load_content_package(name: str) -> Optional[dict[str, Any]]:
     used_name = None
     for file_name in file_names:
         used_name = f"{module_name}:{file_name}"
-        data = pkgutil.get_data(module_name, file_name)
+        try:
+            data = pkgutil.get_data(module_name, file_name)
+        except (ModuleNotFoundError, FileNotFoundError):
+            continue
         if data is not None:
             break
 

{prospector-1.15.3 → prospector-1.16.0}/prospector/suppression.py

@@ -174,8 +174,8 @@ def get_suppressions(
             for line_number, line_content in enumerate(file_contents):
                 for tool_name, tool in tools.items():
                     tool_ignores = tool.get_ignored_codes(line_content)
-                    for tool_ignore in tool_ignores:
-                        tools_ignore[filepath][line_number + 1].add(Ignore(tool_name, tool_ignore))
+                    for tool_ignore, offset in tool_ignores:
+                        tools_ignore[filepath][line_number + 1 + offset].add(Ignore(tool_name, tool_ignore))
 
     # Ignore the blending messages
     if blending:

{prospector-1.15.3 → prospector-1.16.0}/prospector/tools/base.py

@@ -44,9 +44,9 @@ class ToolBase(ABC):
         """
         raise NotImplementedError
 
-    def get_ignored_codes(self, line: str) -> list[str]:
+    def get_ignored_codes(self, line: str) -> list[tuple[str, int]]:
         """
-        Return a list of error codes that the tool will ignore from a line of code.
+        Return a list of error codes and line offset that the tool will ignore from a line of code.
         """
         del line  # unused
         return []

{prospector-1.15.3 → prospector-1.16.0}/prospector/tools/mypy/__init__.py

@@ -154,8 +154,8 @@ class MypyTool(ToolBase):
 
         return messages
 
-    def get_ignored_codes(self, line: str) -> list[str]:
+    def get_ignored_codes(self, line: str) -> list[tuple[str, int]]:
         match = _IGNORE_RE.search(line)
         if match:
-            return [e.strip() for e in match.group(1).split(",")]
+            return [(e.strip(), 0) for e in match.group(1).split(",")]
         return []

{prospector-1.15.3 → prospector-1.16.0}/prospector/tools/profile_validator/__init__.py

@@ -123,7 +123,7 @@ class ProfileValidationTool(ToolBase):
                 )
 
         if "uses" in parsed:
-            possible_libs = ("django", "celery", "flask")
+            possible_libs = ("django", "celery")
             parsed_list = parsed["uses"] if isinstance(parsed["uses"], list) else [parsed["uses"]]
             for uses in parsed_list:
                 if uses not in possible_libs:

{prospector-1.15.3 → prospector-1.16.0}/prospector/tools/pylint/__init__.py

@@ -22,6 +22,7 @@ if TYPE_CHECKING:
 _UNUSED_WILDCARD_IMPORT_RE = re.compile(r"^Unused import(\(s\))? (.*) from wildcard import")
 
 _IGNORE_RE = re.compile(r"#\s*pylint:\s*disable=([^#]*[^#\s])(\s*#.*)?$", re.IGNORECASE)
+_IGNORE_NEXT_RE = re.compile(r"#\s*pylint:\s*disable-next=([^#]*[^#\s])(\s*#.*)?$", re.IGNORECASE)
 
 
 def _is_in_dir(subpath: Path, path: Path) -> bool:
@@ -46,8 +47,6 @@ class PylintTool(ToolBase):
             linter.load_plugin_modules(["pylint_django"])
         if "celery" in prospector_config.libraries:
             linter.load_plugin_modules(["pylint_celery"])
-        if "flask" in prospector_config.libraries:
-            linter.load_plugin_modules(["pylint_flask"])
 
         profile_path = os.path.join(prospector_config.workdir, prospector_config.profile.name)
         for plugin in prospector_config.profile.pylint.get("load-plugins", []):  # type: ignore[attr-defined]
@@ -269,8 +268,11 @@ class PylintTool(ToolBase):
         messages = self._collector.get_messages()
         return self.combine(messages)
 
-    def get_ignored_codes(self, line: str) -> list[str]:
+    def get_ignored_codes(self, line: str) -> list[tuple[str, int]]:
         match = _IGNORE_RE.search(line)
         if match:
-            return [e.strip() for e in match.group(1).split(",")]
+            return [(e.strip(), 0) for e in match.group(1).split(",")]
+        match = _IGNORE_NEXT_RE.search(line)
+        if match:
+            return [(e.strip(), 1) for e in match.group(1).split(",")]
         return []

{prospector-1.15.3 → prospector-1.16.0}/prospector/tools/ruff/__init__.py

@@ -88,8 +88,8 @@ class RuffTool(ToolBase):
             )
         return messages
 
-    def get_ignored_codes(self, line: str) -> list[str]:
+    def get_ignored_codes(self, line: str) -> list[tuple[str, int]]:
         match = PEP8_IGNORE_LINE_CODE.search(line)
         if match:
-            return [e.strip() for e in match.group(1).split(",")]
+            return [(e.strip(), 0) for e in match.group(1).split(",")]
         return []

{prospector-1.15.3 → prospector-1.16.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "prospector"
-version = "1.15.3"
+version = "1.16.0"
 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>",
@@ -42,7 +42,6 @@ python = ">=3.9,<4.0"
 pylint = ">=3.0"
 pylint-celery = "0.3"
 pylint-django = ">=2.6.1"
-pylint-flask = "0.6"
 requirements-detector = ">=1.3.2"
 PyYAML = "*"
 mccabe = "^0.7.0"

{prospector-1.15.3 → prospector-1.16.0}/setup.py

@@ -36,7 +36,6 @@ install_requires = \
  'pyflakes>=2.2.0',
  'pylint-celery==0.3',
  'pylint-django>=2.6.1',
- 'pylint-flask==0.6',
  'pylint>=3.0',
  'requirements-detector>=1.3.2',
  'setoptconf-tmp>=0.3.1,<0.4.0',
@@ -61,7 +60,7 @@ entry_points = \
 
 setup_kwargs = {
     'name': 'prospector',
-    'version': '1.15.3',
+    'version': '1.16.0',
     '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',

prospector-1.15.3/prospector/formatters/base_summary.py

@@ -1,43 +0,0 @@
-from prospector.formatters.base import Formatter
-
-
-class SummaryFormatter(Formatter):
-    """
-    This abstract formatter is used to output a summary of the prospector run.
-    """
-
-    summary_labels = (
-        ("started", "Started", None),
-        ("completed", "Finished", None),
-        ("time_taken", "Time Taken", lambda x: f"{x} seconds"),
-        ("formatter", "Formatter", None),
-        ("profiles", "Profiles", None),
-        ("strictness", "Strictness", None),
-        ("libraries", "Libraries Used", ", ".join),
-        ("tools", "Tools Run", ", ".join),
-        ("adaptors", "Adaptors", ", ".join),
-        ("message_count", "Messages Found", None),
-        ("external_config", "External Config", None),
-    )
-
-    def render_summary(self) -> str:
-        output = [
-            "Check Information",
-            "=================",
-        ]
-
-        label_width = max(len(label[1]) for label in self.summary_labels)
-
-        for key, label, formatter in self.summary_labels:
-            if key in self.summary:
-                value = self.summary[key]
-                if formatter is not None:
-                    value = formatter(value)
-                output.append(f" {label.rjust(label_width)}: {value}")
-
-        return "\n".join(output)
-
-    def render_profile(self) -> str:
-        output = ["Profile", "=======", "", self.profile.as_yaml().strip()]
-
-        return "\n".join(output)