Skip to content

Commit 082de7d

Browse files
authored
Add samesite cookie param to the docs (#1068)
1 parent d3fc9e0 commit 082de7d

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

docs/reference.rst

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ implement both :meth:`~AbstractStorage.load_session` and
172172

173173
.. class:: AbstractStorage(cookie_name="AIOHTTP_SESSION", *, \
174174
domain=None, max_age=None, path='/', \
175-
secure=None, httponly=True, \
175+
secure=None, httponly=True, samesite=None, \
176176
encoder=json.dumps, decoder=json.loads)
177177

178178
Base class for session storage implementations.
@@ -194,6 +194,8 @@ implement both :meth:`~AbstractStorage.load_session` and
194194
*httponly* -- cookie's http-only flag, :class:`bool` or ``None`` (the
195195
same as ``False``).
196196

197+
*samesite* -- cookie's samesite flag, :class:`str` or ``None``
198+
197199
*encoder* -- session serializer. A callable with the following
198200
signature: `def encode(param: Any) -> str: ...`. Default is
199201
:func:`json.dumps`.
@@ -218,7 +220,7 @@ implement both :meth:`~AbstractStorage.load_session` and
218220
.. attribute:: cookie_params
219221

220222
:class:`dict` of cookie params: *domain*, *max_age*, *path*,
221-
*secure* and *httponly*.
223+
*secure*, *httponly* and *samesite*.
222224

223225
.. attribute:: encoder
224226

@@ -284,7 +286,7 @@ To use the storage you should push it into
284286
.. class:: SimpleCookieStorage(*, \
285287
cookie_name="AIOHTTP_SESSION", \
286288
domain=None, max_age=None, path='/', \
287-
secure=None, httponly=True, \
289+
secure=None, httponly=True, samesite=None, \
288290
encoder=json.dumps, decoder=json.loads)
289291

290292
Create unencrypted cookie storage.
@@ -315,7 +317,7 @@ To use the storage you should push it into
315317
.. class:: EncryptedCookieStorage(secret_key, *, \
316318
cookie_name="AIOHTTP_SESSION", \
317319
domain=None, max_age=None, path='/', \
318-
secure=None, httponly=True, \
320+
secure=None, httponly=True, samesite=None, \
319321
encoder=json.dumps, decoder=json.loads)
320322

321323
Create encryted cookies storage.
@@ -354,7 +356,7 @@ To use the storage you should push it into
354356
.. class:: NaClCookieStorage(secret_key, *, \
355357
cookie_name="AIOHTTP_SESSION", \
356358
domain=None, max_age=None, path='/', \
357-
secure=None, httponly=True, \
359+
secure=None, httponly=True, samesite=None, \
358360
encoder=json.dumps, decoder=json.loads)
359361

360362
Create encryted cookies storage.
@@ -390,7 +392,7 @@ To use the storage you need setup it first::
390392
.. class:: RedisStorage(redis_pool, *, \
391393
cookie_name="AIOHTTP_SESSION", \
392394
domain=None, max_age=None, path='/', \
393-
secure=None, httponly=True, \
395+
secure=None, httponly=True, samesite=None, \
394396
key_factory=lambda: uuid.uuid4().hex, \
395397
encoder=json.dumps, decoder=json.loads)
396398

@@ -427,7 +429,7 @@ To use the storage you need setup it first::
427429
.. class:: MemcachedStorage(memcached_conn, *, \
428430
cookie_name="AIOHTTP_SESSION", \
429431
domain=None, max_age=None, path='/', \
430-
secure=None, httponly=True, \
432+
secure=None, httponly=True, samesite=None, \
431433
key_factory=lambda: uuid.uuid4().hex, \
432434
encoder=json.dumps, decoder=json.loads)
433435

0 commit comments

Comments
 (0)