Error on deprecation and pending deprecation warnings #7586
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
|
I've applied this to all my individually maintained open projects recently and it's worked really well to prevent this annoyance. It took a while to merge the fixes for Django 3.1 deprecation warnings in DRF, such as #7513 - this is my motivation for catching them earlier. |
auvipy
approved these changes
Oct 9, 2020
|
LGTM -- Looks like the failure here would be fixed by #7531 |
Erroring on deprecation or pending deprecation warnings means they are caught early. This will avoid the cycle of releasing with 'support for Django X', then chasing all the deprecation warnings one-by-one. Instead, when a new Django version is added to the test matrix, it will fail until all the relevant warnings are fixed. This avoids passing these warnings on to users, some of whom don't upgrade until they are all fixed.
68c90c4 to
96546cc
Compare
adamchainz
commented
Oct 10, 2020
| @@ -14,7 +14,7 @@ DJANGO = | |||
| master: djangomaster | |||
|
|
|||
| [testenv] | |||
| commands = ./runtests.py --fast --coverage {posargs} | |||
| commands = python -W error::DeprecationWarning -W error::PendingDeprecationWarning runtests.py --fast --coverage {posargs} | |||
There was a problem hiding this comment.
Btw the reason to do this with python -W rather than through e.g. pytest's warning system is to catch any import-time warnings that happen before pytest even starts running.
adamchainz
added a commit
to adamchainz/django-import-export
that referenced
this pull request
Oct 16, 2020
This is a technique I've rolled out against my own open source projects and [Django REST Framework](encode/django-rest-framework#7586). By failing tests as soon as new deprecation warnings are created in the library, they aren't passed on to users who then have to report them back in issues like django-import-export#1195, saving everyone some time, effort, and noise.
andrewgy8
pushed a commit
to django-import-export/django-import-export
that referenced
this pull request
Oct 19, 2020
This is a technique I've rolled out against my own open source projects and [Django REST Framework](encode/django-rest-framework#7586). By failing tests as soon as new deprecation warnings are created in the library, they aren't passed on to users who then have to report them back in issues like #1195, saving everyone some time, effort, and noise.
ZuluPro
pushed a commit
to ZuluPro/django-import-export
that referenced
this pull request
Dec 23, 2020
This is a technique I've rolled out against my own open source projects and [Django REST Framework](encode/django-rest-framework#7586). By failing tests as soon as new deprecation warnings are created in the library, they aren't passed on to users who then have to report them back in issues like django-import-export#1195, saving everyone some time, effort, and noise.
sigvef
pushed a commit
to sigvef/django-rest-framework
that referenced
this pull request
Dec 3, 2022
Erroring on deprecation or pending deprecation warnings means they are caught early. This will avoid the cycle of releasing with 'support for Django X', then chasing all the deprecation warnings one-by-one. Instead, when a new Django version is added to the test matrix, it will fail until all the relevant warnings are fixed. This avoids passing these warnings on to users, some of whom don't upgrade until they are all fixed.
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.
Description
Erroring on deprecation or pending deprecation warnings means they are caught early. This will avoid the cycle of releasing with 'support for Django X', then chasing all the deprecation warnings one-by-one. Instead, when a new Django version is added to the test matrix, it will fail until all the relevant warnings are fixed. This avoids passing these warnings on to users, some of whom don't upgrade until they are all fixed.