Skip to content

Error codes #4550

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.

Sign up for GitHub

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

Jump to bottom
Merged
lovelydinosaur merged 9 commits into from
Oct 11, 2016
Merged

Error codes #4550

lovelydinosaur merged 9 commits into from
Oct 11, 2016

Conversation

@lovelydinosaur
Copy link
Contributor

@lovelydinosaur lovelydinosaur commented Oct 10, 2016 •
edited
Loading

Refs #3775.

TODO:

  • Document
  • Include shortcut on ValidationError to easily extract structured response.

@lovelydinosaur lovelydinosaur added this to the 3.5.0 Release milestone Oct 10, 2016
@lovelydinosaur lovelydinosaur mentioned this pull request Oct 10, 2016
Closed
johnraz
johnraz reviewed Oct 11, 2016
View reviewed changes
docs/api-guide/exceptions.md Outdated

* `.detail` - Return the textual description of the error.
* `.get_codes()` - Return the code identifier of the error.
* `.full_details()` - Retrun both the textual description and the code identifier.
Copy link
Contributor

@johnraz johnraz Oct 11, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo Retrun

@lovelydinosaur lovelydinosaur merged commit a380250 into master Oct 11, 2016
@lovelydinosaur lovelydinosaur deleted the error-codes branch October 11, 2016 09:25
@johnraz
Copy link
Contributor

johnraz commented Oct 11, 2016

Awesome \o/
I now fully understand what you had in mind with the get_codes, get_details API.
That was an interesting piece 👍

@lovelydinosaur
Copy link
Contributor Author

lovelydinosaur commented Oct 11, 2016

Yeah, takes out a little bit of pain for writing the custom exception handlers.

What would be great to see come out of this would be one or two third party packages for exception handlers that you can plug in with just a couple of lines of installation.

@lovelydinosaur
Copy link
Contributor Author

lovelydinosaur commented Oct 11, 2016

Also pleased how this has come out - ErrorDetail can pretty much stay as an internal implementation detail (unless you're really doing something gnarly w/ modifying how serializers work). Instead you can just pass code to the exception, and we'll handle all the rest.

blueyed
blueyed reviewed Oct 13, 2016
View reviewed changes
rest_framework/authtoken/serializers.py
else:
msg = _('Must include "username" and "password".')
raise serializers.ValidationError(msg)
raise serializers.ValidationError(msg, code='authorization')
Copy link
Contributor

@blueyed blueyed Oct 13, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't the codes be different from each other here?

Copy link
Contributor Author

@lovelydinosaur lovelydinosaur Oct 13, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not necessarily. We're not trying to identify every possible case, just a categorization. If uses want to have specific codes for those different cases then that's simple enough to do by customizing this.

@auvipy auvipy mentioned this pull request Sep 21, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers

@blueyed blueyed blueyed left review comments

@johnraz johnraz johnraz left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Enhancement

Projects

None yet

Milestone

3.5.0 Release

Development

Successfully merging this pull request may close these issues.

4 participants

@lovelydinosaur @johnraz @blueyed