Replace deprecated pkg_resources with importlib.metadata #89
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Replace pkg_resources with importlib.metadata for version retrieval - Add proper error handling with PackageNotFoundError fallback - Fixes deprecation warning on setuptools >=81 - Compatible with Python 3.8+ (stdlib solution) - pkg_resources scheduled for removal (2025-11-30) This change modernizes the package version detection mechanism while maintaining backward compatibility. The importlib.metadata module is part of the standard library since Python 3.8 and is the recommended replacement for pkg_resources.
There was a problem hiding this comment.
Pull Request Overview
This PR modernizes the package version retrieval by replacing the deprecated pkg_resources API with the standard library's importlib.metadata module, which is the recommended approach for Python 3.8+.
- Replaced
pkg_resources.require()withimportlib.metadata.version() - Added exception handling for cases where the package metadata is not found
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Replaces deprecated
pkg_resourceswithimportlib.metadatafor version retrieval in the Python package.Problem
Users experience deprecation warnings when importing richdem with setuptools ≥81:
pkg_resourcesis deprecated and scheduled for removal (2025-11-30)Changes
pkg_resources.require("richdem")[0].versionwithimportlib.metadata.version("richdem")PackageNotFoundErrorfallbackReferences