Re: [Django] #31739: Document dependency between HttpRequest stream IO methods and body.

[Django]

#31739: Document dependency between HttpRequest stream IO methods and body.
-+-
 Reporter:  Adam (Chainz)|Owner:  Tim Park
  Johnson|
 Type:   |   Status:  closed
  Cleanup/optimization   |
Component:  Documentation|  Version:  master
 Severity:  Normal   |   Resolution:  fixed
 Keywords:   | Triage Stage:  Ready for
 |  checkin
Has patch:  1|  Needs documentation:  0
  Needs tests:  0|  Patch needs improvement:  0
Easy pickings:  0|UI/UX:  0
-+-

Comment (by Carlton Gibson ):

 In [changeset:"3756a0509ae48d91070fb65921dbb2d2155c61d1" 3756a05]:
 {{{
 #!CommitTicketReference repository=""
 revision="3756a0509ae48d91070fb65921dbb2d2155c61d1"
 [3.1.x] Fixed #31739 -- Documented dependency between HttpRequest stream
 IO methods and body.

 Backport of 060576b0abac460d72714e300aa709d1e7a87dd7 from master
 }}}

-- 
Ticket URL: 
Django 
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 django-updates+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/068.06d9e08f942c0a67c0c691cab80157dd%40djangoproject.com.

Re: [Django] #31739: Document dependency between HttpRequest stream IO methods and body.

[Django]

#31739: Document dependency between HttpRequest stream IO methods and body.
-+-
 Reporter:  Adam (Chainz)|Owner:  Tim Park
  Johnson|
 Type:   |   Status:  closed
  Cleanup/optimization   |
Component:  Documentation|  Version:  master
 Severity:  Normal   |   Resolution:  fixed
 Keywords:   | Triage Stage:  Ready for
 |  checkin
Has patch:  1|  Needs documentation:  0
  Needs tests:  0|  Patch needs improvement:  0
Easy pickings:  0|UI/UX:  0
-+-

Comment (by Carlton Gibson ):

 In [changeset:"502349ce77a2bbf86ec33891c37f2ee9e087d520" 502349ce]:
 {{{
 #!CommitTicketReference repository=""
 revision="502349ce77a2bbf86ec33891c37f2ee9e087d520"
 [3.0.x] Fixed #31739 -- Documented dependency between HttpRequest stream
 IO methods and body.

 Backport of 060576b0abac460d72714e300aa709d1e7a87dd7 from master
 }}}

-- 
Ticket URL: 
Django 
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 django-updates+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/068.e43b790d4689e23667ac4f3afe3a8215%40djangoproject.com.

Re: [Django] #31739: Document dependency between HttpRequest stream IO methods and body.

[Django]

#31739: Document dependency between HttpRequest stream IO methods and body.
-+-
 Reporter:  Adam (Chainz)|Owner:  Tim Park
  Johnson|
 Type:   |   Status:  closed
  Cleanup/optimization   |
Component:  Documentation|  Version:  master
 Severity:  Normal   |   Resolution:  fixed
 Keywords:   | Triage Stage:  Ready for
 |  checkin
Has patch:  1|  Needs documentation:  0
  Needs tests:  0|  Patch needs improvement:  0
Easy pickings:  0|UI/UX:  0
-+-
Changes (by GitHub ):

 * status:  assigned => closed
 * resolution:   => fixed


Comment:

 In [changeset:"060576b0abac460d72714e300aa709d1e7a87dd7" 060576b0]:
 {{{
 #!CommitTicketReference repository=""
 revision="060576b0abac460d72714e300aa709d1e7a87dd7"
 Fixed #31739 -- Documented dependency between HttpRequest stream IO
 methods and body.
 }}}

-- 
Ticket URL: 
Django 
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 django-updates+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/068.3eae6c316202a479430f59b3d34a1308%40djangoproject.com.

Re: [Django] #31739: Document dependency between HttpRequest stream IO methods and body.

[Django]

#31739: Document dependency between HttpRequest stream IO methods and body.
-+-
 Reporter:  Adam (Chainz)|Owner:  Tim Park
  Johnson|
 Type:   |   Status:  assigned
  Cleanup/optimization   |
Component:  Documentation|  Version:  master
 Severity:  Normal   |   Resolution:
 Keywords:   | Triage Stage:  Ready for
 |  checkin
Has patch:  1|  Needs documentation:  0
  Needs tests:  0|  Patch needs improvement:  0
Easy pickings:  0|UI/UX:  0
-+-
Changes (by Carlton Gibson):

 * stage:  Accepted => Ready for checkin


-- 
Ticket URL: 
Django 
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 django-updates+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/068.72b13631a12b14a8a4ed8cf559229c2e%40djangoproject.com.

Re: [Django] #31739: Document dependency between HttpRequest stream IO methods and body.

[Django]

#31739: Document dependency between HttpRequest stream IO methods and body.
-+-
 Reporter:  Adam (Chainz)|Owner:  Tim Park
  Johnson|
 Type:   |   Status:  assigned
  Cleanup/optimization   |
Component:  Documentation|  Version:  master
 Severity:  Normal   |   Resolution:
 Keywords:   | Triage Stage:  Accepted
Has patch:  1|  Needs documentation:  0
  Needs tests:  0|  Patch needs improvement:  0
Easy pickings:  0|UI/UX:  0
-+-
Changes (by felixxm):

 * owner:  nobody => Tim Park
 * status:  new => assigned
 * has_patch:  0 => 1


Comment:

 [https://github.com/django/django/pull/13164 PR]

-- 
Ticket URL: 
Django 
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 django-updates+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/068.bd954d32f304ac5bb475472d414489da%40djangoproject.com.

Re: [Django] #31739: Document dependency between HttpRequest stream IO methods and body.

[Django]

#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()` )

 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: 
Django 
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 django-updates+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/068.e36a0c4b8d539de7e4fc67fe4006c314%40djangoproject.com.

Re: [Django] #31739: Document dependency between HttpRequest stream IO methods and body. (was: Document RawPostDataException)

[Django]

#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
-+-
Changes (by Carlton Gibson):

 * component:  HTTP handling => Documentation
 * easy:  1 => 0
 * stage:  Unreviewed => Accepted


Comment:

 I'm not entirely convinced here...

 * It's a bit generous to say `RequestDataTooBig` is documented. It's
 mentioned, yes, but...
 * IMO `request's data stream` is clear enough, since you're using the
 stream IO API (`read()` )
 * Part of this stuff is undocumented because internal no?

 But I guess we could add a note to the
 [https://docs.djangoproject.com/en/3.0/ref/request-
 response/#django.http.HttpRequest.read `HttpRequest.read()` docs] saying
 something like, "if read() is used prior to accessing body, body will no
 longer be available." The body docs link to `read()` saying "see more",
 but then there's nothing said so some expansion might be good.

 (Given that all the stream IO methods have the same issue, perhaps the
 note needs to be in the `body` docs.)

-- 
Ticket URL: 
Django 
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 django-updates+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/068.af71a74f4781aaf334b2543d49cd9742%40djangoproject.com.