Skip to content

Collect history of responses if redirects occur. #614

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

Merged
merged 5 commits into from
Nov 3, 2015
Merged

Collect history of responses if redirects occur. #614

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0c45e4d
Collect history of responses if redirects occur.
nitori Nov 2, 2015
3dcad36
Updating docs.
nitori Nov 2, 2015
f874e5d
Add test for redirect history attribute.
nitori Nov 2, 2015
84c07f9
Update docs.
nitori Nov 2, 2015
4e586c8
Update test to release responses.
nitori Nov 2, 2015
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
3 changes: 3 additions & 0 deletions aiohttp/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,7 @@ def _request(self, method, url, *,
raise RuntimeError('Session is closed')

redirects = 0
history = []
if not isinstance(method, upstr):
method = upstr(method)

Expand Down Expand Up @@ -193,6 +194,7 @@ def _request(self, method, url, *,
# redirects
if resp.status in (301, 302, 303, 307) and allow_redirects:
redirects += 1
history.append(resp)
if max_redirects and redirects >= max_redirects:
resp.close(force=True)
break
Expand Down Expand Up @@ -221,6 +223,7 @@ def _request(self, method, url, *,

break

resp.history = history
return resp

def ws_connect(self, url, *,
Expand Down
1 change: 1 addition & 0 deletions aiohttp/client_reqrep.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -512,6 +512,7 @@ class ClientResponse:
cookies = None # Response cookies (Set-Cookie)
content = None # Payload stream
headers = None # Response headers, CIMultiDictProxy
history = None # List of responses, if redirects occured

_connection = None # current connection
flow_control_class = FlowControlStreamReader # reader flow control
Expand Down
16 changes: 16 additions & 0 deletions docs/client.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -527,6 +527,22 @@ If a response contains some Cookies, you can quickly access them::
<aiohttp-client-session>` object.


Response History
----------------

If a request was redirected, it is possible to view previous responses using
the history attribute::

>>> r = await aiohttp.get('http://example.com/some/redirect/')
>>> r
<ClientResponse(http://example.com/some/other/url/) [200]>
>>> r.history
[<ClientResponse(http://example.com/some/redirect/) [301]>]

If no redirects occured or ``allow_redirects`` is set to ``False``, history will
be an empty list.


Timeouts
--------

Expand Down
5 changes: 5 additions & 0 deletions docs/client_reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -954,6 +954,11 @@ Response object

HTTP headers of response, :class:`CIMultiDictProxy`.

.. attribute:: history

List of :class:`ClientResponse` objects of preceding requests, if there
Copy link
Member

@asvetlov asvetlov Nov 2, 2015

Choose a reason for hiding this comment

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

:class:list`` is even better

Copy link
Contributor Author

@nitori nitori Nov 2, 2015

Choose a reason for hiding this comment

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

Instead of "List" in "List of :class:ClientResponse objects …"?

Or where exactly do you mean?

Copy link
Member

@asvetlov asvetlov Nov 2, 2015

Choose a reason for hiding this comment

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

I mean

:class:`list` of :class:`ClientResponse` objects of preceding requests ...

were redirects.

.. method:: close()

Close response and underlying connection.
Expand Down