prospector 1.11.0__tar.gz → 1.12.0__tar.gz

{prospector-1.11.0 → prospector-1.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: prospector
-Version: 1.11.0
+Version: 1.12.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+
@@ -44,7 +44,7 @@ Requires-Dist: pep8-naming (>=0.3.3,<=0.10.0)
 Requires-Dist: pycodestyle (>=2.9.0)
 Requires-Dist: pydocstyle (>=2.0.0)
 Requires-Dist: pyflakes (>=2.2.0,<4)
-Requires-Dist: pylint (>=2.8.3,<3.0)
+Requires-Dist: pylint (>=3.0)
 Requires-Dist: pylint-celery (==0.3)
 Requires-Dist: pylint-django (>=2.5,<2.6)
 Requires-Dist: pylint-flask (==0.6)

{prospector-1.11.0 → prospector-1.12.0}/prospector/blender.py

@@ -4,9 +4,9 @@
 # the same line. For example, both pyflakes and pylint will generate an
 # "Unused Import" warning on the same line. This is obviously redundant, so we
 # remove duplicates.
+import pkgutil
 from collections import defaultdict
 
-import pkg_resources
 import yaml
 
 __all__ = (
@@ -98,7 +98,7 @@ def blend(messages, blend_combos=None):
 
 
 def get_default_blend_combinations():
-    combos = yaml.safe_load(pkg_resources.resource_string(__name__, "blender_combinations.yaml"))
+    combos = yaml.safe_load(pkgutil.get_data(__name__, "blender_combinations.yaml"))
     combos = combos.get("combinations", [])
 
     defaults = []

{prospector-1.11.0 → prospector-1.12.0}/prospector/config/configuration.py

@@ -1,5 +1,6 @@
 # flake8: noqa
-import pkg_resources
+import importlib.metadata
+
 import setoptconf as soc
 
 from prospector.config.datatype import OutputChoice
@@ -8,7 +9,7 @@ from prospector.tools import DEFAULT_TOOLS, TOOLS
 
 __all__ = ("build_manager",)
 
-_VERSION = pkg_resources.get_distribution("prospector").version
+_VERSION = importlib.metadata.version("prospector")
 
 
 def build_manager():

{prospector-1.11.0 → prospector-1.12.0}/prospector/profiles/profile.py

@@ -121,7 +121,7 @@ def _load_content_package(name):
     file_names = (
         ["prospector.yaml", "prospector.yml"]
         if len(name_split) == 1
-        else [f"{name_split[1]}.yaml", f"{name_split[1]}.yaml"]
+        else [f"{name_split[1]}.yaml", f"{name_split[1]}.yml"]
     )
 
     data = None

{prospector-1.11.0 → prospector-1.12.0}/prospector/tools/mypy/__init__.py

@@ -21,6 +21,7 @@ VALID_OPTIONS = LIST_OPTIONS + [
     "python-2-mode",
     "python-version",
     "namespace-packages",
+    "check-untyped-defs",
 ]
 
 
@@ -90,6 +91,7 @@ class MypyTool(ToolBase):
         python_version = options.get("python-version", None)
         strict_optional = options.get("strict-optional", False)
         namespace_packages = options.get("namespace-packages", False)
+        check_untyped_defs = options.get("check-untyped-defs", False)
 
         self.options.append(f"--follow-imports={follow_imports}")
 
@@ -117,6 +119,9 @@ class MypyTool(ToolBase):
         if namespace_packages:
             self.options.append("--namespace-packages")
 
+        if check_untyped_defs:
+            self.options.append("--check-untyped-defs")
+
         for list_option in LIST_OPTIONS:
             for entry in options.get(list_option, []):
                 self.options.append(f"--{list_option}-{entry}")

{prospector-1.11.0 → prospector-1.12.0}/prospector/tools/pylint/__init__.py

@@ -64,7 +64,7 @@ class PylintTool(ToolBase):
                 continue
             for option in checker.options:
                 if option[0] in options:
-                    checker.set_option(option[0], options[option[0]])
+                    checker._arguments_manager.set_option(option[0], options[option[0]])
 
         # The warnings about disabling warnings are useful for figuring out
         # with other tools to suppress messages from. For example, an unused
@@ -167,7 +167,7 @@ class PylintTool(ToolBase):
     def _get_pylint_configuration(
         self, check_paths: List[Path], linter: ProspectorLinter, prospector_config, pylint_options
     ):
-        self._args = linter.load_command_line_configuration(str(path) for path in check_paths)
+        self._args = check_paths
         linter.load_default_plugins()
 
         config_messages = self._prospector_configure(prospector_config, linter)

prospector-1.12.0/prospector/tools/pylint/linter.py

@@ -0,0 +1,78 @@
+from pathlib import Path
+
+from packaging import version as packaging_version
+from pylint import version as pylint_version
+from pylint.config.config_file_parser import _ConfigurationFileParser
+from pylint.config.config_initialization import _order_all_first
+from pylint.lint import PyLinter
+from pylint.utils import _splitstrip, utils
+
+
+class ProspectorLinter(PyLinter):
+    def __init__(self, found_files, *args, **kwargs):
+        self._files = found_files
+        # set up the standard PyLint linter
+        PyLinter.__init__(self, *args, **kwargs)
+
+    # Largely inspired by https://github.com/pylint-dev/pylint/blob/main/pylint/config/config_initialization.py#L26
+    def config_from_file(self, config_file=None):
+        """Will return `True` if plugins have been loaded. For pylint>=1.5. Else `False`."""
+        config_file_parser = _ConfigurationFileParser(False, self)
+        config_data, config_args = config_file_parser.parse_config_file(file_path=config_file)
+        if config_data.get("MASTER", {}).get("load-plugins"):
+            plugins = _splitstrip(config_data["MASTER"]["load-plugins"])
+            self.load_plugin_modules(plugins)
+
+        config_args = _order_all_first(config_args, joined=False)
+
+        if "init-hook" in config_data:
+            exec(utils._unquote(config_data["init-hook"]))  # pylint: disable=exec-used
+
+        # Load plugins if specified in the config file
+        if "load-plugins" in config_data:
+            self.load_plugin_modules(utils._splitstrip(config_data["load-plugins"]))
+
+        self._parse_configuration_file(config_args)
+
+        # Set the current module to the command line
+        # to allow raising messages on it
+        self.set_current_module(config_file)
+
+        self._emit_stashed_messages()
+
+        # Set the current module to configuration as we don't know where
+        # the --load-plugins key is coming from
+        self.set_current_module("Command line or configuration file")
+
+        # We have loaded configuration from config file and command line. Now, we can
+        # load plugin specific configuration.
+        self.load_plugin_configuration()
+
+        # Now that plugins are loaded, get list of all fail_on messages, and
+        # enable them
+        self.enable_fail_on_messages()
+
+        self._parse_error_mode()
+
+        # Link the base Namespace object on the current directory
+        self._directory_namespaces[Path().resolve()] = (self.config, {})
+
+        return True
+
+    def _expand_files(self, modules):
+        expanded = super()._expand_files(modules)
+        filtered = {}
+        # PyLinter._expand_files returns dict since 2.15.7.
+        if packaging_version.parse(pylint_version) > packaging_version.parse("2.15.6"):
+            for module in expanded:
+                if not self._files.is_excluded(Path(module)):
+                    filtered[module] = expanded[module]
+            return filtered
+        else:
+            for module in expanded:
+                # need to de-duplicate, as pylint also walks directories given to it, so it will find
+                # files that prospector has already provided and end up checking it more than once
+                if not self._files.is_excluded(Path(module["path"])):
+                    # if the key exists, just overwrite it with the same value, so we don't need an extra if statement
+                    filtered[module["path"]] = module
+            return filtered.values()

{prospector-1.11.0 → prospector-1.12.0}/pyproject.toml

@@ -1,11 +1,12 @@
 [tool.poetry]
 name = "prospector"
-version = "1.11.0"
+version = "1.12.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>",
                "Carlos Coelho <carlospecter@gmail.com>",
-               "Pierre Sassoulas <pierre.sassoulas@gmail.com>"]
+               "Pierre Sassoulas <pierre.sassoulas@gmail.com>",
+               "Stéphane Brunner <stephane.brunner@gmail.com>"]
 readme = "README.rst"
 homepage = "http://prospector.readthedocs.io"
 repository = "https://github.com/PyCQA/prospector"
@@ -38,7 +39,7 @@ prospector = 'prospector.run:main'
 
 [tool.poetry.dependencies]
 python = ">=3.8.1,<4.0"
-pylint = ">=2.8.3,<3.0"
+pylint = ">=3.0"
 pylint-celery = "0.3"
 pylint-django = "~2.5"
 pylint-plugin-utils = "~0.7"

{prospector-1.11.0 → prospector-1.12.0}/setup.py

@@ -38,7 +38,7 @@ install_requires = \
  'pylint-django>=2.5,<2.6',
  'pylint-flask==0.6',
  'pylint-plugin-utils>=0.7,<0.8',
- 'pylint>=2.8.3,<3.0',
+ 'pylint>=3.0',
  'requirements-detector>=1.2.0',
  'setoptconf-tmp>=0.3.1,<0.4.0',
  'toml>=0.10.2,<0.11.0']
@@ -60,7 +60,7 @@ entry_points = \
 
 setup_kwargs = {
     'name': 'prospector',
-    'version': '1.11.0',
+    'version': '1.12.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.11.0/prospector/tools/pylint/linter.py

@@ -1,40 +0,0 @@
-from pathlib import Path
-
-from packaging import version as packaging_version
-from pylint import version as pylint_version
-from pylint.lint import PyLinter
-from pylint.utils import _splitstrip
-
-
-class ProspectorLinter(PyLinter):
-    def __init__(self, found_files, *args, **kwargs):
-        self._files = found_files
-        # set up the standard PyLint linter
-        PyLinter.__init__(self, *args, **kwargs)
-
-    def config_from_file(self, config_file=None):
-        """Will return `True` if plugins have been loaded. For pylint>=1.5. Else `False`."""
-        self.read_config_file(config_file)
-        if self.cfgfile_parser.has_option("MASTER", "load-plugins"):
-            plugins = _splitstrip(self.cfgfile_parser.get("MASTER", "load-plugins"))
-            self.load_plugin_modules(plugins)
-        self.load_config_file()
-        return True
-
-    def _expand_files(self, modules):
-        expanded = super()._expand_files(modules)
-        filtered = {}
-        # PyLinter._expand_files returns dict since 2.15.7.
-        if packaging_version.parse(pylint_version) > packaging_version.parse("2.15.6"):
-            for module in expanded:
-                if not self._files.is_excluded(Path(module)):
-                    filtered[module] = expanded[module]
-            return filtered
-        else:
-            for module in expanded:
-                # need to de-duplicate, as pylint also walks directories given to it, so it will find
-                # files that prospector has already provided and end up checking it more than once
-                if not self._files.is_excluded(Path(module["path"])):
-                    # if the key exists, just overwrite it with the same value, so we don't need an extra if statement
-                    filtered[module["path"]] = module
-            return filtered.values()