Skip to content
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

Add support for setting cookies for individual request #3396

Merged
merged 2 commits into from
Nov 30, 2018
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
1 change: 1 addition & 0 deletions CHANGES/2387.feature
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add support for setting cookies for individual request
1 change: 1 addition & 0 deletions CONTRIBUTORS.txt
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,7 @@ Yannick Koechlin
Yannick Péroux
Ye Cao
Yegor Roganov
Yifei Kong
Young-Ho Cha
Yuriy Shatrov
Yury Selivanov
Expand Down
12 changes: 11 additions & 1 deletion aiohttp/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,7 @@ async def _request(
params: Optional[Mapping[str, str]]=None,
data: Any=None,
json: Any=None,
cookies: Optional[LooseCookies]=None,
headers: LooseHeaders=None,
skip_auto_headers: Optional[Iterable[str]]=None,
auth: Optional[BasicAuth]=None,
Expand Down Expand Up @@ -352,7 +353,16 @@ async def _request(
"with AUTH argument or credentials "
"encoded in URL")

cookies = self._cookie_jar.filter_cookies(url)
session_cookies = self._cookie_jar.filter_cookies(url)

if cookies is not None:
tmp_cookie_jar = CookieJar()
tmp_cookie_jar.update_cookies(cookies)
req_cookies = tmp_cookie_jar.filter_cookies(url)
if session_cookies and req_cookies:
session_cookies.load(req_cookies)

cookies = session_cookies

if proxy is not None:
proxy = URL(proxy)
Expand Down
10 changes: 9 additions & 1 deletion docs/client_reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ The client session supports the context manager protocol for self closing.
.. deprecated:: 3.5

.. comethod:: request(method, url, *, params=None, data=None, json=None,\
headers=None, skip_auto_headers=None, \
cookies=None, headers=None, skip_auto_headers=None, \
auth=None, allow_redirects=True,\
max_redirects=10,\
compress=None, chunked=None, expect100=False, raise_for_status=None,\
Expand Down Expand Up @@ -255,6 +255,14 @@ The client session supports the context manager protocol for self closing.
(optional). *json* and *data* parameters could not
be used at the same time.

:param dict cookies: HTTP Cookies to send with
the request (optional)

Global session cookies and the explicitly set cookies will be merged
when sending the request.

.. versionadded:: 3.5

:param dict headers: HTTP Headers to send with
the request (optional)

Expand Down
27 changes: 27 additions & 0 deletions tests/test_client_functional.py
Original file line number Diff line number Diff line change
Expand Up @@ -1899,6 +1899,33 @@ async def handler(request):
resp.close()


async def test_cookies_per_request(aiohttp_client) -> None:

async def handler(request):
assert request.cookies.keys() == {'test1', 'test3', 'test4', 'test6'}
assert request.cookies['test1'] == '123'
assert request.cookies['test3'] == '456'
assert request.cookies['test4'] == '789'
assert request.cookies['test6'] == 'abc'
return web.Response()

c = http.cookies.Morsel()
c.set('test3', '456', '456')

app = web.Application()
app.router.add_get('/', handler)
client = await aiohttp_client(
app, cookies={'test1': '123', 'test2': c})

rc = http.cookies.Morsel()
rc.set('test6', 'abc', 'abc')

resp = await client.get(
'/', cookies={'test4': '789', 'test5': rc})
assert 200 == resp.status
resp.close()


async def test_morsel_with_attributes(aiohttp_client) -> None:
# A comment from original test:
#
Expand Down