Skip to content
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

handle errors rendering with TemplateHTMLRenderer #742

Merged
merged 2 commits into from
Jul 18, 2022
Merged

handle errors rendering with TemplateHTMLRenderer #742

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
be1f084
handle errors rendering with TemplateHTMLRenderer
terencehonles Sep 23, 2021
60ae05c
Merge branch '1.21.x' into pr/742
JoelLefkowitz Jul 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 10 additions & 4 deletions src/drf_yasg/renderers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
from django.core.exceptions import ImproperlyConfigured
from django.shortcuts import resolve_url
from django.template.loader import render_to_string
from django.utils.encoding import force_str
Expand Down Expand Up @@ -64,10 +65,15 @@ class _UIRenderer(BaseRenderer):

def render(self, swagger, accepted_media_type=None, renderer_context=None):
if not isinstance(swagger, Swagger): # pragma: no cover
# if `swagger` is not a ``Swagger`` object, it means we somehow got a non-success ``Response``
# in that case, it's probably better to let the default ``TemplateHTMLRenderer`` render it
# see https://github.com/axnsan12/drf-yasg/issues/58
return TemplateHTMLRenderer().render(swagger, accepted_media_type, renderer_context)
try:
# if `swagger` is not a ``Swagger`` object, it means we somehow got a non-success ``Response``
# in that case, it's probably better to let the default ``TemplateHTMLRenderer`` render it
# see https://github.com/axnsan12/drf-yasg/issues/58
return TemplateHTMLRenderer().render(swagger, accepted_media_type, renderer_context)
except ImproperlyConfigured:
# Fall back to using eg '404 Not Found'
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Stolen from the error handling code path https://github.com/encode/django-rest-framework/blob/f0a5b958a134e8cd94e3ef3263e8fa623ac9b82f/rest_framework/renderers.py#L199-L202

response = renderer_context['response']
return '%d %s' % (response.status_code, response.status_text.title())

self.set_context(renderer_context, swagger)
return render_to_string(self.template, renderer_context, renderer_context['request'])
Expand Down