Skip to content

Drop HTML line breaks on long headers in browsable API #9438

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Apr 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion rest_framework/templates/rest_framework/base.html
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ <h1>{{ name }}</h1>

<div class="response-info" aria-label="{% trans "response info" %}">
<pre class="prettyprint"><span class="meta nocode"><b>HTTP {{ response.status_code }} {{ response.status_text }}</b>{% for key, val in response_headers|items %}
<b>{{ key }}:</b> <span class="lit">{{ val|break_long_headers|urlize }}</span>{% endfor %}
<b>{{ key }}:</b> <span class="lit">{{ val|urlize }}</span>{% endfor %}

</span>{{ content|urlize }}</pre>
</div>
Expand Down
11 changes: 0 additions & 11 deletions rest_framework/templatetags/rest_framework.py
Original file line number Diff line number Diff line change
Expand Up @@ -313,14 +313,3 @@ def smart_urlquote_wrapper(matched_url):
return smart_urlquote(matched_url)
except ValueError:
return None


@register.filter
def break_long_headers(header):
"""
Breaks headers longer than 160 characters (~page length)
when possible (are comma separated)
"""
if len(header) > 160 and ',' in header:
header = mark_safe('<br> ' + ', <br>'.join(escape(header).split(',')))
return header
9 changes: 2 additions & 7 deletions tests/test_templatetags.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
from rest_framework.relations import Hyperlink
from rest_framework.templatetags import rest_framework
from rest_framework.templatetags.rest_framework import (
add_nested_class, add_query_param, as_string, break_long_headers,
format_value, get_pagination_html, schema_links
add_nested_class, add_query_param, as_string, format_value,
get_pagination_html, schema_links
)
from rest_framework.test import APIRequestFactory

Expand Down Expand Up @@ -234,11 +234,6 @@ def to_html(self):
get_pagination_html(pager)
assert pager.called is True

def test_break_long_lines(self):
header = 'long test header,' * 20
expected_header = '<br> ' + ', <br>'.join(header.split(','))
assert break_long_headers(header) == expected_header


class Issue1386Tests(TestCase):
"""
Expand Down
Loading