Fix pkg resources import

ldallmayr commented 10 months ago

Description

The use of pkg_resources is deprecated in favor of its importlib equivalents. Running the pre-commit hook with Python 3.12 fails because pkg_resources cannot be found.

ModuleNotFoundError: No module named 'pkg_resources'

Motivation and Context

This pull request fixes the error ModuleNotFoundError: No module named 'pkg_resources' when ran by pre-commit

How Has This Been Tested?

Ran all tests with pytest locally

Failed tests

FAILED tests/profiles/test_profile.py::TestProfileInheritance::test_module_file_inheritance - prospector.profiles.exceptions.ProfileNotFound
FAILED tests/profiles/test_profile.py::TestProfileInheritance::test_module_inheritance - prospector.profiles.exceptions.ProfileNotFound
FAILED tests/tools/pyroma/test_pyroma_tool.py::test_forced_include - assert 12 == 10

Types of changes

[x] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

[x] My code follows the code style of this project.
[ ] My change requires a change to the documentation.
[ ] I have updated the documentation accordingly.
[ ] My change requires a change to the dependencies
[ ] I have updated the dependencies accordingly
[x] I have read the CONTRIBUTING document.
[ ] I have added tests to cover my changes.
[ ] All new and existing tests passed.

ldallmayr commented 10 months ago

The resources.files api was introduced in Python 3.9, therefore I had to use the function resources.read_text. This function has been marked deprecated since Python 3.11. As soon as the minimum requirement for prospector is Python 3.9 one could change to the resources.files api.

ldallmayr commented 10 months ago

importlib.metadata was introduced in Python 3.8, so either the backports of those tools have to be used or this change has to be postponed until the minimum requirement is greater than Python 3.8

Pierre-Sassoulas commented 10 months ago

Python 3.9 is not yet EOL, we should probably use both with a if sys.version_info(...) guard until then.

landscapeio / prospector