Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7k
Enforceis_valid(raise_exception=False)
as a keyword-only argument.#7952
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. |
is_valid(raise_exception=False)
as a keyword-only argument.This seems like it could be a pretty reasonable change to me, along with a major version bump. Granted there's probably some codebases that might be forced into a change, OTOH, itis an argument that makes much more sense as a keyword-only case. Any other maintainers have an opinion on the trade-off here? |
I like it! This avoids a problem known as "the boolean trap". |
romanek-adam-b2c2 commentedSep 29, 2022
It like it too, but it breaks the existing API and changelog doesn't mention that :( |
tomchristie commentedSep 29, 2022 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
It's inhttps://www.django-rest-framework.org/community/3.14-announcement/ andhttps://www.django-rest-framework.org/community/release-notes/ But yes, upgrades that break thingsare a pain. Even when we want them. |
romanek-adam-b2c2 commentedSep 30, 2022
OK, then it would make sense to include a link to the former in the latter, as originally I only found and read the latter (as I was reviewing tons of changelogs for multiple packages which got updated for my project). Additionally I'd suggest explicitly marking breaking changes with some prefix / tag / whatever ("BREAKING: ...") to make sure no one will miss that. Anyway, keep up the good work! |
…encode#7952)* make raise_exception a keyword-only argument* make raise_exception keyword-only in metaclass
At the moment
is_valid
calls are possible without keyword-only arguments, so codeserializer.is_valid(True)
is possible and will be quite misleading, especially for new developers. This pull requests makes "raise_exception" name mandatory if serializer is called with argument.