Package: prospector
AboutProspector 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 asPylint,pycodestyle,
andMcCabe complexity.
See theSupported Toolsdocumentation section for a complete list.The primary aim of Prospector is to be useful ‘out of the box’. A common complaint of other
Python analysis tools is that it takes a long time to filter through which errors are relevant
or interesting to your own coding style. Prospector provides some default profiles, which
hopefully will provide a good starting point and will be useful straight away, and adapts
the output depending on the libraries your project uses.InstallationProspector can be installed from PyPI usingpipby running the following command:pip install prospectorOptional dependencies for Prospector, such aspyromacan also be installed by running:pip install prospector[with_pyroma]Some shells (such asZsh, the default shell of macOS Catalina) require brackets to be escaped:pip install prospector\[with_pyroma\]For a list of all of the optional dependencies, see the optional extras section on the ReadTheDocs
page onSupported Tools Extras.For local development,poetryis used. Check out the code, then run:poetry installAnd for extras:poetry install -E with_everythingFor more detailed information on installing the tool, see theinstallation sectionof the tool’s main page
on ReadTheDocs.DocumentationFulldocumentation is available at ReadTheDocs.UsageSimply run prospector from the root of your project:prospectorThis will output a list of messages pointing out potential problems or errors, for example:prospector.tools.base (prospector/tools/base.py):
    L5:0 ToolBase: pylint - R0922
    Abstract class is only referenced 1 timesOptionsRunprospector--helpfor a full list of options and their effects.Output FormatThe default output format ofprospectoris designed to be human readable. For parsing
(for example, for reporting), you can use the--output-formatjsonflag to get JSON-formatted
output.ProfilesProspector is configurable using “profiles”. These are composable YAML files with directives to
disable or enable tools or messages. For more information, readthe documentation about profiles.If your code uses frameworks and librariesOften tools such as pylint find errors in code which is not an error, for example due to attributes of classes being
created at run time by a library or framework used by your project.
For example, by default, pylint will generate an error for Django models when accessingobjects, as theobjectsattribute is not part of theModelclass definition.Prospector mitigates this by providing an understanding of these frameworks to the underlying tools.Prospector will try to intuit which libraries your project uses bydetecting dependenciesand automatically turning on
support for the requisite libraries. You can see which adaptors were run in the metadata section of the report.If Prospector does not correctly detect your project’s dependencies, you can specify them manually from the commandline:prospector --uses django celeryAdditionally, if Prospector is automatically detecting a library that you do not in fact use, you can turn
off autodetection completely:prospector --no-autodetectNote that as far as possible, these adaptors have been written as plugins or augmentations for the underlying
tools so that they can be used without requiring Prospector. For example, the Django support is available as a pylint plugin.StrictnessProspector has a configurable ‘strictness’ level which will determine how harshly it searches for errors:prospector --strictness highPossible values areverylow,low,medium,high,veryhigh.Prospector does not include documentation warnings by default, but you can turn
this on using the--doc-warningsflag.pre-commitIf you’d like Prospector to be run automatically when making changes to files in your Git
repository, you can installpre-commitand add the following
text to your repositories’.pre-commit-config.yaml:repos:
-   repo: https://github.com/PyCQA/prospector
    rev: 1.10.0 # The version of Prospector to use, if not 'master' for latest
    hooks:
    -   id: prospectorThis 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 beindividually configuredin yourprospector.ymlfile# 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: trueFor 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-exitLicenseProspector is available under the GPLv2 License.