Remove package_resources dependency #488
Open
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
Use of `pkg_resources` is deprecated in favour of `importlib.resources` and `importlib.metadata` according to https://setuptools.pypa.io/en/latest/pkg_resources.html. Running Deluge currently triggers warnings that the `pkg_resources` library is likely to be removed as early as October 2025. Our plugin system still relies on `.egg` files, and has relied on `pkg_resources` to expose plugin metadata and resource files. We can use the `pkg_info` to pull the metadata from the .egg files and importlib for the rest. This allows for users to continue using legacy plugins while a more modern plugin framework is developed. This does unfortunately necessitate the inclusion of the `pkg_info` library, however this seems like a reasonable trade off given that it is (currently) well maintained. There may also be other possible solutions using the importlib.metadata library or reimplementing a minimal version of the `pkg_info` `BDist` functionality.
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.
Use of
pkg_resourcesis deprecated in favour ofimportlib.resourcesandimportlib.metadataaccording to https://setuptools.pypa.io/en/latest/pkg_resources.html. Running Deluge currently triggers warnings that thepkg_resourceslibrary is likely to be removed as early as October 2025.Our plugin system still relies on
.eggfiles, and has relied onpkg_resourcesto expose plugin metadata and resource files. We can use thepkg_infoto pull the metadata from the .egg files and importlib for the rest. This allows for users to continue using legacy plugins while a more modern plugin framework is developed.This does unfortunately necessitate the inclusion of the
pkg_infolibrary, however this seems like a reasonable trade off given that it is (currently) well maintained. There may also be other possible solutions using the importlib.metadata library or reimplementing a minimal version of thepkg_infoBDistfunctionality.