#31739: Document dependency between HttpRequest stream IO methods and body.
-------------------------------------+-------------------------------------
Reporter: Adam (Chainz) | Owner: nobody
Johnson |
Type: | Status: new
Cleanup/optimization |
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Adam (Chainz) Johnson):
> It's a bit generous to say RequestDataTooBig is documented
Yes that's true. But at least one can search for it in the docs and find a
sentence.
> IMO request's data stream is clear enough, since you're using the stream
IO API (`read()` &co.)
It's not always clear that the streaming API has been read, as the body
can be read by some other code. The issue came up for me when trying to
access `.body` after django-rest-framework had used `.read()`.
> Part of this stuff is undocumented because internal no?
I don't think this is internal - these are exceptions that users can see
when trying to use the public interface in `.body` / `read()` etc.
I think only a few sentences are needed to describe the possible problems
so that anyone trying to debug similar issues has more information to go
on.
--
Ticket URL: <https://code.djangoproject.com/ticket/31739#comment:3>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/068.e36a0c4b8d539de7e4fc67fe4006c314%40djangoproject.com.
