{"title":"Conas seisiúin a úsáid","version":"6.1","locale":"ga","docname":"topics/http/sessions","url":"/ga/6.1/topics/http/sessions/","canonical":"https://djangodocs.dev/ga/6.1/topics/http/sessions/","summary":"Soláthraíonn Django tacaíocht iomlán do sheisiúin gan ainm. Ligeann creat an seisiúin duit sonraí treallach a stóráil agus a aisghabháil ar bhonn cuairteora…","html":"<span id=\"how-to-use-sessions\"></span><h1>Conas seisiúin a úsáid<a class=\"heading-anchor\" href=\"#module-django.contrib.sessions\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h1>\n<p>Soláthraíonn Django tacaíocht iomlán do sheisiúin gan ainm. Ligeann creat an seisiúin duit sonraí treallach a stóráil agus a aisghabháil ar bhonn cuairteora in aghaidh an láithre Stórálann sé sonraí ar thaobh an fhreastalaí agus déanann sé achoimrí ar sheoladh agus a fháil fianáin. &lt;cookie-session-backend&gt;Tá aitheantas seisiúin i bhfianáin - ní na sonraí féin (mura bhfuil tú ag úsáid an:ref: <a href=\"#id1\"><span class=\"problematic\" id=\"id2\">`</span></a>backend bhunaithe ar fianáin <a href=\"#id3\"><span class=\"problematic\" id=\"id4\">`</span></a>).</p>\n<section id=\"enabling-sessions\">\n<h2>Seisiúin chumasaithe<a class=\"heading-anchor\" href=\"#enabling-sessions\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h2>\n<p>Cuirtear seisiúin i bhfeidhm trí phíosa de:doc: middleware &lt;/ref/middleware&gt;.</p>\n<p>Chun feidhmiúlacht seisiúin a chumasú, déan an méid seo</p>\n<ul class=\"simple\">\n<li><p>Cuir an socrú:setting: MIDDLEWARE in eagar agus déan cinnte go bhfuil <code class=\"docutils literal notranslate\">Django.contrib.sessions.middleware.sessionMiddleware'` ann. Tá `SessionMiddleware</code> gníomhachtaithe ag <code class=\"docutils literal notranslate\">django-admin startproject</code> réamhshocraithe <code class=\"docutils literal notranslate\">settings.py</code>.</p></li>\n</ul>\n<p>Mura dteastaíonn uait seisiúin a úsáid, b'fhéidir go bhfaighidh tú an líne <code class=\"docutils literal notranslate\">SessionMiddleware</code> ó:setting: MIDDLEWARE agus <a href=\"#id1\"><span class=\"problematic\" id=\"id2\">``</span></a>django.contrib.sessions' ``ó d':setting: `INSTALLED_APPS. Sábhálfaidh sé beagán laochairde duit.</p>\n</section>\n<section id=\"configuring-the-session-engine\">\n<span id=\"configuring-sessions\"></span><h2>Inneall an seisiúin a chumrú<a class=\"heading-anchor\" href=\"#configuring-the-session-engine\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h2>\n<p>De réir réamhshocraithe, stórálann Django seisiúin i do bhunachar sonraí (ag baint úsáide as an tsamhail <a href=\"#id1\"><span class=\"problematic\" id=\"id2\">``</span></a>Django.Contrib.Sessions.Models.Session <a href=\"#id3\"><span class=\"problematic\" id=\"id4\">``</span></a>). Cé go bhfuil sé seo áisiúil, i roinnt socruithe tá sé níos tapúla sonraí seisiúin a stóráil in áiteanna eile, mar sin is féidir Django a chumrú chun sonraí seisiúin a stóráil ar do chóras comhaid nó i do taisce.</p>\n<section id=\"using-database-backed-sessions\">\n<h3>Ag baint úsáide as seisiúin tacaithe<a class=\"heading-anchor\" href=\"#using-database-backed-sessions\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h3>\n<p>Más mian leat seisiún tacaíochta le bunachar sonraí a úsáid, ní mór duit <a href=\"#id1\"><span class=\"problematic\" id=\"id2\">``</span></a>django.contrib.sessions'` a chur le do shuíomh: INSTALLED_APPS.</p>\n<p>Nuair a bheidh do shuiteáil cumraithe agat, reáchtáil <code class=\"docutils literal notranslate\">manage.py migrate</code> chun an tábla bunachar sonraí aonair a stóráil sonraí seisiúin a shuiteáil.</p>\n</section>\n<section id=\"using-cached-sessions\">\n<span id=\"cached-sessions-backend\"></span><h3>Seisiúin taisceáilte a úsáid<a class=\"heading-anchor\" href=\"#using-cached-sessions\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h3>\n<p>Le haghaidh feidhmíochta níos fearr, b'fhéidir gur mhaith leat cúltaca seisiúin bunaithe ar taisce a úsáid.</p>\n<p>Chun sonraí seisiúin a stóráil ag baint úsáide as córas taisce Django, beidh ort a chinntiú go bhfuil do taisce cumraithe agat ar dtús; féach an:doc: cáipéisíocht taisceach le haghaidh sonraí &lt;/topics/cache&gt;.</p>\n<aside class=\"admonition admonition-warning\" role=\"note\">\n<p class=\"admonition-title\">Warning</p>\n<p>Níor chóir duit seisiúin cach-bhunaithe a úsáid ach má tá cúltaca taisce Memcached nó Redis á úsáid agat. Ní choinníonn an cúltaca taisce cuimhne áitiúil sonraí fada go leor le bheith ina rogha maith, agus beidh sé níos tapúla seisiúin comhad nó bunachar sonraí a úsáid go díreach in ionad gach rud a sheoladh tríd an gcúltaca taisce comhaid nó bunachar sonraí. Ina theannta sin, NÍL cúltaca taisce cuimhne áitiúil sábháilte ilphróisis, dá bhrí sin is dócha nach rogha maith é do thimpeallachtaí táirgeachta.</p>\n</aside>\n<p>Má tá iliomad taisce sainithe agat in:setting: CACHES, úsáidfidh Django an taisce réamhshocraithe. Chun taisce eile a úsáid, socraí:setting: SESSION_CACHE_ALIAS ar ainm an taisce sin.</p>\n<p>Nuair a bheidh do taisce cumraithe, caithfidh tú a roghnú idir taisce tacaíochta bunachar sonraí nó taisce neamh-leanúnach.</p>\n<p>Úsáideann cúltaca an bhunachar sonraí taisceáilte (cached_db`) taisce scríbhneoireachta - cuirtear scríbhneoireachtaí seisiúin i bhfeidhm ar an mbunachar sonraí agus taisce araon, san ord sin. Má theipeann ar scríobh chuig an taisce, déantar an eisceacht a láimhseáil agus a logáil trí:ref: session logger &lt;django-contrib-sessions-logger&gt;, chun a sheachaint ar oibríocht scríbhneoireachta rathúil ar shlí eile.</p>\n<p>Úsáideann léitheanna seisiúin an taisce, nó an bunachar sonraí má dhíothraíodh na sonraí ón taisce. Chun an cúltaca seo a úsáid, socraí:setting: SESSION_ENGINE go <code class=\"docutils literal notranslate\">&quot;django.contrib.sessions.backends.cached_db&quot;</code>, agus lean na treoracha cumraíochta do <a class=\"reference internal\" href=\"#using-database-backed-sessions\">úsáid seisiúin tacaíochta bunachar sonraí</a>.</p>\n<p>Ní stórálann an cúltaca taisce (<code class=\"docutils literal notranslate\">cache</code>) sonraí seisiúin amháin i do taisce. Tá sé seo níos gasta toisc go seachnaíonn sé marthanacht bunachar sonraí, ach beidh ort machnamh a dhéanamh ar cad a tharlaíonn nuair a dhéantar sonraí taisce a dhíbirt. Is féidir le díothú tarlú má líonann an taisce nó má athosaítear an freastalaí taisce, agus ciallaíonn sé go gcailltear sonraí seisiúin, lena n-áirítear úsáideoirí logáil amach. Chun an cúltaca seo a úsáid, socraí:setting: SESSION_ENGINE go <code class=\"docutils literal notranslate\">&quot;django.contrib.sessions.backends.cache&quot;</code>.</p>\n<p>Is féidir an cúltaca taisce a dhéanamh leanúnach trí taisce leanúnach a úsáid, mar shampla Redis le cumraíocht chuí. Ach mura bhfuil do taisce cumraithe cinnte le haghaidh marthanacht leordhóthanach, roghnaigh cúltaca an bhunachar sonraí taisceáilte. Seachnaíonn sé seo cásanna imeall de bharr stóráil sonraí neamhiontaofa sa táirge</p>\n</section>\n<section id=\"using-file-based-sessions\">\n<h3>Ag baint úsáide as seisiúin comhad<a class=\"heading-anchor\" href=\"#using-file-based-sessions\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h3>\n<p>Chun seisiúin comhadbhunaithe a úsáid, socraigh an socrú:setting: SESSION_ENGINE go <code class=\"docutils literal notranslate\">&quot;django.contrib.sessions.backends.file&quot;</code>.</p>\n<p>B'fhéidir gur mhaith leat an socrú: setting: SESSION_FILE_PATH a shocrú (a réamhshocraíonn aschur ó tempfile.gettempdir () `, is dóichí <code class=\"docutils literal notranslate\">/tmp</code>) chun rialú a dhéanamh ar an áit a stórálann Django comhaid seisiúin. Bí cinnte a sheiceáil go bhfuil ceadanna ag do fhreastalaí gréasáin chun léamh agus scríobh chuig an áit seo.</p>\n</section>\n<section id=\"using-cookie-based-sessions\">\n<span id=\"cookie-session-backend\"></span><h3>Seisiúin bunaithe ar fhianán a úsáid<a class=\"heading-anchor\" href=\"#using-cookie-based-sessions\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h3>\n<p>Chun seisiúin bunaithe ar fhianáin a úsáid, socraigh an socrú:setting: SESSION_ENGINE go <code class=\"docutils literal notranslate\">&quot;django.contrib.sessions.backends.signed_cookies&quot;</code>. Stórálfar sonraí na seisiúin ag baint úsáide as uirlisí Django le haghaidh: doc: síniú cripteagrafach' agus an socrú:: `SECRET_KEY. &lt;/topics/signing&gt;</p>\n<aside class=\"admonition admonition-note\" role=\"note\">\n<p class=\"admonition-title\">Note</p>\n<p>Moltar an socrú:setting: SESSION_COOKIE_HTTPONLY a fhágáil ar True` chun rochtain ar na sonraí stóráilte ó JavaScript a chosc.</p>\n</aside>\n<aside class=\"admonition admonition-warning\" role=\"note\">\n<p class=\"admonition-title\">Warning</p>\n<p>** Sínítear sonraí na seisiúin ach níl siad criptithe</p>\n<p>Nuair a bhíonn cúltaca na fianáin á n-úsáid agat is féidir leis an gcliant sonraí na seisiúin a léamh.</p>\n<p>Úsáidtear MAC (Cód Fíordheimhnithe Teachtaireachta) chun na sonraí a chosaint ar athruithe a dhéanann an chliant, ionas go ndéanfar sonraí na seisiúin neamhbhailí agus iad ag cur isteach orthu. Tarlaíonn an neamhbhailí céanna mura féidir leis an gcliant atá ag stóráil an fianán (m.sh. brabhsálaí d'úsáideora) an fianán seisiúin go léir a stóráil agus scaoileann &lt;2965 #section -5.3&gt;Cé go gcomhbhrúiteann Django na sonraí, is féidir go hiomlán fós an: rfc: <a href=\"#id1\"><span class=\"problematic\" id=\"id2\">`</span></a>teorainn choiteann de 4096 baite' in aghaidh an fhianáin a shárú.</p>\n<p>** Gan aon ráthaíocht úire**</p>\n<p>Tabhair faoi deara freisin cé gur féidir leis an MAC barántúlacht na sonraí a ráthú (gur ghin do shuíomh iad, agus ní duine eile), agus sláine na sonraí (go bhfuil sé ar fad ann agus ceart), ní féidir leis úire a ráthú ie go bhfuil tú á sheoladh ar ais an rud deireanach a chuir tú chuig an gcliant. Ciallaíonn sé seo, i gcás roinnt úsáidí sonraí seisiúin, d'fhéadfadh cúltaca fianán tú a oscailt chun ionsaithe a athsheinm `_. Murab ionann agus cúltaca seisiúin eile a choinníonn taifead taobh an fhreastalaí de gach seisiún agus a chuireann neamhbhailí é nuair a logálann úsáideoir amach, ní chuirtear seisiúin bunaithe ar fhianán neamhbhailí nuair a logálann Mar sin má ghoideann ionsaitheoir fianán úsáideora, is féidir leo an fianán sin a úsáid chun logáil isteach mar an úsáideoir sin fiú má logálann an t-úsáideoir amach. Ní bhraithfear fianáin mar 'seasmhach' ach amháin má tá siad níos sine ná leat:setting: `SESSION_COOKIE_AGE.</p>\n<p><strong>Feidhmíocht</strong></p>\n<p>Faoi dheireadh, is féidir le méid fianán tionchar a imirt ar luas do shuíomh.</p>\n</aside>\n</section>\n</section>\n<section id=\"using-sessions-in-views\">\n<h2>Seisiúin a úsáid i radhairc<a class=\"heading-anchor\" href=\"#using-sessions-in-views\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h2>\n<p>Nuair a chuirtear SessionMiddleWare` i ngníomh, beidh tréith <code class=\"docutils literal notranslate\">seisiúna</code> ag gach rud: ~django.http.httpRequest - an chéad argóint d'aon fheidhm amharc Django -- tréith <code class=\"docutils literal notranslate\">seisiú</code>, ar réad cosúil le foclóir é.</p>\n<p>Is féidir leat é a léamh agus scríobh chuig <a href=\"#id1\"><span class=\"problematic\" id=\"id2\">`</span></a>request.session <a href=\"#id3\"><span class=\"problematic\" id=\"id4\">``</span></a>ag aon phointe i do thuairim. Is féidir leat é a chur in eagar arís agus arís eile.</p>\n<dl class=\"py class\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase\">\n<em class=\"property\"><span class=\"k\">class</span> </em><span class=\"sig-prename descclassname\">backends.base.</span><span class=\"sig-name descname\">SessionBase</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p>Is é seo an bunaicme do gach réad seisiúin. Tá na modhanna caighdeánacha foclóra seo a leanas aige:</p>\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.__getitem__\">\n<span class=\"sig-name descname\">__getitem__</span><span class=\"sig-paren\">(</span><em class=\"sig-param\">key</em><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.__getitem__\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p>Sampla: <a href=\"#id1\"><span class=\"problematic\" id=\"id2\">``</span></a>fav_color = iarrat.session ['fav_color'] ``</p>\n</dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.__setitem__\">\n<span class=\"sig-name descname\">__setitem__</span><span class=\"sig-paren\">(</span><em class=\"sig-param\">key</em>, <em class=\"sig-param\">value</em><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.__setitem__\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p>Sampla: <a href=\"#id1\"><span class=\"problematic\" id=\"id2\">``</span></a>request.session ['fav_color'] = 'blue' ``</p>\n</dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.__delitem__\">\n<span class=\"sig-name descname\">__delitem__</span><span class=\"sig-paren\">(</span><em class=\"sig-param\">key</em><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.__delitem__\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p>Example: <code class=\"docutils literal notranslate\">del request.session['fav_color']</code>. This raises <code class=\"docutils literal notranslate\">KeyError</code>\nif the given <code class=\"docutils literal notranslate\">key</code> isn't already in the session.</p>\n</dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.__contains__\">\n<span class=\"sig-name descname\">__contains__</span><span class=\"sig-paren\">(</span><em class=\"sig-param\">key</em><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.__contains__\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p>Example: <code class=\"docutils literal notranslate\">'fav_color' in request.session</code></p>\n</dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.__bool__\">\n<span class=\"sig-name descname\">__bool__</span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.__bool__\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><aside class=\"version-note version-added\" data-version=\"6.1\" role=\"note\">\n<p class=\"version-note-title\">New in Django 6.1</p></aside>\n<p>Returns the inverse of <a class=\"reference internal\" href=\"#django.contrib.sessions.backends.base.SessionBase.is_empty\" title=\"django.contrib.sessions.backends.base.SessionBase.is_empty\"><code class=\"xref py py-meth docutils literal notranslate\">is_empty()</code></a>. This allows checking if a\nsession has data:</p>\n<div class=\"code-block\" data-language=\"default\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Code</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Code code\"><code><span class=\"k\">if</span> request<span class=\"o\">.</span>session<span class=\"p\">:</span>\n    <span class=\"c1\"># Session has data or a key</span>\n    <span class=\"k\">pass</span>\n</code></pre></div>\n</dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.get\">\n<span class=\"sig-name descname\">get</span><span class=\"sig-paren\">(</span><em class=\"sig-param\">key</em>, <em class=\"sig-param\">default<span class=\"o\">=</span><span class=\"default_value\">None</span></em><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.get\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd></dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.aget\">\n<span class=\"sig-name descname\">aget</span><span class=\"sig-paren\">(</span><em class=\"sig-param\">key</em>, <em class=\"sig-param\">default<span class=\"o\">=</span><span class=\"default_value\">None</span></em><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.aget\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p><em>Leagan asincrón</em>: <a href=\"#id1\"><span class=\"problematic\" id=\"id2\">``</span></a>aget () ``</p>\n<p>Example: <code class=\"docutils literal notranslate\">fav_color = request.session.get('fav_color', 'red')</code></p>\n</dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.aset\">\n<span class=\"sig-name descname\">aset</span><span class=\"sig-paren\">(</span><em class=\"sig-param\">key</em>, <em class=\"sig-param\">value</em><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.aset\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p>Example: <code class=\"docutils literal notranslate\">await request.session.aset('fav_color', 'red')</code></p>\n</dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.update\">\n<span class=\"sig-name descname\">update</span><span class=\"sig-paren\">(</span><em class=\"sig-param\">dict</em><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.update\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd></dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.aupdate\">\n<span class=\"sig-name descname\">aupdate</span><span class=\"sig-paren\">(</span><em class=\"sig-param\">dict</em><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.aupdate\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p><em>Asynchronous version</em>: <code class=\"docutils literal notranslate\">aupdate()</code></p>\n<p>Example: <code class=\"docutils literal notranslate\">request.session.update({'fav_color': 'red'})</code></p>\n</dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.pop\">\n<span class=\"sig-name descname\">pop</span><span class=\"sig-paren\">(</span><em class=\"sig-param\">key</em>, <em class=\"sig-param\">default<span class=\"o\">=</span><span class=\"default_value\">__not_given</span></em><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.pop\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd></dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.apop\">\n<span class=\"sig-name descname\">apop</span><span class=\"sig-paren\">(</span><em class=\"sig-param\">key</em>, <em class=\"sig-param\">default<span class=\"o\">=</span><span class=\"default_value\">__not_given</span></em><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.apop\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p><em>Asynchronous version</em>: <code class=\"docutils literal notranslate\">apop()</code></p>\n<p>Example: <code class=\"docutils literal notranslate\">fav_color = request.session.pop('fav_color', 'blue')</code></p>\n</dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.keys\">\n<span class=\"sig-name descname\">keys</span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.keys\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd></dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.akeys\">\n<span class=\"sig-name descname\">akeys</span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.akeys\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p><em>Asynchronous version</em>: <code class=\"docutils literal notranslate\">akeys()</code></p>\n</dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.values\">\n<span class=\"sig-name descname\">values</span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.values\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd></dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.avalues\">\n<span class=\"sig-name descname\">avalues</span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.avalues\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p><em>Asynchronous version</em>: <code class=\"docutils literal notranslate\">avalues()</code></p>\n</dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.has_key\">\n<span class=\"sig-name descname\">has_key</span><span class=\"sig-paren\">(</span><em class=\"sig-param\">key</em><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.has_key\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd></dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.ahas_key\">\n<span class=\"sig-name descname\">ahas_key</span><span class=\"sig-paren\">(</span><em class=\"sig-param\">key</em><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.ahas_key\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p><em>Asynchronous version</em>: <code class=\"docutils literal notranslate\">ahas_key()</code></p>\n</dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.items\">\n<span class=\"sig-name descname\">items</span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.items\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd></dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.aitems\">\n<span class=\"sig-name descname\">aitems</span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.aitems\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p><em>Asynchronous version</em>: <code class=\"docutils literal notranslate\">aitems()</code></p>\n</dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.setdefault\">\n<span class=\"sig-name descname\">setdefault</span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.setdefault\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd></dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.asetdefault\">\n<span class=\"sig-name descname\">asetdefault</span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.asetdefault\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p><em>Asynchronous version</em>: <code class=\"docutils literal notranslate\">asetdefault()</code></p>\n</dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.clear\">\n<span class=\"sig-name descname\">clear</span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.clear\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd></dd></dl>\n\n<p>It also has these methods:</p>\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.flush\">\n<span class=\"sig-name descname\">flush</span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.flush\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd></dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.aflush\">\n<span class=\"sig-name descname\">aflush</span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.aflush\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p><em>Asynchronous version</em>: <code class=\"docutils literal notranslate\">aflush()</code></p>\n<p>Deletes the current session data from the session and deletes the session\ncookie. This is used if you want to ensure that the previous session data\ncan't be accessed again from the user's browser (for example, the\n<a class=\"reference internal\" href=\"/ga/6.1/topics/auth/default/#django.contrib.auth.logout\" title=\"django.contrib.auth.logout\"><code class=\"xref py py-func docutils literal notranslate\">django.contrib.auth.logout()</code></a> function calls it).</p>\n</dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.is_empty\">\n<span class=\"sig-name descname\">is_empty</span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.is_empty\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p>Returns <code class=\"docutils literal notranslate\">True</code> if the session does not have a key and is empty.</p>\n</dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.set_test_cookie\">\n<span class=\"sig-name descname\">set_test_cookie</span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.set_test_cookie\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd></dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.aset_test_cookie\">\n<span class=\"sig-name descname\">aset_test_cookie</span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.aset_test_cookie\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p><em>Asynchronous version</em>: <code class=\"docutils literal notranslate\">aset_test_cookie()</code></p>\n<p>Sets a test cookie to determine whether the user's browser supports\ncookies. Due to the way cookies work, you won't be able to test this\nuntil the user's next page request. See <a class=\"reference internal\" href=\"#setting-test-cookies\">Setting test cookies</a> below for\nmore information.</p>\n</dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.test_cookie_worked\">\n<span class=\"sig-name descname\">test_cookie_worked</span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.test_cookie_worked\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd></dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.atest_cookie_worked\">\n<span class=\"sig-name descname\">atest_cookie_worked</span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.atest_cookie_worked\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p><em>Asynchronous version</em>: <code class=\"docutils literal notranslate\">atest_cookie_worked()</code></p>\n<p>Returns either <code class=\"docutils literal notranslate\">True</code> or <code class=\"docutils literal notranslate\">False</code>, depending on whether the user's\nbrowser accepted the test cookie. Due to the way cookies work, you'll\nhave to call <code class=\"docutils literal notranslate\">set_test_cookie()</code> or <code class=\"docutils literal notranslate\">aset_test_cookie()</code> on a\nprevious, separate page request.\nSee <a class=\"reference internal\" href=\"#setting-test-cookies\">Setting test cookies</a> below for more information.</p>\n</dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.delete_test_cookie\">\n<span class=\"sig-name descname\">delete_test_cookie</span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.delete_test_cookie\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd></dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.adelete_test_cookie\">\n<span class=\"sig-name descname\">adelete_test_cookie</span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.adelete_test_cookie\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p><em>Asynchronous version</em>: <code class=\"docutils literal notranslate\">adelete_test_cookie()</code></p>\n<p>Deletes the test cookie. Use this to clean up after yourself.</p>\n</dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.get_session_cookie_age\">\n<span class=\"sig-name descname\">get_session_cookie_age</span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.get_session_cookie_age\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p>Returns the value of the setting <a class=\"reference internal\" href=\"/ga/6.1/ref/settings/#std-setting-SESSION_COOKIE_AGE\"><code class=\"xref std std-setting docutils literal notranslate\">SESSION_COOKIE_AGE</code></a>. This can\nbe overridden in a custom session backend.</p>\n</dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.set_expiry\">\n<span class=\"sig-name descname\">set_expiry</span><span class=\"sig-paren\">(</span><em class=\"sig-param\">value</em><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.set_expiry\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd></dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.aset_expiry\">\n<span class=\"sig-name descname\">aset_expiry</span><span class=\"sig-paren\">(</span><em class=\"sig-param\">value</em><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.aset_expiry\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p><em>Asynchronous version</em>: <code class=\"docutils literal notranslate\">aset_expiry()</code></p>\n<p>Sets the expiration time for the session. You can pass a number of\ndifferent values:</p>\n<ul class=\"simple\">\n<li><p>If <code class=\"docutils literal notranslate\">value</code> is an integer, the session will expire after that\nmany seconds of inactivity. For example, calling\n<code class=\"docutils literal notranslate\">request.session.set_expiry(300)</code> would make the session expire\nin 5 minutes.</p></li>\n<li><p>If <code class=\"docutils literal notranslate\">value</code> is a <code class=\"docutils literal notranslate\">datetime</code> or <code class=\"docutils literal notranslate\">timedelta</code> object, the session\nwill expire at that specific date/time.</p></li>\n<li><p>If <code class=\"docutils literal notranslate\">value</code> is <code class=\"docutils literal notranslate\">0</code>, the user's session cookie will expire\nwhen the user's web browser is closed.</p></li>\n<li><p>If <code class=\"docutils literal notranslate\">value</code> is <code class=\"docutils literal notranslate\">None</code>, the session reverts to using the global\nsession expiry policy.</p></li>\n</ul>\n<p>Reading a session is not considered activity for expiration\npurposes. Session expiration is computed from the last time the\nsession was <em>modified</em>.</p>\n</dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.get_expiry_age\">\n<span class=\"sig-name descname\">get_expiry_age</span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.get_expiry_age\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd></dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.aget_expiry_age\">\n<span class=\"sig-name descname\">aget_expiry_age</span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.aget_expiry_age\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p><em>Asynchronous version</em>: <code class=\"docutils literal notranslate\">aget_expiry_age()</code></p>\n<p>Returns the number of seconds until this session expires. For sessions\nwith no custom expiration (or those set to expire at browser close), this\nwill equal <a class=\"reference internal\" href=\"/ga/6.1/ref/settings/#std-setting-SESSION_COOKIE_AGE\"><code class=\"xref std std-setting docutils literal notranslate\">SESSION_COOKIE_AGE</code></a>.</p>\n<p>This function accepts two optional keyword arguments:</p>\n<ul class=\"simple\">\n<li><p><code class=\"docutils literal notranslate\">modification</code>: last modification of the session, as a\n<a class=\"reference external\" href=\"https://docs.python.org/3/library/datetime.html#datetime.datetime\" title=\"(in Python v3.14)\"><code class=\"xref py py-class docutils literal notranslate\">datetime</code></a> object. Defaults to the current time.</p></li>\n<li><p><code class=\"docutils literal notranslate\">expiry</code>: expiry information for the session, as a\n<a class=\"reference external\" href=\"https://docs.python.org/3/library/datetime.html#datetime.datetime\" title=\"(in Python v3.14)\"><code class=\"xref py py-class docutils literal notranslate\">datetime</code></a> object, an <a class=\"reference external\" href=\"https://docs.python.org/3/library/functions.html#int\" title=\"(in Python v3.14)\"><code class=\"xref py py-class docutils literal notranslate\">int</code></a> (in seconds), or\n<code class=\"docutils literal notranslate\">None</code>. Defaults to the value stored in the session by\n<a class=\"reference internal\" href=\"#django.contrib.sessions.backends.base.SessionBase.set_expiry\" title=\"django.contrib.sessions.backends.base.SessionBase.set_expiry\"><code class=\"xref py py-meth docutils literal notranslate\">set_expiry()</code></a>/<a class=\"reference internal\" href=\"#django.contrib.sessions.backends.base.SessionBase.aset_expiry\" title=\"django.contrib.sessions.backends.base.SessionBase.aset_expiry\"><code class=\"xref py py-meth docutils literal notranslate\">aset_expiry()</code></a>, if there is one, or <code class=\"docutils literal notranslate\">None</code>.</p></li>\n</ul>\n<aside class=\"admonition admonition-note\" role=\"note\">\n<p class=\"admonition-title\">Note</p>\n<p>This method is used by session backends to determine the session expiry\nage in seconds when saving the session. It is not really intended for\nusage outside of that context.</p>\n<p>In particular, while it is <strong>possible</strong> to determine the remaining\nlifetime of a session <strong>just when</strong> you have the correct\n<code class=\"docutils literal notranslate\">modification</code> value <strong>and</strong> the <code class=\"docutils literal notranslate\">expiry</code> is set as a <code class=\"docutils literal notranslate\">datetime</code>\nobject, where you do have the <code class=\"docutils literal notranslate\">modification</code> value, it is more\nstraight-forward to calculate the expiry by-hand:</p>\n<div class=\"code-block\" data-language=\"default\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Code</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Code code\"><code>expires_at <span class=\"o\">=</span> modification <span class=\"o\">+</span> timedelta<span class=\"p\">(</span>seconds<span class=\"o\">=</span>settings<span class=\"o\">.</span>SESSION_COOKIE_AGE<span class=\"p\">)</span>\n</code></pre></div>\n</aside>\n</dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.get_expiry_date\">\n<span class=\"sig-name descname\">get_expiry_date</span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.get_expiry_date\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd></dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.aget_expiry_date\">\n<span class=\"sig-name descname\">aget_expiry_date</span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.aget_expiry_date\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p><em>Asynchronous version</em>: <code class=\"docutils literal notranslate\">aget_expiry_date()</code></p>\n<p>Returns the date this session will expire. For sessions with no custom\nexpiration (or those set to expire at browser close), this will equal the\ndate <a class=\"reference internal\" href=\"/ga/6.1/ref/settings/#std-setting-SESSION_COOKIE_AGE\"><code class=\"xref std std-setting docutils literal notranslate\">SESSION_COOKIE_AGE</code></a> seconds from now.</p>\n<p>This function accepts the same keyword arguments as\n<a class=\"reference internal\" href=\"#django.contrib.sessions.backends.base.SessionBase.get_expiry_age\" title=\"django.contrib.sessions.backends.base.SessionBase.get_expiry_age\"><code class=\"xref py py-meth docutils literal notranslate\">get_expiry_age()</code></a>, and similar notes on usage apply.</p>\n</dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.get_expire_at_browser_close\">\n<span class=\"sig-name descname\">get_expire_at_browser_close</span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.get_expire_at_browser_close\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd></dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.aget_expire_at_browser_close\">\n<span class=\"sig-name descname\">aget_expire_at_browser_close</span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.aget_expire_at_browser_close\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p><em>Asynchronous version</em>: <code class=\"docutils literal notranslate\">aget_expire_at_browser_close()</code></p>\n<p>Returns either <code class=\"docutils literal notranslate\">True</code> or <code class=\"docutils literal notranslate\">False</code>, depending on whether the user's\nsession cookie will expire when the user's web browser is closed.</p>\n</dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.clear_expired\">\n<span class=\"sig-name descname\">clear_expired</span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.clear_expired\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd></dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.aclear_expired\">\n<span class=\"sig-name descname\">aclear_expired</span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.aclear_expired\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p><em>Asynchronous version</em>: <code class=\"docutils literal notranslate\">aclear_expired()</code></p>\n<p>Removes expired sessions from the session store. This class method is\ncalled by <a class=\"reference internal\" href=\"/ga/6.1/ref/django-admin/#django-admin-clearsessions\"><code class=\"xref std std-djadmin docutils literal notranslate\">clearsessions</code></a>.</p>\n</dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.cycle_key\">\n<span class=\"sig-name descname\">cycle_key</span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.cycle_key\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd></dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.base.SessionBase.acycle_key\">\n<span class=\"sig-name descname\">acycle_key</span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.base.SessionBase.acycle_key\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p><em>Asynchronous version</em>: <code class=\"docutils literal notranslate\">acycle_key()</code></p>\n<p>Creates a new session key while retaining the current session data.\n<a class=\"reference internal\" href=\"/ga/6.1/topics/auth/default/#django.contrib.auth.login\" title=\"django.contrib.auth.login\"><code class=\"xref py py-func docutils literal notranslate\">django.contrib.auth.login()</code></a> calls this method to mitigate against\nsession fixation.</p>\n</dd></dl>\n\n</dd></dl>\n\n<section id=\"session-serialization\">\n<span id=\"id1\"></span><h3>Session serialization<a class=\"heading-anchor\" href=\"#session-serialization\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h3>\n<p>By default, Django serializes session data using JSON. You can use the\n<a class=\"reference internal\" href=\"/ga/6.1/ref/settings/#std-setting-SESSION_SERIALIZER\"><code class=\"xref std std-setting docutils literal notranslate\">SESSION_SERIALIZER</code></a> setting to customize the session serialization\nformat. Even with the caveats described in <a class=\"reference internal\" href=\"#custom-serializers\"><span class=\"std std-ref\">Write your own serializer</span></a>, we highly\nrecommend sticking with JSON serialization <em>especially if you are using the\ncookie backend</em>.</p>\n<p>For example, here's an attack scenario if you use <a class=\"reference external\" href=\"https://docs.python.org/3/library/pickle.html#module-pickle\" title=\"(in Python v3.14)\"><code class=\"xref py py-mod docutils literal notranslate\">pickle</code></a> to serialize\nsession data. If you're using the <a class=\"reference internal\" href=\"#cookie-session-backend\"><span class=\"std std-ref\">signed cookie session backend</span></a> and <a class=\"reference internal\" href=\"/ga/6.1/ref/settings/#std-setting-SECRET_KEY\"><code class=\"xref std std-setting docutils literal notranslate\">SECRET_KEY</code></a> (or any key of\n<a class=\"reference internal\" href=\"/ga/6.1/ref/settings/#std-setting-SECRET_KEY_FALLBACKS\"><code class=\"xref std std-setting docutils literal notranslate\">SECRET_KEY_FALLBACKS</code></a>) is known by an attacker (there isn't an\ninherent vulnerability in Django that would cause it to leak), the attacker\ncould insert a string into their session which, when unpickled, executes\narbitrary code on the server. The technique for doing so is simple and easily\navailable on the internet. Although the cookie session storage signs the\ncookie-stored data to prevent tampering, a <a class=\"reference internal\" href=\"/ga/6.1/ref/settings/#std-setting-SECRET_KEY\"><code class=\"xref std std-setting docutils literal notranslate\">SECRET_KEY</code></a> leak\nimmediately escalates to a remote code execution vulnerability.</p>\n<section id=\"bundled-serializers\">\n<h4>Bundled serializers<a class=\"heading-anchor\" href=\"#bundled-serializers\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h4>\n<dl class=\"py class\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.serializers.JSONSerializer\">\n<em class=\"property\"><span class=\"k\">class</span> </em><span class=\"sig-prename descclassname\">serializers.</span><span class=\"sig-name descname\">JSONSerializer</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.serializers.JSONSerializer\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p>A wrapper around the JSON serializer from <a class=\"reference internal\" href=\"/ga/6.1/topics/signing/#module-django.core.signing\" title=\"django.core.signing: Django's signing framework.\"><code class=\"xref py py-mod docutils literal notranslate\">django.core.signing</code></a>. Can\nonly serialize basic data types.</p>\n<p>In addition, as JSON supports only string keys, note that using non-string\nkeys in <code class=\"docutils literal notranslate\">request.session</code> won't work as expected:</p>\n<div class=\"code-block\" data-language=\"pycon\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Python console</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Python console code\"><code><span class=\"gp\">&gt;&gt;&gt; </span><span class=\"c1\"># initial assignment</span>\n<span class=\"gp\">&gt;&gt;&gt; </span>request<span class=\"o\">.</span>session<span class=\"p\">[</span><span class=\"mi\">0</span><span class=\"p\">]</span> <span class=\"o\">=</span> <span class=\"s2\">&quot;bar&quot;</span>\n<span class=\"gp\">&gt;&gt;&gt; </span><span class=\"c1\"># subsequent requests following serialization &amp; deserialization</span>\n<span class=\"gp\">&gt;&gt;&gt; </span><span class=\"c1\"># of session data</span>\n<span class=\"gp\">&gt;&gt;&gt; </span>request<span class=\"o\">.</span>session<span class=\"p\">[</span><span class=\"mi\">0</span><span class=\"p\">]</span>  <span class=\"c1\"># KeyError</span>\n<span class=\"gp\">&gt;&gt;&gt; </span>request<span class=\"o\">.</span>session<span class=\"p\">[</span><span class=\"s2\">&quot;0&quot;</span><span class=\"p\">]</span>\n<span class=\"go\">&#39;bar&#39;</span>\n</code></pre></div>\n<p>Similarly, data that can't be encoded in JSON, such as non-UTF8 bytes like\n<code class=\"docutils literal notranslate\">'\\xd9'</code> (which raises <a class=\"reference external\" href=\"https://docs.python.org/3/library/exceptions.html#UnicodeDecodeError\" title=\"(in Python v3.14)\"><code class=\"xref py py-exc docutils literal notranslate\">UnicodeDecodeError</code></a>), can't be stored.</p>\n<p>See the <a class=\"reference internal\" href=\"#custom-serializers\"><span class=\"std std-ref\">Write your own serializer</span></a> section for more details on limitations\nof JSON serialization.</p>\n</dd></dl>\n\n</section>\n<section id=\"write-your-own-serializer\">\n<span id=\"custom-serializers\"></span><h4>Write your own serializer<a class=\"heading-anchor\" href=\"#write-your-own-serializer\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h4>\n<p>Note that the <a class=\"reference internal\" href=\"#django.contrib.sessions.serializers.JSONSerializer\" title=\"django.contrib.sessions.serializers.JSONSerializer\"><code class=\"xref py py-class docutils literal notranslate\">JSONSerializer</code></a>\ncannot handle arbitrary Python data types. As is often the case, there is a\ntrade-off between convenience and security. If you wish to store more advanced\ndata types including <code class=\"docutils literal notranslate\">datetime</code> and <code class=\"docutils literal notranslate\">Decimal</code> in JSON backed sessions, you\nwill need to write a custom serializer (or convert such values to a JSON\nserializable object before storing them in <code class=\"docutils literal notranslate\">request.session</code>). While\nserializing these values is often straightforward\n(<a class=\"reference internal\" href=\"/ga/6.1/topics/serialization/#django.core.serializers.json.DjangoJSONEncoder\" title=\"django.core.serializers.json.DjangoJSONEncoder\"><code class=\"xref py py-class docutils literal notranslate\">DjangoJSONEncoder</code></a> may be helpful),\nwriting a decoder that can reliably get back the same thing that you put in is\nmore fragile. For example, you run the risk of returning a <code class=\"docutils literal notranslate\">datetime</code> that\nwas actually a string that just happened to be in the same format chosen for\n<code class=\"docutils literal notranslate\">datetime</code>s.</p>\n<p>Your serializer class must implement two methods,\n<code class=\"docutils literal notranslate\">dumps(self, obj)</code> and <code class=\"docutils literal notranslate\">loads(self, data)</code>, to serialize and deserialize\nthe dictionary of session data, respectively.</p>\n</section>\n</section>\n<section id=\"session-object-guidelines\">\n<h3>Session object guidelines<a class=\"heading-anchor\" href=\"#session-object-guidelines\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h3>\n<ul class=\"simple\">\n<li><p>Use normal Python strings as dictionary keys on <code class=\"docutils literal notranslate\">request.session</code>. This\nis more of a convention than a hard-and-fast rule.</p></li>\n<li><p>Session dictionary keys that begin with an underscore are reserved for\ninternal use by Django.</p></li>\n<li><p>Don't override <code class=\"docutils literal notranslate\">request.session</code> with a new object, and don't access or\nset its attributes. Use it like a Python dictionary.</p></li>\n</ul>\n</section>\n<section id=\"examples\">\n<h3>Samplaí<a class=\"heading-anchor\" href=\"#examples\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h3>\n<p>This simplistic view sets a <code class=\"docutils literal notranslate\">has_commented</code> variable to <code class=\"docutils literal notranslate\">True</code> after a user\nposts a comment. It doesn't let a user post a comment more than once:</p>\n<div class=\"code-block\" data-language=\"default\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Code</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Code code\"><code><span class=\"k\">def</span> <span class=\"nf\">post_comment</span><span class=\"p\">(</span>request<span class=\"p\">,</span> new_comment<span class=\"p\">):</span>\n    <span class=\"k\">if</span> request<span class=\"o\">.</span>session<span class=\"o\">.</span>get<span class=\"p\">(</span><span class=\"s2\">&quot;has_commented&quot;</span><span class=\"p\">,</span> <span class=\"kc\">False</span><span class=\"p\">):</span>\n        <span class=\"k\">return</span> HttpResponse<span class=\"p\">(</span><span class=\"s2\">&quot;You&#39;ve already commented.&quot;</span><span class=\"p\">)</span>\n    c <span class=\"o\">=</span> comments<span class=\"o\">.</span>Comment<span class=\"p\">(</span>comment<span class=\"o\">=</span>new_comment<span class=\"p\">)</span>\n    c<span class=\"o\">.</span>save<span class=\"p\">()</span>\n    request<span class=\"o\">.</span>session<span class=\"p\">[</span><span class=\"s2\">&quot;has_commented&quot;</span><span class=\"p\">]</span> <span class=\"o\">=</span> <span class=\"kc\">True</span>\n    <span class=\"k\">return</span> HttpResponse<span class=\"p\">(</span><span class=\"s2\">&quot;Thanks for your comment!&quot;</span><span class=\"p\">)</span>\n</code></pre></div>\n<p>This simplistic view logs in a &quot;member&quot; of the site:</p>\n<div class=\"code-block\" data-language=\"default\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Code</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Code code\"><code><span class=\"k\">def</span> <span class=\"nf\">login</span><span class=\"p\">(</span>request<span class=\"p\">):</span>\n    m <span class=\"o\">=</span> Member<span class=\"o\">.</span>objects<span class=\"o\">.</span>get<span class=\"p\">(</span>username<span class=\"o\">=</span>request<span class=\"o\">.</span>POST<span class=\"p\">[</span><span class=\"s2\">&quot;username&quot;</span><span class=\"p\">])</span>\n    <span class=\"k\">if</span> m<span class=\"o\">.</span>check_password<span class=\"p\">(</span>request<span class=\"o\">.</span>POST<span class=\"p\">[</span><span class=\"s2\">&quot;password&quot;</span><span class=\"p\">]):</span>\n        request<span class=\"o\">.</span>session<span class=\"p\">[</span><span class=\"s2\">&quot;member_id&quot;</span><span class=\"p\">]</span> <span class=\"o\">=</span> m<span class=\"o\">.</span>id\n        <span class=\"k\">return</span> HttpResponse<span class=\"p\">(</span><span class=\"s2\">&quot;You&#39;re logged in.&quot;</span><span class=\"p\">)</span>\n    <span class=\"k\">else</span><span class=\"p\">:</span>\n        <span class=\"k\">return</span> HttpResponse<span class=\"p\">(</span><span class=\"s2\">&quot;Your username and password didn&#39;t match.&quot;</span><span class=\"p\">)</span>\n</code></pre></div>\n<p>...And this one logs a member out, according to <code class=\"docutils literal notranslate\">login()</code> above:</p>\n<div class=\"code-block\" data-language=\"default\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Code</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Code code\"><code><span class=\"k\">def</span> <span class=\"nf\">logout</span><span class=\"p\">(</span>request<span class=\"p\">):</span>\n    <span class=\"k\">try</span><span class=\"p\">:</span>\n        <span class=\"k\">del</span> request<span class=\"o\">.</span>session<span class=\"p\">[</span><span class=\"s2\">&quot;member_id&quot;</span><span class=\"p\">]</span>\n    <span class=\"k\">except</span> <span class=\"ne\">KeyError</span><span class=\"p\">:</span>\n        <span class=\"k\">pass</span>\n    <span class=\"k\">return</span> HttpResponse<span class=\"p\">(</span><span class=\"s2\">&quot;You&#39;re logged out.&quot;</span><span class=\"p\">)</span>\n</code></pre></div>\n<p>The standard <a class=\"reference internal\" href=\"/ga/6.1/topics/auth/default/#django.contrib.auth.logout\" title=\"django.contrib.auth.logout\"><code class=\"xref py py-meth docutils literal notranslate\">django.contrib.auth.logout()</code></a> function actually does a bit\nmore than this to prevent inadvertent data leakage. It calls the\n<a class=\"reference internal\" href=\"#django.contrib.sessions.backends.base.SessionBase.flush\" title=\"django.contrib.sessions.backends.base.SessionBase.flush\"><code class=\"xref py py-meth docutils literal notranslate\">flush()</code></a> method of <code class=\"docutils literal notranslate\">request.session</code>.\nWe are using this example as a demonstration of how to work with session\nobjects, not as a full <code class=\"docutils literal notranslate\">logout()</code> implementation.</p>\n</section>\n</section>\n<section id=\"setting-test-cookies\">\n<h2>Setting test cookies<a class=\"heading-anchor\" href=\"#setting-test-cookies\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h2>\n<p>As a convenience, Django provides a way to test whether the user's browser\naccepts cookies. Call the <a class=\"reference internal\" href=\"#django.contrib.sessions.backends.base.SessionBase.set_test_cookie\" title=\"django.contrib.sessions.backends.base.SessionBase.set_test_cookie\"><code class=\"xref py py-meth docutils literal notranslate\">set_test_cookie()</code></a>\nmethod of <code class=\"docutils literal notranslate\">request.session</code> in a view, and call\n<a class=\"reference internal\" href=\"#django.contrib.sessions.backends.base.SessionBase.test_cookie_worked\" title=\"django.contrib.sessions.backends.base.SessionBase.test_cookie_worked\"><code class=\"xref py py-meth docutils literal notranslate\">test_cookie_worked()</code></a> in a subsequent view --\nnot in the same view call.</p>\n<p>This awkward split between <code class=\"docutils literal notranslate\">set_test_cookie()</code> and <code class=\"docutils literal notranslate\">test_cookie_worked()</code>\nis necessary due to the way cookies work. When you set a cookie, you can't\nactually tell whether a browser accepted it until the browser's next request.</p>\n<p>It's good practice to use\n<a class=\"reference internal\" href=\"#django.contrib.sessions.backends.base.SessionBase.delete_test_cookie\" title=\"django.contrib.sessions.backends.base.SessionBase.delete_test_cookie\"><code class=\"xref py py-meth docutils literal notranslate\">delete_test_cookie()</code></a> to clean up after\nyourself. Do this after you've verified that the test cookie worked.</p>\n<p>Here's a typical usage example:</p>\n<div class=\"code-block\" data-language=\"default\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Code</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Code code\"><code><span class=\"kn\">from</span> <span class=\"nn\">django.http</span> <span class=\"kn\">import</span> HttpResponse\n<span class=\"kn\">from</span> <span class=\"nn\">django.shortcuts</span> <span class=\"kn\">import</span> render\n\n\n<span class=\"k\">def</span> <span class=\"nf\">login</span><span class=\"p\">(</span>request<span class=\"p\">):</span>\n    <span class=\"k\">if</span> request<span class=\"o\">.</span>method <span class=\"o\">==</span> <span class=\"s2\">&quot;POST&quot;</span><span class=\"p\">:</span>\n        <span class=\"k\">if</span> request<span class=\"o\">.</span>session<span class=\"o\">.</span>test_cookie_worked<span class=\"p\">():</span>\n            request<span class=\"o\">.</span>session<span class=\"o\">.</span>delete_test_cookie<span class=\"p\">()</span>\n            <span class=\"k\">return</span> HttpResponse<span class=\"p\">(</span><span class=\"s2\">&quot;You&#39;re logged in.&quot;</span><span class=\"p\">)</span>\n        <span class=\"k\">else</span><span class=\"p\">:</span>\n            <span class=\"k\">return</span> HttpResponse<span class=\"p\">(</span><span class=\"s2\">&quot;Please enable cookies and try again.&quot;</span><span class=\"p\">)</span>\n    request<span class=\"o\">.</span>session<span class=\"o\">.</span>set_test_cookie<span class=\"p\">()</span>\n    <span class=\"k\">return</span> render<span class=\"p\">(</span>request<span class=\"p\">,</span> <span class=\"s2\">&quot;foo/login_form.html&quot;</span><span class=\"p\">)</span>\n</code></pre></div>\n</section>\n<section id=\"using-sessions-out-of-views\">\n<h2>Using sessions out of views<a class=\"heading-anchor\" href=\"#using-sessions-out-of-views\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h2>\n<aside class=\"admonition admonition-note\" role=\"note\">\n<p class=\"admonition-title\">Note</p>\n<p>The examples in this section import the <code class=\"docutils literal notranslate\">SessionStore</code> object directly\nfrom the <code class=\"docutils literal notranslate\">django.contrib.sessions.backends.db</code> backend. In your own code,\nyou should consider importing <code class=\"docutils literal notranslate\">SessionStore</code> from the session engine\ndesignated by <a class=\"reference internal\" href=\"/ga/6.1/ref/settings/#std-setting-SESSION_ENGINE\"><code class=\"xref std std-setting docutils literal notranslate\">SESSION_ENGINE</code></a>, as below:</p>\n<div class=\"code-block\" data-language=\"pycon\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Python console</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Python console code\"><code><span class=\"gp\">&gt;&gt;&gt; </span><span class=\"kn\">from</span> <span class=\"nn\">importlib</span> <span class=\"kn\">import</span> import_module\n<span class=\"gp\">&gt;&gt;&gt; </span><span class=\"kn\">from</span> <span class=\"nn\">django.conf</span> <span class=\"kn\">import</span> settings\n<span class=\"gp\">&gt;&gt;&gt; </span>SessionStore <span class=\"o\">=</span> import_module<span class=\"p\">(</span>settings<span class=\"o\">.</span>SESSION_ENGINE<span class=\"p\">)</span><span class=\"o\">.</span>SessionStore\n</code></pre></div>\n</aside>\n<p>An API is available to manipulate session data outside of a view:</p>\n<div class=\"code-block\" data-language=\"pycon\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Python console</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Python console code\"><code><span class=\"gp\">&gt;&gt;&gt; </span><span class=\"kn\">from</span> <span class=\"nn\">django.contrib.sessions.backends.db</span> <span class=\"kn\">import</span> SessionStore\n<span class=\"gp\">&gt;&gt;&gt; </span>s <span class=\"o\">=</span> SessionStore<span class=\"p\">()</span>\n<span class=\"gp\">&gt;&gt;&gt; </span><span class=\"c1\"># stored as seconds since epoch since datetimes are not serializable in JSON.</span>\n<span class=\"gp\">&gt;&gt;&gt; </span>s<span class=\"p\">[</span><span class=\"s2\">&quot;last_login&quot;</span><span class=\"p\">]</span> <span class=\"o\">=</span> <span class=\"mi\">1376587691</span>\n<span class=\"gp\">&gt;&gt;&gt; </span>s<span class=\"o\">.</span>create<span class=\"p\">()</span>\n<span class=\"gp\">&gt;&gt;&gt; </span>s<span class=\"o\">.</span>session_key\n<span class=\"go\">&#39;2b1189a188b44ad18c35e113ac6ceead&#39;</span>\n<span class=\"gp\">&gt;&gt;&gt; </span>s <span class=\"o\">=</span> SessionStore<span class=\"p\">(</span>session_key<span class=\"o\">=</span><span class=\"s2\">&quot;2b1189a188b44ad18c35e113ac6ceead&quot;</span><span class=\"p\">)</span>\n<span class=\"gp\">&gt;&gt;&gt; </span>s<span class=\"p\">[</span><span class=\"s2\">&quot;last_login&quot;</span><span class=\"p\">]</span>\n<span class=\"go\">1376587691</span>\n</code></pre></div>\n<p><code class=\"docutils literal notranslate\">SessionStore.create()</code> is designed to create a new session (i.e. one not\nloaded from the session store and with <code class=\"docutils literal notranslate\">session_key=None</code>). <code class=\"docutils literal notranslate\">save()</code> is\ndesigned to save an existing session (i.e. one loaded from the session store).\nCalling <code class=\"docutils literal notranslate\">save()</code> on a new session may also work but has a small chance of\ngenerating a <code class=\"docutils literal notranslate\">session_key</code> that collides with an existing one. <code class=\"docutils literal notranslate\">create()</code>\ncalls <code class=\"docutils literal notranslate\">save()</code> and loops until an unused <code class=\"docutils literal notranslate\">session_key</code> is generated.</p>\n<p>If you're using the <code class=\"docutils literal notranslate\">django.contrib.sessions.backends.db</code> backend, each\nsession is a normal Django model. The <code class=\"docutils literal notranslate\">Session</code> model is defined in\n<a class=\"extlink-source reference external\" href=\"https://github.com/django/django/blob/stable/6.1.x/django/contrib/sessions/models.py\">django/contrib/sessions/models.py</a>. Because it's a normal model, you\ncan access sessions using the normal Django database API:</p>\n<div class=\"code-block\" data-language=\"pycon\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Python console</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Python console code\"><code><span class=\"gp\">&gt;&gt;&gt; </span><span class=\"kn\">from</span> <span class=\"nn\">django.contrib.sessions.models</span> <span class=\"kn\">import</span> Session\n<span class=\"gp\">&gt;&gt;&gt; </span>s <span class=\"o\">=</span> Session<span class=\"o\">.</span>objects<span class=\"o\">.</span>get<span class=\"p\">(</span>pk<span class=\"o\">=</span><span class=\"s2\">&quot;2b1189a188b44ad18c35e113ac6ceead&quot;</span><span class=\"p\">)</span>\n<span class=\"gp\">&gt;&gt;&gt; </span>s<span class=\"o\">.</span>expire_date\n<span class=\"go\">datetime.datetime(2005, 8, 20, 13, 35, 12)</span>\n</code></pre></div>\n<p>Note that you'll need to call\n<a class=\"reference internal\" href=\"#django.contrib.sessions.base_session.AbstractBaseSession.get_decoded\" title=\"django.contrib.sessions.base_session.AbstractBaseSession.get_decoded\"><code class=\"xref py py-meth docutils literal notranslate\">get_decoded()</code></a> to get the session\ndictionary. This is necessary because the dictionary is stored in an encoded\nformat:</p>\n<div class=\"code-block\" data-language=\"pycon\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Python console</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Python console code\"><code><span class=\"gp\">&gt;&gt;&gt; </span>s<span class=\"o\">.</span>session_data\n<span class=\"go\">&#39;KGRwMQpTJ19hdXRoX3VzZXJfaWQnCnAyCkkxCnMuMTExY2ZjODI2Yj...&#39;</span>\n<span class=\"gp\">&gt;&gt;&gt; </span>s<span class=\"o\">.</span>get_decoded<span class=\"p\">()</span>\n<span class=\"go\">{&#39;user_id&#39;: 42}</span>\n</code></pre></div>\n</section>\n<section id=\"when-sessions-are-saved\">\n<h2>When sessions are saved<a class=\"heading-anchor\" href=\"#when-sessions-are-saved\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h2>\n<p>By default, Django only saves to the session database when the session has been\nmodified -- that is if any of its dictionary values have been assigned or\ndeleted:</p>\n<div class=\"code-block\" data-language=\"default\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Code</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Code code\"><code><span class=\"c1\"># Session is modified.</span>\nrequest<span class=\"o\">.</span>session<span class=\"p\">[</span><span class=\"s2\">&quot;foo&quot;</span><span class=\"p\">]</span> <span class=\"o\">=</span> <span class=\"s2\">&quot;bar&quot;</span>\n\n<span class=\"c1\"># Session is modified.</span>\n<span class=\"k\">del</span> request<span class=\"o\">.</span>session<span class=\"p\">[</span><span class=\"s2\">&quot;foo&quot;</span><span class=\"p\">]</span>\n\n<span class=\"c1\"># Session is modified.</span>\nrequest<span class=\"o\">.</span>session<span class=\"p\">[</span><span class=\"s2\">&quot;foo&quot;</span><span class=\"p\">]</span> <span class=\"o\">=</span> <span class=\"p\">{}</span>\n\n<span class=\"c1\"># Gotcha: Session is NOT modified, because this alters</span>\n<span class=\"c1\"># request.session[&#39;foo&#39;] instead of request.session.</span>\nrequest<span class=\"o\">.</span>session<span class=\"p\">[</span><span class=\"s2\">&quot;foo&quot;</span><span class=\"p\">][</span><span class=\"s2\">&quot;bar&quot;</span><span class=\"p\">]</span> <span class=\"o\">=</span> <span class=\"s2\">&quot;baz&quot;</span>\n</code></pre></div>\n<p>In the last case of the above example, we can tell the session object\nexplicitly that it has been modified by setting the <code class=\"docutils literal notranslate\">modified</code> attribute on\nthe session object:</p>\n<div class=\"code-block\" data-language=\"default\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Code</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Code code\"><code>request<span class=\"o\">.</span>session<span class=\"o\">.</span>modified <span class=\"o\">=</span> <span class=\"kc\">True</span>\n</code></pre></div>\n<p>To change this default behavior, set the <a class=\"reference internal\" href=\"/ga/6.1/ref/settings/#std-setting-SESSION_SAVE_EVERY_REQUEST\"><code class=\"xref std std-setting docutils literal notranslate\">SESSION_SAVE_EVERY_REQUEST</code></a>\nsetting to <code class=\"docutils literal notranslate\">True</code>. When set to <code class=\"docutils literal notranslate\">True</code>, Django will save the session to the\ndatabase on every single request.</p>\n<p>Note that the session cookie is only sent when a session has been created or\nmodified. If <a class=\"reference internal\" href=\"/ga/6.1/ref/settings/#std-setting-SESSION_SAVE_EVERY_REQUEST\"><code class=\"xref std std-setting docutils literal notranslate\">SESSION_SAVE_EVERY_REQUEST</code></a> is <code class=\"docutils literal notranslate\">True</code>, the session\ncookie will be sent on every request.</p>\n<p>Similarly, the <code class=\"docutils literal notranslate\">expires</code> part of a session cookie is updated each time the\nsession cookie is sent.</p>\n<p>The session is not saved if the response's status code is 500.</p>\n</section>\n<section id=\"browser-length-sessions-vs-persistent-sessions\">\n<span id=\"browser-length-vs-persistent-sessions\"></span><h2>Browser-length sessions vs. persistent sessions<a class=\"heading-anchor\" href=\"#browser-length-sessions-vs-persistent-sessions\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h2>\n<p>You can control whether the session framework uses browser-length sessions vs.\npersistent sessions with the <a class=\"reference internal\" href=\"/ga/6.1/ref/settings/#std-setting-SESSION_EXPIRE_AT_BROWSER_CLOSE\"><code class=\"xref std std-setting docutils literal notranslate\">SESSION_EXPIRE_AT_BROWSER_CLOSE</code></a>\nsetting.</p>\n<p>By default, <a class=\"reference internal\" href=\"/ga/6.1/ref/settings/#std-setting-SESSION_EXPIRE_AT_BROWSER_CLOSE\"><code class=\"xref std std-setting docutils literal notranslate\">SESSION_EXPIRE_AT_BROWSER_CLOSE</code></a> is set to <code class=\"docutils literal notranslate\">False</code>,\nwhich means session cookies will be stored in users' browsers for as long as\n<a class=\"reference internal\" href=\"/ga/6.1/ref/settings/#std-setting-SESSION_COOKIE_AGE\"><code class=\"xref std std-setting docutils literal notranslate\">SESSION_COOKIE_AGE</code></a>. Use this if you don't want people to have to\nlog in every time they open a browser.</p>\n<p>If <a class=\"reference internal\" href=\"/ga/6.1/ref/settings/#std-setting-SESSION_EXPIRE_AT_BROWSER_CLOSE\"><code class=\"xref std std-setting docutils literal notranslate\">SESSION_EXPIRE_AT_BROWSER_CLOSE</code></a> is set to <code class=\"docutils literal notranslate\">True</code>, Django will\nuse browser-length cookies -- cookies that expire as soon as the user closes\ntheir browser. Use this if you want people to have to log in every time they\nopen a browser.</p>\n<p>This setting is a global default and can be overwritten at a per-session level\nby explicitly calling the <a class=\"reference internal\" href=\"#django.contrib.sessions.backends.base.SessionBase.set_expiry\" title=\"django.contrib.sessions.backends.base.SessionBase.set_expiry\"><code class=\"xref py py-meth docutils literal notranslate\">set_expiry()</code></a> method\nof <code class=\"docutils literal notranslate\">request.session</code> as described above in <a class=\"reference internal\" href=\"#using-sessions-in-views\">using sessions in views</a>.</p>\n<aside class=\"admonition admonition-note\" role=\"note\">\n<p class=\"admonition-title\">Note</p>\n<p>Some browsers (Chrome, for example) provide settings that allow users to\ncontinue browsing sessions after closing and reopening the browser. In\nsome cases, this can interfere with the\n<a class=\"reference internal\" href=\"/ga/6.1/ref/settings/#std-setting-SESSION_EXPIRE_AT_BROWSER_CLOSE\"><code class=\"xref std std-setting docutils literal notranslate\">SESSION_EXPIRE_AT_BROWSER_CLOSE</code></a> setting and prevent sessions\nfrom expiring on browser close. Please be aware of this while testing\nDjango applications which have the\n<a class=\"reference internal\" href=\"/ga/6.1/ref/settings/#std-setting-SESSION_EXPIRE_AT_BROWSER_CLOSE\"><code class=\"xref std std-setting docutils literal notranslate\">SESSION_EXPIRE_AT_BROWSER_CLOSE</code></a> setting enabled.</p>\n</aside>\n</section>\n<section id=\"clearing-the-session-store\">\n<span id=\"id2\"></span><h2>Clearing the session store<a class=\"heading-anchor\" href=\"#clearing-the-session-store\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h2>\n<p>As users create new sessions on your website, session data can accumulate in\nyour session store. If you're using the database backend, the\n<code class=\"docutils literal notranslate\">django_session</code> database table will grow. If you're using the file backend,\nyour temporary directory will contain an increasing number of files.</p>\n<p>To understand this problem, consider what happens with the database backend.\nWhen a user logs in, Django adds a row to the <code class=\"docutils literal notranslate\">django_session</code> database\ntable. Django updates this row each time the session data changes. If the user\nlogs out manually, Django deletes the row. But if the user does <em>not</em> log out,\nthe row never gets deleted. A similar process happens with the file backend.</p>\n<p>Django does <em>not</em> provide automatic purging of expired sessions. Therefore,\nit's your job to purge expired sessions on a regular basis. Django provides a\nclean-up management command for this purpose: <a class=\"reference internal\" href=\"/ga/6.1/ref/django-admin/#django-admin-clearsessions\"><code class=\"xref std std-djadmin docutils literal notranslate\">clearsessions</code></a>. It's\nrecommended to call this command on a regular basis, for example as a daily\ncron job.</p>\n<p>Note that the cache backend isn't vulnerable to this problem, because caches\nautomatically delete stale data. Neither is the cookie backend, because the\nsession data is stored by the users' browsers.</p>\n</section>\n<section id=\"settings\">\n<h2>Socruithe<a class=\"heading-anchor\" href=\"#settings\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h2>\n<p>A few <a class=\"reference internal\" href=\"/ga/6.1/ref/settings/#settings-sessions\"><span class=\"std std-ref\">Django settings</span></a> give you control over session\nbehavior:</p>\n<ul class=\"simple\">\n<li><p><a class=\"reference internal\" href=\"/ga/6.1/ref/settings/#std-setting-SESSION_CACHE_ALIAS\"><code class=\"xref std std-setting docutils literal notranslate\">SESSION_CACHE_ALIAS</code></a></p></li>\n<li><p><a class=\"reference internal\" href=\"/ga/6.1/ref/settings/#std-setting-SESSION_COOKIE_AGE\"><code class=\"xref std std-setting docutils literal notranslate\">SESSION_COOKIE_AGE</code></a></p></li>\n<li><p><a class=\"reference internal\" href=\"/ga/6.1/ref/settings/#std-setting-SESSION_COOKIE_DOMAIN\"><code class=\"xref std std-setting docutils literal notranslate\">SESSION_COOKIE_DOMAIN</code></a></p></li>\n<li><p><a class=\"reference internal\" href=\"/ga/6.1/ref/settings/#std-setting-SESSION_COOKIE_HTTPONLY\"><code class=\"xref std std-setting docutils literal notranslate\">SESSION_COOKIE_HTTPONLY</code></a></p></li>\n<li><p><a class=\"reference internal\" href=\"/ga/6.1/ref/settings/#std-setting-SESSION_COOKIE_NAME\"><code class=\"xref std std-setting docutils literal notranslate\">SESSION_COOKIE_NAME</code></a></p></li>\n<li><p><a class=\"reference internal\" href=\"/ga/6.1/ref/settings/#std-setting-SESSION_COOKIE_PATH\"><code class=\"xref std std-setting docutils literal notranslate\">SESSION_COOKIE_PATH</code></a></p></li>\n<li><p><a class=\"reference internal\" href=\"/ga/6.1/ref/settings/#std-setting-SESSION_COOKIE_SAMESITE\"><code class=\"xref std std-setting docutils literal notranslate\">SESSION_COOKIE_SAMESITE</code></a></p></li>\n<li><p><a class=\"reference internal\" href=\"/ga/6.1/ref/settings/#std-setting-SESSION_COOKIE_SECURE\"><code class=\"xref std std-setting docutils literal notranslate\">SESSION_COOKIE_SECURE</code></a></p></li>\n<li><p><a class=\"reference internal\" href=\"/ga/6.1/ref/settings/#std-setting-SESSION_ENGINE\"><code class=\"xref std std-setting docutils literal notranslate\">SESSION_ENGINE</code></a></p></li>\n<li><p><a class=\"reference internal\" href=\"/ga/6.1/ref/settings/#std-setting-SESSION_EXPIRE_AT_BROWSER_CLOSE\"><code class=\"xref std std-setting docutils literal notranslate\">SESSION_EXPIRE_AT_BROWSER_CLOSE</code></a></p></li>\n<li><p><a class=\"reference internal\" href=\"/ga/6.1/ref/settings/#std-setting-SESSION_FILE_PATH\"><code class=\"xref std std-setting docutils literal notranslate\">SESSION_FILE_PATH</code></a></p></li>\n<li><p><a class=\"reference internal\" href=\"/ga/6.1/ref/settings/#std-setting-SESSION_SAVE_EVERY_REQUEST\"><code class=\"xref std std-setting docutils literal notranslate\">SESSION_SAVE_EVERY_REQUEST</code></a></p></li>\n<li><p><a class=\"reference internal\" href=\"/ga/6.1/ref/settings/#std-setting-SESSION_SERIALIZER\"><code class=\"xref std std-setting docutils literal notranslate\">SESSION_SERIALIZER</code></a></p></li>\n</ul>\n</section>\n<section id=\"session-security\">\n<span id=\"topics-session-security\"></span><h2>Session security<a class=\"heading-anchor\" href=\"#session-security\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h2>\n<p>Subdomains within a site are able to set cookies on the client for the whole\ndomain. This makes session fixation possible if cookies are permitted from\nsubdomains not controlled by trusted users.</p>\n<p>For example, an attacker could log into <code class=\"docutils literal notranslate\">good.example.com</code> and get a valid\nsession for their account. If the attacker has control over\n<code class=\"docutils literal notranslate\">bad.example.com</code>, they can use it to send their session key to you since a\nsubdomain is permitted to set cookies on <code class=\"docutils literal notranslate\">*.example.com</code>. When you visit\n<code class=\"docutils literal notranslate\">good.example.com</code>, you'll be logged in as the attacker and might\ninadvertently enter your sensitive personal data (e.g. credit card info) into\nthe attacker's account.</p>\n<p>Another possible attack would be if <code class=\"docutils literal notranslate\">good.example.com</code> sets its\n<a class=\"reference internal\" href=\"/ga/6.1/ref/settings/#std-setting-SESSION_COOKIE_DOMAIN\"><code class=\"xref std std-setting docutils literal notranslate\">SESSION_COOKIE_DOMAIN</code></a> to <code class=\"docutils literal notranslate\">&quot;example.com&quot;</code> which would cause\nsession cookies from that site to be sent to <code class=\"docutils literal notranslate\">bad.example.com</code>.</p>\n</section>\n<section id=\"technical-details\">\n<h2>Technical details<a class=\"heading-anchor\" href=\"#technical-details\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h2>\n<ul class=\"simple\">\n<li><p>The session dictionary accepts any <a class=\"reference external\" href=\"https://docs.python.org/3/library/json.html#module-json\" title=\"(in Python v3.14)\"><code class=\"xref py py-mod docutils literal notranslate\">json</code></a> serializable value when using\n<a class=\"reference internal\" href=\"#django.contrib.sessions.serializers.JSONSerializer\" title=\"django.contrib.sessions.serializers.JSONSerializer\"><code class=\"xref py py-class docutils literal notranslate\">JSONSerializer</code></a>.</p></li>\n<li><p>Session data is stored in a database table named <code class=\"docutils literal notranslate\">django_session</code> .</p></li>\n<li><p>Django only sends a cookie if it needs to. If you don't set any session\ndata, it won't send a session cookie.</p></li>\n</ul>\n<section id=\"the-sessionstore-object\">\n<h3>The <code class=\"docutils literal notranslate\">SessionStore</code> object<a class=\"heading-anchor\" href=\"#the-sessionstore-object\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h3>\n<p>When working with sessions internally, Django uses a session store object from\nthe corresponding session engine. By convention, the session store object class\nis named <code class=\"docutils literal notranslate\">SessionStore</code> and is located in the module designated by\n<a class=\"reference internal\" href=\"/ga/6.1/ref/settings/#std-setting-SESSION_ENGINE\"><code class=\"xref std std-setting docutils literal notranslate\">SESSION_ENGINE</code></a>.</p>\n<p>All <code class=\"docutils literal notranslate\">SessionStore</code> subclasses available in Django implement the following\ndata manipulation methods:</p>\n<ul class=\"simple\">\n<li><p><a href=\"#id1\"><span class=\"problematic\" id=\"id2\">``</span></a>ann () ``</p></li>\n<li><p><a href=\"#id1\"><span class=\"problematic\" id=\"id2\">``</span></a>cruthaigh () ``</p></li>\n<li><p><code class=\"docutils literal notranslate\">save()</code></p></li>\n<li><p><a href=\"#id1\"><span class=\"problematic\" id=\"id2\">``</span></a>scrios () ``</p></li>\n<li><p><code class=\"docutils literal notranslate\">load()</code></p></li>\n<li><p><a class=\"reference internal\" href=\"#django.contrib.sessions.backends.base.SessionBase.clear_expired\" title=\"django.contrib.sessions.backends.base.SessionBase.clear_expired\"><code class=\"xref py py-meth docutils literal notranslate\">clear_expired()</code></a></p></li>\n</ul>\n<p>An asynchronous interface for these methods is provided by wrapping them with\n<code class=\"docutils literal notranslate\">sync_to_async()</code>. They can be implemented directly if an async-native\nimplementation is available:</p>\n<ul class=\"simple\">\n<li><p><code class=\"docutils literal notranslate\">aexists()</code></p></li>\n<li><p><code class=\"docutils literal notranslate\">acreate()</code></p></li>\n<li><p><code class=\"docutils literal notranslate\">asave()</code></p></li>\n<li><p><code class=\"docutils literal notranslate\">adelete()</code></p></li>\n<li><p><code class=\"docutils literal notranslate\">aload()</code></p></li>\n<li><p><a class=\"reference internal\" href=\"#django.contrib.sessions.backends.base.SessionBase.aclear_expired\" title=\"django.contrib.sessions.backends.base.SessionBase.aclear_expired\"><code class=\"xref py py-meth docutils literal notranslate\">aclear_expired()</code></a></p></li>\n</ul>\n<p>In order to build a custom session engine or to customize an existing one, you\nmay create a new class inheriting from <a class=\"reference internal\" href=\"#django.contrib.sessions.backends.base.SessionBase\" title=\"django.contrib.sessions.backends.base.SessionBase\"><code class=\"xref py py-class docutils literal notranslate\">SessionBase</code></a> or\nany other existing <code class=\"docutils literal notranslate\">SessionStore</code> class.</p>\n<p>You can extend the session engines, but doing so with database-backed session\nengines generally requires some extra effort (see the next section for\ndetails).</p>\n</section>\n</section>\n<section id=\"extending-database-backed-session-engines\">\n<span id=\"id3\"></span><h2>Extending database-backed session engines<a class=\"heading-anchor\" href=\"#extending-database-backed-session-engines\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h2>\n<p>Creating a custom database-backed session engine built upon those included in\nDjango (namely <code class=\"docutils literal notranslate\">db</code> and <code class=\"docutils literal notranslate\">cached_db</code>) may be done by inheriting\n<a class=\"reference internal\" href=\"#django.contrib.sessions.base_session.AbstractBaseSession\" title=\"django.contrib.sessions.base_session.AbstractBaseSession\"><code class=\"xref py py-class docutils literal notranslate\">AbstractBaseSession</code></a> and either <code class=\"docutils literal notranslate\">SessionStore</code> class.</p>\n<p><code class=\"docutils literal notranslate\">AbstractBaseSession</code> and <code class=\"docutils literal notranslate\">BaseSessionManager</code> are importable from\n<code class=\"docutils literal notranslate\">django.contrib.sessions.base_session</code> so that they can be imported without\nincluding <code class=\"docutils literal notranslate\">django.contrib.sessions</code> in <a class=\"reference internal\" href=\"/ga/6.1/ref/settings/#std-setting-INSTALLED_APPS\"><code class=\"xref std std-setting docutils literal notranslate\">INSTALLED_APPS</code></a>.</p>\n<dl class=\"py class\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.base_session.AbstractBaseSession\">\n<em class=\"property\"><span class=\"k\">class</span> </em><span class=\"sig-prename descclassname\">base_session.</span><span class=\"sig-name descname\">AbstractBaseSession</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.base_session.AbstractBaseSession\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p>The abstract base session model.</p>\n<dl class=\"py attribute\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.base_session.AbstractBaseSession.session_key\">\n<span class=\"sig-name descname\">session_key</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.base_session.AbstractBaseSession.session_key\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p>Primary key. The field itself may contain up to 40 characters. The\ncurrent implementation generates a 32-character string (a random\nsequence of digits and lowercase ASCII letters).</p>\n</dd></dl>\n\n<dl class=\"py attribute\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.base_session.AbstractBaseSession.session_data\">\n<span class=\"sig-name descname\">session_data</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.base_session.AbstractBaseSession.session_data\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p>A string containing an encoded and serialized session dictionary.</p>\n</dd></dl>\n\n<dl class=\"py attribute\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.base_session.AbstractBaseSession.expire_date\">\n<span class=\"sig-name descname\">expire_date</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.base_session.AbstractBaseSession.expire_date\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p>A datetime designating when the session expires.</p>\n<p>Expired sessions are not available to a user, however, they may still\nbe stored in the database until the <a class=\"reference internal\" href=\"/ga/6.1/ref/django-admin/#django-admin-clearsessions\"><code class=\"xref std std-djadmin docutils literal notranslate\">clearsessions</code></a> management\ncommand is run.</p>\n</dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.base_session.AbstractBaseSession.get_session_store_class\">\n<em class=\"property\"><span class=\"k\">classmethod</span> </em><span class=\"sig-name descname\">get_session_store_class</span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.base_session.AbstractBaseSession.get_session_store_class\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p>Returns a session store class to be used with this session model.</p>\n</dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.base_session.AbstractBaseSession.get_decoded\">\n<span class=\"sig-name descname\">get_decoded</span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.base_session.AbstractBaseSession.get_decoded\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p>Returns decoded session data.</p>\n<p>Decoding is performed by the session store class.</p>\n</dd></dl>\n\n</dd></dl>\n\n<p>You can also customize the model manager by subclassing\n<a class=\"reference internal\" href=\"#django.contrib.sessions.base_session.BaseSessionManager\" title=\"django.contrib.sessions.base_session.BaseSessionManager\"><code class=\"xref py py-class docutils literal notranslate\">BaseSessionManager</code></a>:</p>\n<dl class=\"py class\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.base_session.BaseSessionManager\">\n<em class=\"property\"><span class=\"k\">class</span> </em><span class=\"sig-prename descclassname\">base_session.</span><span class=\"sig-name descname\">BaseSessionManager</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.base_session.BaseSessionManager\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.base_session.BaseSessionManager.encode\">\n<span class=\"sig-name descname\">encode</span><span class=\"sig-paren\">(</span><em class=\"sig-param\">session_dict</em><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.base_session.BaseSessionManager.encode\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p>Returns the given session dictionary serialized and encoded as a\nstring.</p>\n<p>Encoding is performed by the session store class tied to a model class.</p>\n</dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.base_session.BaseSessionManager.save\">\n<span class=\"sig-name descname\">save</span><span class=\"sig-paren\">(</span><em class=\"sig-param\">session_key</em>, <em class=\"sig-param\">session_dict</em>, <em class=\"sig-param\">expire_date</em><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.base_session.BaseSessionManager.save\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p>Saves session data for a provided session key, or deletes the session\nin case the data is empty.</p>\n</dd></dl>\n\n</dd></dl>\n\n<p>Customization of <code class=\"docutils literal notranslate\">SessionStore</code> classes is achieved by overriding methods\nand properties described below:</p>\n<dl class=\"py class\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.db.SessionStore\">\n<em class=\"property\"><span class=\"k\">class</span> </em><span class=\"sig-prename descclassname\">backends.db.</span><span class=\"sig-name descname\">SessionStore</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.db.SessionStore\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p>Implements database-backed session store.</p>\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.db.SessionStore.get_model_class\">\n<em class=\"property\"><span class=\"k\">classmethod</span> </em><span class=\"sig-name descname\">get_model_class</span><span class=\"sig-paren\">(</span><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.db.SessionStore.get_model_class\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p>Override this method to return a custom session model if you need one.</p>\n</dd></dl>\n\n<dl class=\"py method\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.db.SessionStore.create_model_instance\">\n<span class=\"sig-name descname\">create_model_instance</span><span class=\"sig-paren\">(</span><em class=\"sig-param\">data</em><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.db.SessionStore.create_model_instance\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p>Returns a new instance of the session model object, which represents\nthe current session state.</p>\n<p>Overriding this method provides the ability to modify session model\ndata before it's saved to database.</p>\n</dd></dl>\n\n</dd></dl>\n\n<dl class=\"py class\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.cached_db.SessionStore\">\n<em class=\"property\"><span class=\"k\">class</span> </em><span class=\"sig-prename descclassname\">backends.cached_db.</span><span class=\"sig-name descname\">SessionStore</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.cached_db.SessionStore\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p>Implements cached database-backed session store.</p>\n<dl class=\"py attribute\">\n<dt class=\"sig sig-object py\" id=\"django.contrib.sessions.backends.cached_db.SessionStore.cache_key_prefix\">\n<span class=\"sig-name descname\">cache_key_prefix</span><a class=\"heading-anchor\" href=\"#django.contrib.sessions.backends.cached_db.SessionStore.cache_key_prefix\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd><p>A prefix added to a session key to build a cache key string.</p>\n</dd></dl>\n\n</dd></dl>\n\n<section id=\"example\">\n<h3>Sampla<a class=\"heading-anchor\" href=\"#example\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h3>\n<p>The example below shows a custom database-backed session engine that includes\nan additional database column to store an account ID (thus providing an option\nto query the database for all active sessions for an account):</p>\n<div class=\"code-block\" data-language=\"default\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Code</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Code code\"><code><span class=\"kn\">from</span> <span class=\"nn\">django.contrib.sessions.backends.db</span> <span class=\"kn\">import</span> SessionStore <span class=\"k\">as</span> DBStore\n<span class=\"kn\">from</span> <span class=\"nn\">django.contrib.sessions.base_session</span> <span class=\"kn\">import</span> AbstractBaseSession\n<span class=\"kn\">from</span> <span class=\"nn\">django.db</span> <span class=\"kn\">import</span> models\n\n\n<span class=\"k\">class</span> <span class=\"nc\">CustomSession</span><span class=\"p\">(</span>AbstractBaseSession<span class=\"p\">):</span>\n    account_id <span class=\"o\">=</span> models<span class=\"o\">.</span>IntegerField<span class=\"p\">(</span>null<span class=\"o\">=</span><span class=\"kc\">True</span><span class=\"p\">,</span> db_index<span class=\"o\">=</span><span class=\"kc\">True</span><span class=\"p\">)</span>\n\n    <span class=\"nd\">@classmethod</span>\n    <span class=\"k\">def</span> <span class=\"nf\">get_session_store_class</span><span class=\"p\">(</span><span class=\"bp\">cls</span><span class=\"p\">):</span>\n        <span class=\"k\">return</span> SessionStore\n\n\n<span class=\"k\">class</span> <span class=\"nc\">SessionStore</span><span class=\"p\">(</span>DBStore<span class=\"p\">):</span>\n    <span class=\"nd\">@classmethod</span>\n    <span class=\"k\">def</span> <span class=\"nf\">get_model_class</span><span class=\"p\">(</span><span class=\"bp\">cls</span><span class=\"p\">):</span>\n        <span class=\"k\">return</span> CustomSession\n\n    <span class=\"k\">def</span> <span class=\"nf\">create_model_instance</span><span class=\"p\">(</span><span class=\"bp\">self</span><span class=\"p\">,</span> data<span class=\"p\">):</span>\n        obj <span class=\"o\">=</span> <span class=\"nb\">super</span><span class=\"p\">()</span><span class=\"o\">.</span>create_model_instance<span class=\"p\">(</span>data<span class=\"p\">)</span>\n        <span class=\"k\">try</span><span class=\"p\">:</span>\n            account_id <span class=\"o\">=</span> <span class=\"nb\">int</span><span class=\"p\">(</span>data<span class=\"o\">.</span>get<span class=\"p\">(</span><span class=\"s2\">&quot;_auth_user_id&quot;</span><span class=\"p\">))</span>\n        <span class=\"k\">except</span> <span class=\"p\">(</span><span class=\"ne\">ValueError</span><span class=\"p\">,</span> <span class=\"ne\">TypeError</span><span class=\"p\">):</span>\n            account_id <span class=\"o\">=</span> <span class=\"kc\">None</span>\n        obj<span class=\"o\">.</span>account_id <span class=\"o\">=</span> account_id\n        <span class=\"k\">return</span> obj\n</code></pre></div>\n<p>If you are migrating from the Django's built-in <code class=\"docutils literal notranslate\">cached_db</code> session store to\na custom one based on <code class=\"docutils literal notranslate\">cached_db</code>, you should override the cache key prefix\nin order to prevent a namespace clash:</p>\n<div class=\"code-block\" data-language=\"default\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Code</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Code code\"><code><span class=\"k\">class</span> <span class=\"nc\">SessionStore</span><span class=\"p\">(</span>CachedDBStore<span class=\"p\">):</span>\n    cache_key_prefix <span class=\"o\">=</span> <span class=\"s2\">&quot;mysessions.custom_cached_db_backend&quot;</span>\n\n    <span class=\"c1\"># ...</span>\n</code></pre></div>\n</section>\n</section>\n<section id=\"session-ids-in-urls\">\n<h2>Session IDs in URLs<a class=\"heading-anchor\" href=\"#session-ids-in-urls\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h2>\n<p>The Django sessions framework is entirely, and solely, cookie-based. It does\nnot fall back to putting session IDs in URLs as a last resort, as PHP does.\nThis is an intentional design decision. Not only does that behavior make URLs\nugly, it makes your site vulnerable to session-ID theft via the &quot;Referer&quot;\nheader.</p>\n</section>","rootId":"module-django.contrib.sessions","toc":[{"title":"Seisiúin chumasaithe","anchor":"enabling-sessions","children":[]},{"title":"Inneall an seisiúin a chumrú","anchor":"configuring-the-session-engine","children":[{"title":"Ag baint úsáide as seisiúin tacaithe","anchor":"using-database-backed-sessions","children":[]},{"title":"Seisiúin taisceáilte a úsáid","anchor":"using-cached-sessions","children":[]},{"title":"Ag baint úsáide as seisiúin comhad","anchor":"using-file-based-sessions","children":[]},{"title":"Seisiúin bunaithe ar fhianán a úsáid","anchor":"using-cookie-based-sessions","children":[]}]},{"title":"Seisiúin a úsáid i radhairc","anchor":"using-sessions-in-views","children":[{"title":"Session serialization","anchor":"session-serialization","children":[{"title":"Bundled serializers","anchor":"bundled-serializers","children":[]},{"title":"Write your own serializer","anchor":"write-your-own-serializer","children":[]}]},{"title":"Session object guidelines","anchor":"session-object-guidelines","children":[]},{"title":"Samplaí","anchor":"examples","children":[]}]},{"title":"Setting test cookies","anchor":"setting-test-cookies","children":[]},{"title":"Using sessions out of views","anchor":"using-sessions-out-of-views","children":[]},{"title":"When sessions are saved","anchor":"when-sessions-are-saved","children":[]},{"title":"Browser-length sessions vs. persistent sessions","anchor":"browser-length-sessions-vs-persistent-sessions","children":[]},{"title":"Clearing the session store","anchor":"clearing-the-session-store","children":[]},{"title":"Socruithe","anchor":"settings","children":[]},{"title":"Session security","anchor":"session-security","children":[]},{"title":"Technical details","anchor":"technical-details","children":[{"title":"The SessionStore object","anchor":"the-sessionstore-object","children":[]}]},{"title":"Extending database-backed session engines","anchor":"extending-database-backed-session-engines","children":[{"title":"Sampla","anchor":"example","children":[]}]},{"title":"Session IDs in URLs","anchor":"session-ids-in-urls","children":[]}],"breadcrumbs":[{"docname":"topics/index","title":"Using Django","url":"/ga/6.1/topics/"},{"docname":"topics/http/index","title":"Láimhseáil iarratais HTTP","url":"/ga/6.1/topics/http/"}],"prev":{"docname":"topics/http/middleware","title":"Meán-earraí","url":"/ga/6.1/topics/http/middleware/"},"next":{"docname":"topics/forms/index","title":"Ag obair le foirmeacha","url":"/ga/6.1/topics/forms/"},"formats":{"html":"/ga/6.1/topics/http/sessions/","markdown":"/ga/6.1/topics/http/sessions.md","json":"/ga/6.1/topics/http/sessions.json"},"source":"https://github.com/django/django/blob/stable/6.1.x/docs/topics/http/sessions.txt","official":"https://docs.djangoproject.com/ga/6.1/topics/http/sessions/","inVersions":["6.1","6.0","5.2"],"inLocales":["en","sv","zh-hans","ga","fr","ja","id","it","pt-br","ko","es","el","pl"]}