doc: use importlib.metadata in favor of pkg_resources in conf.py #1617
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
|
Hi, you commits are missing a DCO. |
lemoer
force-pushed
the
pr_doc_use_importlib
branch
2 times, most recently
from
ed4b6c8 to
261e95c
Compare
Hi, thanks for the hint. Fixed. |
|
Thanks for taking the time to create this PR!
This sounds confusing. The only thing that changed is that setuptools is no longer pre-installed in venvs created with venv. But this has nothing to do with the pkg_resources deprecation and labgrid will still rely on setuptools anyway (see pyproject.toml). Could you please make that more clear?
The fix itself looks fine. |
|
Yes, you are right. If I install, However, using Manually installing works: I am not sure why this happens. Maybe relevant, maybe not, but outside of the venv, the package is also existing: I am using ubuntu 24.04 and python 3.12.7. |
|
setuptools is only defined as a build-time dependency (see build-system.requires key in our The "doc" extra should have included "setuptools" as a dependency to make the "pkg_resources" module available during runtime. Now that you're making setuptools during runtime obsolete, the |
Since Python 3.12, setuptools is no longer pre-installed in virtual envs created with venv [1]. The used alternative `importlib.metadata` is available for Python >=3.8 [2]. [1] https://docs.python.org/3/library/venv.html#module-venv [2] https://docs.python.org/3.12/library/importlib.metadata.html Signed-off-by: Leonardo Mörlein <[email protected]> [bst: rephrased commit message]
Bastian-Krause
force-pushed
the
pr_doc_use_importlib
branch
from
261e95c to
34215b9
Compare
|
I've now rephrased the commit message as discussed above and rebased this PR. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
✅ All tests successful. No failed tests found. Additional details and impacted files@@ Coverage Diff @@
## master #1617 +/- ##
======================================
Coverage 55.7% 55.7%
======================================
Files 172 172
Lines 13422 13422
======================================
Hits 7479 7479
Misses 5943 5943
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Bastian-Krause
added
picked to stable
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
As can be found here [1], pkg_resources is deprecated and is removed by default from python 3.12 according to [2]. The used alternative importlib.metadata is available from python 3.8 on according to [3].
[1] https://setuptools.pypa.io/en/latest/pkg_resources.html
[2] https://docs.python.org/3/whatsnew/3.12.html
[3] https://docs.python.org/3.12/library/importlib.metadata.html