prospector 1.13.3__tar.gz → 1.14.1__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: prospector
-Version: 1.13.3
+Version: 1.14.1
 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.3 → prospector-1.14.1}/prospector/blender_combinations.yaml

@@ -277,6 +277,11 @@ combinations:
   - - pep257: D103
     - pydocstyle: D103
     - pylint: missing-docstring
+
   - - pylint: singleton-comparison
     - pep8: E711
     - pycodestyle: E711
+
+  - - pylint: subprocess-run-check
+    - bandit: B603
+    - ruff: S603

{prospector-1.13.3 → prospector-1.14.1}/prospector/finder.py

@@ -56,8 +56,8 @@ class FileFinder:
     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]:
-        return [path for path in paths if not self.is_excluded(path)]
+    def _filter(self, paths: Iterable[Path]) -> set[Path]:
+        return {path for path in paths if not self.is_excluded(path)}
 
     def _walk(self, directory: Path) -> Iterator[Path]:
         if not self.is_excluded(directory):
@@ -72,22 +72,25 @@ class FileFinder:
                 yield path
 
     @property
-    def files(self) -> list[Path]:
+    def files(self) -> set[Path]:
         """
         List every individual file found from the given configuration.
 
         This method is useful for tools which require an explicit list of files to check.
         """
         files = set()
-        for path in self._provided_files:
-            files.add(path)
 
         for directory in self.directories:
             for path in self._walk(directory):
                 if path.is_file():
                     files.add(path)
 
-        return self._filter(files)
+        files = self._filter(files)
+
+        for path in self._provided_files:
+            files.add(path)
+
+        return files
 
     @property
     def python_packages(self) -> list[Path]:
@@ -97,7 +100,7 @@ class FileFinder:
 
         This method is useful for passing to tools which will do their own discovery of python files.
         """
-        return self._filter(d for d in self.directories if is_python_package(d))
+        return [d for d in self.directories if is_python_package(d)]
 
     @property
     def python_modules(self) -> list[Path]:
@@ -107,10 +110,10 @@ class FileFinder:
 
         This method is useful for passing to tools which will do their own discovery of python files.
         """
-        return self._filter(f for f in self.files if is_python_module(f))
+        return [f for f in self.files if is_python_module(f)]
 
     @property
-    def directories(self) -> list[Path]:
+    def directories(self) -> set[Path]:
         """
         Lists every directory found from the given configuration, regardless of its contents.
 

{prospector-1.13.3 → prospector-1.14.1}/prospector/formatters/__init__.py

@@ -1,4 +1,4 @@
-from . import emacs, grouped, json, pylint, text, vscode, xunit, yaml
+from . import emacs, grouped, json, pylint, pylint_parseable, text, vscode, xunit, yaml
 from .base import Formatter
 
 __all__ = ("FORMATTERS", "Formatter")
@@ -11,6 +11,7 @@ FORMATTERS: dict[str, type[Formatter]] = {
     "emacs": emacs.EmacsFormatter,
     "yaml": yaml.YamlFormatter,
     "pylint": pylint.PylintFormatter,
+    "pylint_parseable": pylint_parseable.PylintParseableFormatter,
     "xunit": xunit.XunitFormatter,
     "vscode": vscode.VSCodeFormatter,
 }

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

@@ -39,9 +39,18 @@ class Formatter(ABC):
             "line": message.location.line,
             "character": message.location.character,
         }
-        return {
+        if message.location.line_end is not None and message.location.line_end != -1:
+            loc["lineEnd"] = message.location.line_end
+        if message.location.character_end is not None and message.location.character_end != -1:
+            loc["characterEnd"] = message.location.character_end
+        result = {
             "source": message.source,
             "code": message.code,
             "location": loc,
             "message": message.message,
+            "isFixable": message.is_fixable,
         }
+        if message.doc_url:
+            result["docUrl"] = message.doc_url
+
+        return result

{prospector-1.13.3 → prospector-1.14.1}/prospector/formatters/emacs.py

@@ -7,12 +7,7 @@ __all__ = ("EmacsFormatter",)
 class EmacsFormatter(TextFormatter):
     def render_message(self, message: Message) -> str:
         output = [
-            "%s:%s:%d:"
-            % (
-                self._make_path(message.location),
-                message.location.line,
-                (message.location.character or 0) + 1,
-            ),
+            f"{self._make_path(message.location)}:{message.location.line}:{(message.location.character or 0) + 1}:",
             "    L{}:{} {}: {} - {}".format(
                 message.location.line or "-",
                 message.location.character if message.location.line else "-",

prospector-1.14.1/prospector/formatters/pylint.py

@@ -0,0 +1,80 @@
+import os
+import re
+
+from prospector.formatters.base_summary import SummaryFormatter
+
+
+class PylintFormatter(SummaryFormatter):
+    """
+    This formatter outputs messages in the same way as pylint -f parseable , which is used by several
+    tools to parse pylint output. This formatter is therefore a compatibility shim between tools built
+    on top of pylint and prospector itself.
+    """
+
+    def render_messages(self) -> list[str]:
+        cur_loc = None
+        output = []
+        for message in sorted(self.messages):
+            if cur_loc != message.location.path:
+                cur_loc = message.location.path
+                module_name = str(self._make_path(message.location)).replace(os.path.sep, ".")
+                module_name = re.sub(r"(\.__init__)?\.py$", "", module_name)
+
+                header = f"************* Module {module_name}"
+                output.append(header)
+
+            #   ={path}:{line}:{character}: [{msg_id}({symbol}), {obj}] {msg}
+            # prospector/configuration.py:65:1: [missing-docstring(missing-docstring), build_default_sources] \
+            # Missing function docstring
+
+            template_location = (
+                ""
+                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 = (
+                "(%(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"
+            )
+
+            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(),
+                }
+            )
+        return output
+
+    def render(self, summary: bool = True, messages: bool = True, profile: bool = False) -> str:
+        output: list[str] = []
+        if messages:
+            output.extend(self.render_messages())
+        if profile:
+            output.append("")
+            output.append(self.render_profile())
+        if summary:
+            output.append("")
+            output.append(self.render_summary())
+
+        return "\n".join(output)

prospector-1.13.3/prospector/formatters/pylint.py → prospector-1.14.1/prospector/formatters/pylint_parseable.py

@@ -4,9 +4,9 @@ import re
 from prospector.formatters.base_summary import SummaryFormatter
 
 
-class PylintFormatter(SummaryFormatter):
+class PylintParseableFormatter(SummaryFormatter):
     """
-    This formatter outputs messages in the same way as pylint -f parseable , which is used by several
+    This formatter outputs messages in the same way as `pylint --output-format=parseable`, which is used by several
     tools to parse pylint output. This formatter is therefore a compatibility shim between tools built
     on top of pylint and prospector itself.
     """
@@ -33,8 +33,6 @@ class PylintFormatter(SummaryFormatter):
                 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 = (
                 "(%(source)s)"
@@ -54,7 +52,6 @@ class PylintFormatter(SummaryFormatter):
                 % {
                     "path": self._make_path(message.location),
                     "line": message.location.line,
-                    "character": message.location.character,
                     "source": message.source,
                     "code": message.code,
                     "function": message.location.function,

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

@@ -12,6 +12,8 @@ class Location:
         function: Optional[str],
         line: Optional[int],
         character: Optional[int],
+        line_end: Optional[int] = None,
+        character_end: Optional[int] = None,
     ):
         if isinstance(path, Path):
             self._path = path.absolute()
@@ -25,6 +27,8 @@ class Location:
         self.function = function or None
         self.line = None if line == -1 else line
         self.character = None if character == -1 else character
+        self.line_end = line_end
+        self.character_end = character_end
 
     @property
     def path(self) -> Optional[Path]:
@@ -36,7 +40,9 @@ class Location:
     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
+        if root is None:
+            return self._path
+        return self._path.relative_to(root) if self._path.is_relative_to(root) else self._path
 
     def __repr__(self) -> str:
         return f"{self._path}:L{self.line}:{self.character}"
@@ -67,11 +73,21 @@ class Location:
 
 
 class Message:
-    def __init__(self, source: str, code: str, location: Location, message: str):
+    def __init__(
+        self,
+        source: str,
+        code: str,
+        location: Location,
+        message: str,
+        doc_url: Optional[str] = None,
+        is_fixable: bool = False,
+    ):
         self.source = source
         self.code = code
         self.location = location
         self.message = message
+        self.doc_url = doc_url
+        self.is_fixable = is_fixable
 
     def __repr__(self) -> str:
         return f"{self.source}-{self.code}"

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

@@ -48,9 +48,14 @@ def filter_messages(filepaths: list[Path], messages: list[Message]) -> list[Mess
         if (
             relative_message_path in messages_to_ignore
             and message.location.line in messages_to_ignore[relative_message_path]
-            and message.code in messages_to_ignore[relative_message_path][message.location.line]
         ):
-            continue
+            matched = False
+            for ignore in messages_to_ignore[relative_message_path][message.location.line]:
+                if (ignore.source is None or message.source == ignore.source) and message.code in ignore.code:
+                    matched = True
+                    continue
+            if matched:
+                continue
 
         # otherwise this message was not filtered
         filtered.append(message)

{prospector-1.13.3 → prospector-1.14.1}/prospector/profiles/profiles/strictness_high.yaml

@@ -54,3 +54,10 @@ pydocstyle:
   disable:
     - D400
     - D401
+
+mypy:
+  options:
+    ignore-missing-imports: true
+    follow-imports: skip
+    disallow-untyped-defs: true
+    strict: false

{prospector-1.13.3 → prospector-1.14.1}/prospector/profiles/profiles/strictness_medium.yaml

@@ -125,3 +125,7 @@ pydocstyle:
     - D101
     - D102
     - D103
+
+mypy:
+  options:
+    disallow-untyped-defs: false

{prospector-1.13.3 → prospector-1.14.1}/prospector/profiles/profiles/strictness_veryhigh.yaml

@@ -38,3 +38,7 @@ pyroma:
 pydocstyle:
   disable:
     - D000
+
+mypy:
+ options:
+    strict: true

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

@@ -31,11 +31,28 @@ from prospector.exceptions import FatalProspectorException
 from prospector.message import Message
 
 _FLAKE8_IGNORE_FILE = re.compile(r"flake8[:=]\s*noqa", re.IGNORECASE)
-_PEP8_IGNORE_LINE = re.compile(r"#\s+noqa", re.IGNORECASE)
+_PEP8_IGNORE_LINE = re.compile(r"#\s*noqa(\s*#.*)?$", re.IGNORECASE)
+_PEP8_IGNORE_LINE_CODE = re.compile(r"#\s*noqa:([^#]*[^# ])(\s*#.*)?$", re.IGNORECASE)
 _PYLINT_SUPPRESSED_MESSAGE = re.compile(r"^Suppressed \'([a-z0-9-]+)\' \(from line \d+\)$")
 
 
-def get_noqa_suppressions(file_contents: list[str]) -> tuple[bool, set[int]]:
+class Ignore:
+    source: Optional[str]
+    code: str
+
+    def __init__(
+        self,
+        source: Optional[str],
+        code: str,
+    ) -> None:
+        self.source = source
+        self.code = code
+
+    def __str__(self) -> str:
+        return self.code if self.source is None else f"{self.source}.{self.code}"
+
+
+def get_noqa_suppressions(file_contents: list[str]) -> tuple[bool, set[int], dict[int, set[Ignore]]]:
     """
     Finds all pep8/flake8 suppression messages
 
@@ -47,12 +64,21 @@ def get_noqa_suppressions(file_contents: list[str]) -> tuple[bool, set[int]]:
     """
     ignore_whole_file = False
     ignore_lines = set()
+    messages_to_ignore: dict[int, set[Ignore]] = defaultdict(set)
     for line_number, line in enumerate(file_contents):
         if _FLAKE8_IGNORE_FILE.search(line):
             ignore_whole_file = True
         if _PEP8_IGNORE_LINE.search(line):
             ignore_lines.add(line_number + 1)
-    return ignore_whole_file, ignore_lines
+        else:
+            noqa_match = _PEP8_IGNORE_LINE_CODE.search(line)
+            if noqa_match:
+                prospector_ignore = noqa_match.group(1).strip().split(",")
+                prospector_ignore = [elem.strip() for elem in prospector_ignore]
+                for code in prospector_ignore:
+                    messages_to_ignore[line_number + 1].add(Ignore(None, code))
+
+    return ignore_whole_file, ignore_lines, messages_to_ignore
 
 
 _PYLINT_EQUIVALENTS = {
@@ -89,7 +115,7 @@ def _parse_pylint_informational(
 
 def get_suppressions(
     filepaths: list[Path], messages: list[Message]
-) -> tuple[set[Optional[Path]], dict[Path, set[int]], dict[Optional[Path], dict[int, set[tuple[str, str]]]]]:
+) -> tuple[set[Optional[Path]], dict[Path, set[int]], dict[Optional[Path], dict[int, set[Ignore]]]]:
     """
     Given every message which was emitted by the tools, and the
     list of files to inspect, create a list of files to ignore,
@@ -97,9 +123,9 @@ def get_suppressions(
     """
     paths_to_ignore: set[Optional[Path]] = set()
     lines_to_ignore: dict[Path, set[int]] = defaultdict(set)
-    messages_to_ignore: dict[Optional[Path], dict[int, set[tuple[str, str]]]] = defaultdict(lambda: defaultdict(set))
+    messages_to_ignore: dict[Optional[Path], dict[int, set[Ignore]]] = defaultdict(lambda: defaultdict(set))
 
-    # first deal with 'noqa' style messages
+    # First deal with 'noqa' style messages
     for filepath in filepaths:
         try:
             file_contents = encoding.read_py_file(filepath).split("\n")
@@ -108,20 +134,24 @@ def get_suppressions(
             warnings.warn(f"{err.path}: {err.__cause__}", ImportWarning, stacklevel=2)
             continue
 
-        ignore_file, ignore_lines = get_noqa_suppressions(file_contents)
+        ignore_file, ignore_lines, file_messages_to_ignore = get_noqa_suppressions(file_contents)
         if ignore_file:
             paths_to_ignore.add(filepath)
         lines_to_ignore[filepath] |= ignore_lines
+        for line, codes_ignore in file_messages_to_ignore.items():
+            messages_to_ignore[filepath][line] |= codes_ignore
 
-    # now figure out which messages were suppressed by pylint
+    # 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 pylint_filepath, line in pylint_ignore_messages.items():
-        for line_number, codes in line.items():
+    for pylint_filepath, line_codes in pylint_ignore_messages.items():
+        for line_number, codes in line_codes.items():
             for code in codes:
-                messages_to_ignore[pylint_filepath][line_number].add(("pylint", code))
+                ignore = Ignore("pylint", code)
+                messages_to_ignore[pylint_filepath][line_number].add(ignore)
                 if code in _PYLINT_EQUIVALENTS:
-                    for equivalent in _PYLINT_EQUIVALENTS[code]:
-                        messages_to_ignore[pylint_filepath][line_number].add(equivalent)
+                    for ignore_source, ignore_code in _PYLINT_EQUIVALENTS[code]:
+                        ignore = Ignore(ignore_source, ignore_code)
+                        messages_to_ignore[pylint_filepath][line_number].add(ignore)
 
     return paths_to_ignore, lines_to_ignore, messages_to_ignore

{prospector-1.13.3 → prospector-1.14.1}/prospector/tools/bandit/__init__.py

@@ -1,6 +1,7 @@
 from typing import TYPE_CHECKING, Any, Optional
 
 from bandit.cli.main import _get_profile, _init_extensions
+from bandit.core import docs_utils
 from bandit.core.config import BanditConfig
 from bandit.core.constants import RANKING
 from bandit.core.manager import BanditManager
@@ -66,7 +67,15 @@ class BanditTool(ToolBase):
         results = self.manager.get_issue_list(sev_level=RANKING[self.severity], conf_level=RANKING[self.confidence])
         messages = []
         for result in results:
-            loc = Location(result.fname, None, "", int(result.lineno), 0)
-            msg = Message("bandit", result.test_id, loc, result.text)
+            loc = Location(
+                result.fname,
+                None,
+                "",
+                result.lineno,
+                result.col_offset,
+                line_end=result.linerange[-1] if result.linerange else result.lineno,
+                character_end=result.end_col_offset,
+            )
+            msg = Message("bandit", result.test_id, loc, result.text, doc_url=docs_utils.get_url(result.test_id))
             messages.append(msg)
         return messages

{prospector-1.13.3 → prospector-1.14.1}/prospector/tools/mypy/__init__.py

@@ -87,7 +87,7 @@ class MypyTool(ToolBase):
                     self.options.append(f"--{name}-{v}")
                 continue
 
-            raise BadToolConfig("mypy", f"The option {name} has an unsupported balue type: {type(value)}")
+            raise BadToolConfig("mypy", f"The option {name} has an unsupported value type: {type(value)}")
 
     def run(self, found_files: FileFinder) -> list[Message]:
         paths = [str(path) for path in found_files.python_modules]

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

@@ -17,7 +17,7 @@ class Collector(BaseReporter):
         self._messages: list[Message] = []
 
     def handle_message(self, msg: PylintMessage) -> None:
-        loc = Location(msg.abspath, msg.module, msg.obj, msg.line, msg.column)
+        loc = Location(msg.abspath, msg.module, msg.obj, msg.line, msg.column, msg.end_line, msg.end_column)
 
         # At this point pylint will give us the code but we want the
         # more user-friendly symbol
@@ -31,7 +31,13 @@ class Collector(BaseReporter):
         else:
             msg_symbol = msg_data[0].symbol
 
-        message = Message("pylint", msg_symbol, loc, msg.msg)
+        message = Message(
+            "pylint",
+            msg_symbol,
+            loc,
+            msg.msg,
+            doc_url=f"https://pylint.readthedocs.io/en/latest/user_guide/messages/{msg.category}/{msg.symbol}.html",
+        )
         self._messages.append(message)
 
     def get_messages(self) -> list[Message]:

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

@@ -1,5 +1,6 @@
 import json
 import subprocess  # nosec
+from pathlib import Path
 from typing import TYPE_CHECKING, Any
 
 from ruff.__main__ import find_ruff_bin
@@ -44,7 +45,7 @@ class RuffTool(ToolBase):
 
     def run(self, found_files: FileFinder) -> list[Message]:
         messages = []
-        completed_process = subprocess.run(  # noqa: S603
+        completed_process = subprocess.run(  # noqa
             [self.ruff_bin, *self.ruff_args, *found_files.python_modules], capture_output=True
         )
         if not completed_process.stdout:
@@ -59,14 +60,14 @@ class RuffTool(ToolBase):
             return messages
         for message in json.loads(completed_process.stdout):
             sub_message = {}
-            if message.get("url"):
-                sub_message["See"] = message["url"]
             if message.get("fix") and message["fix"].get("applicability"):
                 sub_message["Fix applicability"] = message["fix"]["applicability"]
             message_str = message.get("message", "")
             if sub_message:
                 message_str += f" [{', '.join(f'{k}: {v}' for k, v in sub_message.items())}]"
 
+            if message.get("filename") is None or found_files.is_excluded(Path(message.get("filename"))):
+                continue
             messages.append(
                 Message(
                     "ruff",
@@ -77,8 +78,12 @@ class RuffTool(ToolBase):
                         None,
                         line=message.get("location", {}).get("row"),
                         character=message.get("location", {}).get("column"),
+                        line_end=message.get("end_location", {}).get("row"),
+                        character_end=message.get("end_location", {}).get("column"),
                     ),
                     message_str,
+                    doc_url=message.get("url"),
+                    is_fixable=bool((message.get("fix") or {}).get("applicability") in ("safe", "unsafe")),
                 )
             )
         return messages

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

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "prospector"
-version = "1.13.3"
+version = "1.14.1"
 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>",
@@ -25,8 +25,9 @@ classifiers = [
     "Programming Language :: Python :: 3.13",
     "License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)",
 ]
+# The format is a workaround aganst https://github.com/python-poetry/poetry/issues/9961
 packages = [
-  { include = "prospector/"}
+  { include = "prospector/", format = ["sdist"] }
 ]
 include = [
   "prospector/blender_combinations.yaml",
@@ -70,7 +71,7 @@ with_vulture = ["vulture"]
 with_ruff = ["ruff"]
 with_everything = ["bandit", "mypy", "pyright", "pyroma", "vulture", "ruff"]
 
-[tool.poetry.dev-dependencies]
+[tool.poetry.group.dev.dependencies]
 coveralls = "^3.3.1"
 pytest = "^7.2.0"
 pytest-benchmark = "^4.0.0"

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

@@ -61,7 +61,7 @@ entry_points = \
 
 setup_kwargs = {
     'name': 'prospector',
-    'version': '1.13.3',
+    'version': '1.14.1',
     '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',