Catch APIException in doc generation #5443
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
stianjensen
reviewed
Sep 25, 2017
rest_framework/schemas/inspectors.py
Outdated
| @@ -11,6 +11,7 @@ | |||
| from django.utils.translation import ugettext_lazy as _ | |||
|
|
|||
| from rest_framework import serializers | |||
| from rest_framework import exceptions | |||
There was a problem hiding this comment.
Move this import one line up to resolve lint errors on python 2.7
carltongibson
requested changes
Sep 25, 2017
| try: | ||
| serializer = view.get_serializer() | ||
| except exceptions.APIException: | ||
| serializer = None |
There was a problem hiding this comment.
I think we need a warning here. Something like
"""
{}.get_serializer() raised an exception during schema
generation.
Serializer fields will not be generated for {} {}.
""".format(view.cls.__name__, method, path)
(The formatting there is more for GitHub than the code.)
This way we'll have some kind of console feedback so users can address any issues.
There was a problem hiding this comment.
Good idea, added a warning.
|
Updated, ready for review. |
carltongibson
approved these changes
Sep 25, 2017
|
@sigvef Could just run Thanks! |
The documentation generator calls view.get_serializer() in order to inspect it for documentation generation. However, if get_serializer() throws an APIException (e.g. PermissionDenied), it doesn't get caught at the call site, but instead propagates up and aborts the entire view. With the try/except in this commit, the documentation generator instead gratiously ignores that particular view and moves on to the next one instead. Practical concequences of this commit is that the docs no longer break if any view's get_serializer(..) throws an APIException.
|
Cool, I didn't know about isort. Updated again! |
|
Thanks for a fast review by the way! |
carltongibson
added a commit
that referenced
this pull request
Sep 26, 2017
carltongibson
added a commit
that referenced
this pull request
Sep 26, 2017
carltongibson
added a commit
that referenced
this pull request
Sep 27, 2017
carltongibson
added a commit
that referenced
this pull request
Sep 28, 2017
6 tasks
carltongibson
added a commit
that referenced
this pull request
Oct 5, 2017
carltongibson
added a commit
that referenced
this pull request
Oct 5, 2017
carltongibson
pushed a commit
that referenced
this pull request
Oct 6, 2017
* Set version number for 3.7.0 release * Rename release notes section Moved issue links to top for easier access. (Can move back later) * Add release note for #5273 * Add release note for #5440 * Add release note for #5265 Strict JSON handling * Add release note for #5250 * Add release notes for #5170 * Add release notes for #5443 * Add release notes for #5448 * Add release notes for #5452 * Add release not for #5342 * Add release notes for 5454 * Add release notes for #5058 & #5457 Remove Django 1.8 & 1.9 from README and setup.py * Release notes for merged 3.6.5 milestone tickets Tickets migrated to 3.7.0 milestone. * Add release notes for #5469 * Add release notes from AM 2ndOct * Add final changes to the release notes. * Add date and milestone link Move issue links back to bottom. * Update translations from transifex * Begin releae anouncement * Add release note for #5482 * 3.7 release announcement & related docs.
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.
The documentation generator calls view.get_serializer() in order to
inspect it for documentation generation. However, if get_serializer()
throws an APIException (e.g. PermissionDenied), it doesn't get caught at
the call site, but instead propagates up and aborts the entire view.
With the try/except in this commit, the documentation generator instead
gratiously ignores that particular view and moves on to the next one
instead. Practical concequences of this commit is that the docs no
longer break if any view's get_serializer(..) throws an APIException.