[Django] #29276: Advise to turn the headers of HTTPResponse from str to bytes automatically
Django
-------------------------------------+-------------------------------------
Reporter: sanjiely | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: HTTP | Version: 2.0
handling | Keywords: HTTPResponse header
Severity: Normal | str bytes
Triage Stage: | Has patch: 0
Unreviewed |
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
-------------------------------------+-------------------------------------
Python: 3.6.4
Django: 2.0.3
When I return a HttpResponse object, Django library will do the job for
me: turn my content from str to bytes silently.
But Django will not do the same work to the headers of HTTPResponse.
That is to say, the sample as below in the official document is not
precisely correct.
(Page: https://docs.djangoproject.com/en/2.0/ref/request-response/)
>>> response = HttpResponse(my_data, content_type='application/vnd.ms-
excel')
>>> response['Content-Disposition'] = 'attachment; filename="foo.xls"'
The precise usage should be:
>>> response['Content-Disposition'] = 'attachment;
filename="foo.xls"'.encode('utf-8')
Otherwise, everthing will out of control If I have a Chinse character in
the filename.
Wrong:
>>> response['Content-Disposition'] = 'attachment; filename="中中中中中
foo.xls"'
Correct:
>>> response['Content-Disposition'] = 'attachment; filename=中中中中中
foo.xls'.encode('utf-8')
Can we accept this ticket and do a minor improvement? Then we would
happily only handle str in Django other than str and bytes together.
Thanks.
Yong Li
--
Ticket URL: <https://code.djangoproject.com/ticket/29276>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
-------------------------------------+-------------------------------------
Reporter: sanjiely | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Severity: Normal | Resolution:
Keywords: HTTPResponse header | Triage Stage:
str bytes | Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
--
Ticket URL: <https://code.djangoproject.com/ticket/29276#comment:1>
Django
-------------------------------------+-------------------------------------
Reporter: sanjiely | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Severity: Normal | Resolution:
Keywords: HTTPResponse header | Triage Stage:
str bytes | Unreviewed
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
--
Ticket URL: <https://code.djangoproject.com/ticket/29276#comment:2>
Django
-------------------------------------+-------------------------------------
Reporter: sanjiely | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Severity: Normal | Resolution:
Keywords: HTTPResponse header | Triage Stage:
str bytes | Unreviewed
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Old description:
New description:
Python: 3.6.4
Django: 2.0.3
Yong Li
--
--
Ticket URL: <https://code.djangoproject.com/ticket/29276#comment:3>
Django
-------------------------------------+-------------------------------------
Reporter: sanjiely | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Severity: Normal | Resolution:
Keywords: HTTPResponse header | Triage Stage:
str bytes | Unreviewed
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Claude Paroz):
Sorry, but you didn't show by your example why setting the header as a
normal unicode string is a problem. You should develop the `everthing will
out of control` part of your description.
--
Ticket URL: <https://code.djangoproject.com/ticket/29276#comment:4>
Django
-------------------------------------+-------------------------------------
Reporter: sanjiely | Owner: nobody
Cleanup/optimization |
Component: HTTP handling | Version: 2.0
Keywords: HTTPResponse header | Triage Stage:
str bytes | Unreviewed
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* status: new => closed
* resolution: => duplicate
Comment:
Mmmh, I guess this is in fact a duplicate of #16470.
--
Ticket URL: <https://code.djangoproject.com/ticket/29276#comment:5>
Django
characters in HTTPResponse headers
-------------------------------------+-------------------------------------
Reporter: sanjiely | Owner: nobody
Component: HTTP handling | Version: 2.0
Severity: Normal | Resolution:
str bytes | Unreviewed
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* status: closed => new
* type: Cleanup/optimization => Bug
* resolution: duplicate =>
Old description:
New description:
Python: 3.6.4
Django: 2.0.3
Browser: Chrome v65
To tell the browser to download a file, my code as below:
{{{
response = HttpResponse(my_data, content_type='text/plain')
response['Content-Disposition'] = 'attachment; filename="中中foo.xls"'
}}}
(Note: there are non-ascii characters in the filename.)
My code worked well in Python2.7 and Django1.8.
But when I transform my version to Django v2 and Python v3. The behavior
of the browser changed: Chrome opened my file directly and wouldn't
download the file as an attachment any more.
I catch the network packet, and found the response headers become as:
{{{
Content-Disposition:
=?utf-8?b?YXR0YWNobWVudDsgZmlsZW5hbWU9IuS4reS4rWZvby54bHMi?=
Content-Length: 13
Content-Type: text/plain
}}}
Very strange header "Content-Disposition", isn't it?
I guess there is an unexpected code path in the Django lib file
"response.py".
I tracked it, and found the code running into an exception statement, line
125, file "response.py"
{{{
except UnicodeError as e:
if mime_encode:
print(value)
value = Header(value, 'utf-8',
maxlinelen=sys.maxsize).encode()
print(value)
}}}
The output of these two print statement are:
{{{
attachment; filename="中中foo.xls"
=?utf-8?b?YXR0YWNobWVudDsgZmlsZW5hbWU9IuS4reS4rWZvby54bHMi?=
}}}
Thanks.
--
--
Ticket URL: <https://code.djangoproject.com/ticket/29276#comment:6>
Django
characters in HTTPResponse headers
Reporter: sanjiely | Owner: nobody
Component: HTTP handling | Version: 2.0
Severity: Normal | Resolution:
Keywords: HTTPResponse header | Triage Stage:
str bytes | Unreviewed
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Simon Charette):
Shouldn't HTTP headers only contain ISO-
8859-1 characters and [https://tools.ietf.org/html/rfc5987 RFC5987] be
followed to include parameters containing characters outside of its range?
I think your header should be something along.
{{{#!python
response['Content-Type'] = "attachment;
filename*=UTF-8''{}".format(quote(filename))
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/29276#comment:7>
Django
characters in HTTPResponse headers
Reporter: sanjiely | Owner: nobody
Component: HTTP handling | Version: 2.0
Keywords: HTTPResponse header | Triage Stage:
str bytes | Unreviewed
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* status: new => closed
* resolution: => duplicate
--
Ticket URL: <https://code.djangoproject.com/ticket/29276#comment:8>