-
Notifications
You must be signed in to change notification settings - Fork 17
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add DEP005
to detect dependencies that are in the standard library
#761
Merged
Conversation
This file contains 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
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #761 +/- ##
=======================================
- Coverage 93.0% 93.0% -0.1%
=======================================
Files 35 37 +2
Lines 920 961 +41
Branches 165 173 +8
=======================================
+ Hits 856 894 +38
- Misses 50 51 +1
- Partials 14 16 +2 ☔ View full report in Codecov by Sentry. |
Co-authored-by: Mathieu Kniewallner <[email protected]>
Co-authored-by: Mathieu Kniewallner <[email protected]>
mkniewallner
approved these changes
Jul 19, 2024
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.
Checklist
docs
is updatedDescription
This PR proposes to fix #760 by adding a
DEP005
todeptry
that detects dependencies that are already in the standard library. Running this on this example project results in the following:Limitations
For situations where a package is first avaialble on PyPI and then added to the standard library with the same name, it could happen that yusers add the following to their configuration:
In this case, deptry will incorrectly flag this as a DEP005 issue. However, I believe this issue is negligible because only a limited number of packages have been added to the standard library in recent versions, and the related packages on PyPI typically do not have the same name as their standard library counterparts (e.g., for zoneinfo, the PyPI package is named backports.zoneinfo), and this will not raise an error with deptry. If this becomes an issue in the future we can try to improve this behavior by checking the conditions of the dependencies.