Главная Обзор Помощь
Вход
chendeben
/
ProxyPool
1
0
Ответвить 0
Файлы Задачи 0 Запросы на слияние 0 Вики
Дерево: 72e024a6fc
Ветки Метки
ProxyPool
/
docs
/
_build
/
html
/
_modules
/
flask
/
sessions.html

sessions.html 48 KB
История Исходник

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    2. 

  2.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3. 

  3. 

  4. 

  5. <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
    6. 

  6.   <head>
    7. 

  7.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    8. 

  8.     
    9. 

  9.     <title>flask.sessions &#8212; proxypool  documentation</title>
    10. 

  10.     
    11. 

  11.     <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
    12. 

  12.     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
    13. 

  13.     
    14. 

  14.     <script type="text/javascript">
    15. 

  15.       var DOCUMENTATION_OPTIONS = {
    16. 

  16.         URL_ROOT:    '../../',
    17. 

  17.         VERSION:     '',
    18. 

  18.         COLLAPSE_INDEX: false,
    19. 

  19.         FILE_SUFFIX: '.html',
    20. 

  20.         HAS_SOURCE:  true
    21. 

  21.       };
    22. 

  22.     </script>
    23. 

  23.     <script type="text/javascript" src="../../_static/jquery.js"></script>
    24. 

  24.     <script type="text/javascript" src="../../_static/underscore.js"></script>
    25. 

  25.     <script type="text/javascript" src="../../_static/doctools.js"></script>
    26. 

  26.     <link rel="index" title="Index" href="../../genindex.html" />
    27. 

  27.     <link rel="search" title="Search" href="../../search.html" />
    28. 

  28.     <link rel="top" title="proxypool  documentation" href="../../index.html" />
    29. 

  29.     <link rel="up" title="Module code" href="../index.html" />
    30. 

  30.    
    31. 

  31.   <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
    32. 

  32.   
    33. 

  33.   
    34. 

  34.   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
    35. 

  35. 

  36.   </head>
    37. 

  37.   <body role="document">
    38. 

  38.   
    39. 

  39. 

  40.     <div class="document">
    41. 

  41.       <div class="documentwrapper">
    42. 

  42.         <div class="bodywrapper">
    43. 

  43.           <div class="body" role="main">
    44. 

  44.             
    45. 

  45.   <h1>Source code for flask.sessions</h1><div class="highlight"><pre>
    46. 

  46. <span></span><span class="c1"># -*- coding: utf-8 -*-</span>
    47. 

  47. <span class="sd">&quot;&quot;&quot;</span>
    48. 

  48. <span class="sd">    flask.sessions</span>
    49. 

  49. <span class="sd">    ~~~~~~~~~~~~~~</span>
    50. 

  50. 

  51. <span class="sd">    Implements cookie based sessions based on itsdangerous.</span>
    52. 

  52. 

  53. <span class="sd">    :copyright: (c) 2015 by Armin Ronacher.</span>
    54. 

  54. <span class="sd">    :license: BSD, see LICENSE for more details.</span>
    55. 

  55. <span class="sd">&quot;&quot;&quot;</span>
    56. 

  56. 

  57. <span class="kn">import</span> <span class="nn">uuid</span>
    58. 

  58. <span class="kn">import</span> <span class="nn">hashlib</span>
    59. 

  59. <span class="kn">from</span> <span class="nn">base64</span> <span class="k">import</span> <span class="n">b64encode</span><span class="p">,</span> <span class="n">b64decode</span>
    60. 

  60. <span class="kn">from</span> <span class="nn">datetime</span> <span class="k">import</span> <span class="n">datetime</span>
    61. 

  61. <span class="kn">from</span> <span class="nn">werkzeug.http</span> <span class="k">import</span> <span class="n">http_date</span><span class="p">,</span> <span class="n">parse_date</span>
    62. 

  62. <span class="kn">from</span> <span class="nn">werkzeug.datastructures</span> <span class="k">import</span> <span class="n">CallbackDict</span>
    63. 

  63. <span class="kn">from</span> <span class="nn">.</span> <span class="k">import</span> <span class="n">Markup</span><span class="p">,</span> <span class="n">json</span>
    64. 

  64. <span class="kn">from</span> <span class="nn">._compat</span> <span class="k">import</span> <span class="n">iteritems</span><span class="p">,</span> <span class="n">text_type</span>
    65. 

  65. <span class="kn">from</span> <span class="nn">.helpers</span> <span class="k">import</span> <span class="n">total_seconds</span>
    66. 

  66. 

  67. <span class="kn">from</span> <span class="nn">itsdangerous</span> <span class="k">import</span> <span class="n">URLSafeTimedSerializer</span><span class="p">,</span> <span class="n">BadSignature</span>
    68. 

  68. 

  69. 

  70. <div class="viewcode-block" id="SessionMixin"><a class="viewcode-back" href="../../flask/flask.html#flask.app.SessionMixin">[docs]</a><span class="k">class</span> <span class="nc">SessionMixin</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
    71. 

  71.     <span class="sd">&quot;&quot;&quot;Expands a basic dictionary with an accessors that are expected</span>
    72. 

  72. <span class="sd">    by Flask extensions and users for the session.</span>
    73. 

  73. <span class="sd">    &quot;&quot;&quot;</span>
    74. 

  74. 

  75.     <span class="k">def</span> <span class="nf">_get_permanent</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    76. 

  76.         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;_permanent&#39;</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
    77. 

  77. 

  78.     <span class="k">def</span> <span class="nf">_set_permanent</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
    79. 

  79.         <span class="bp">self</span><span class="p">[</span><span class="s1">&#39;_permanent&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="nb">bool</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
    80. 

  80. 

  81.     <span class="c1">#: this reflects the ``&#39;_permanent&#39;`` key in the dict.</span>
    82. 

  82.     <span class="n">permanent</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">_get_permanent</span><span class="p">,</span> <span class="n">_set_permanent</span><span class="p">)</span>
    83. 

  83.     <span class="k">del</span> <span class="n">_get_permanent</span><span class="p">,</span> <span class="n">_set_permanent</span>
    84. 

  84. 

  85.     <span class="c1">#: some session backends can tell you if a session is new, but that is</span>
    86. 

  86.     <span class="c1">#: not necessarily guaranteed.  Use with caution.  The default mixin</span>
    87. 

  87.     <span class="c1">#: implementation just hardcodes ``False`` in.</span>
    88. 

  88.     <span class="n">new</span> <span class="o">=</span> <span class="kc">False</span>
    89. 

  89. 

  90.     <span class="c1">#: for some backends this will always be ``True``, but some backends will</span>
    91. 

  91.     <span class="c1">#: default this to false and detect changes in the dictionary for as</span>
    92. 

  92.     <span class="c1">#: long as changes do not happen on mutable structures in the session.</span>
    93. 

  93.     <span class="c1">#: The default mixin implementation just hardcodes ``True`` in.</span>
    94. 

  94.     <span class="n">modified</span> <span class="o">=</span> <span class="kc">True</span></div>
    95. 

  95. 

  96. 

  97. <span class="k">def</span> <span class="nf">_tag</span><span class="p">(</span><span class="n">value</span><span class="p">):</span>
    98. 

  98.     <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">):</span>
    99. 

  99.         <span class="k">return</span> <span class="p">{</span><span class="s1">&#39; t&#39;</span><span class="p">:</span> <span class="p">[</span><span class="n">_tag</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">value</span><span class="p">]}</span>
    100. 

  100.     <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">uuid</span><span class="o">.</span><span class="n">UUID</span><span class="p">):</span>
    101. 

  101.         <span class="k">return</span> <span class="p">{</span><span class="s1">&#39; u&#39;</span><span class="p">:</span> <span class="n">value</span><span class="o">.</span><span class="n">hex</span><span class="p">}</span>
    102. 

  102.     <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">):</span>
    103. 

  103.         <span class="k">return</span> <span class="p">{</span><span class="s1">&#39; b&#39;</span><span class="p">:</span> <span class="n">b64encode</span><span class="p">(</span><span class="n">value</span><span class="p">)</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">&#39;ascii&#39;</span><span class="p">)}</span>
    104. 

  104.     <span class="k">elif</span> <span class="n">callable</span><span class="p">(</span><span class="nb">getattr</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="s1">&#39;__html__&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)):</span>
    105. 

  105.         <span class="k">return</span> <span class="p">{</span><span class="s1">&#39; m&#39;</span><span class="p">:</span> <span class="n">text_type</span><span class="p">(</span><span class="n">value</span><span class="o">.</span><span class="n">__html__</span><span class="p">())}</span>
    106. 

  106.     <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
    107. 

  107.         <span class="k">return</span> <span class="p">[</span><span class="n">_tag</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">value</span><span class="p">]</span>
    108. 

  108.     <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">datetime</span><span class="p">):</span>
    109. 

  109.         <span class="k">return</span> <span class="p">{</span><span class="s1">&#39; d&#39;</span><span class="p">:</span> <span class="n">http_date</span><span class="p">(</span><span class="n">value</span><span class="p">)}</span>
    110. 

  110.     <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
    111. 

  111.         <span class="k">return</span> <span class="nb">dict</span><span class="p">((</span><span class="n">k</span><span class="p">,</span> <span class="n">_tag</span><span class="p">(</span><span class="n">v</span><span class="p">))</span> <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">iteritems</span><span class="p">(</span><span class="n">value</span><span class="p">))</span>
    112. 

  112.     <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
    113. 

  113.         <span class="k">try</span><span class="p">:</span>
    114. 

  114.             <span class="k">return</span> <span class="n">text_type</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
    115. 

  115.         <span class="k">except</span> <span class="ne">UnicodeError</span><span class="p">:</span>
    116. 

  116.             <span class="kn">from</span> <span class="nn">flask.debughelpers</span> <span class="k">import</span> <span class="n">UnexpectedUnicodeError</span>
    117. 

  117.             <span class="k">raise</span> <span class="n">UnexpectedUnicodeError</span><span class="p">(</span><span class="s1">u&#39;A byte string with &#39;</span>
    118. 

  118.                 <span class="s1">u&#39;non-ASCII data was passed to the session system &#39;</span>
    119. 

  119.                 <span class="s1">u&#39;which can only store unicode strings.  Consider &#39;</span>
    120. 

  120.                 <span class="s1">u&#39;base64 encoding your string (String was </span><span class="si">%r</span><span class="s1">)&#39;</span> <span class="o">%</span> <span class="n">value</span><span class="p">)</span>
    121. 

  121.     <span class="k">return</span> <span class="n">value</span>
    122. 

  122. 

  123. 

  124. <div class="viewcode-block" id="TaggedJSONSerializer"><a class="viewcode-back" href="../../flask/flask.html#flask.app.TaggedJSONSerializer">[docs]</a><span class="k">class</span> <span class="nc">TaggedJSONSerializer</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
    125. 

  125.     <span class="sd">&quot;&quot;&quot;A customized JSON serializer that supports a few extra types that</span>
    126. 

  126. <span class="sd">    we take for granted when serializing (tuples, markup objects, datetime).</span>
    127. 

  127. <span class="sd">    &quot;&quot;&quot;</span>
    128. 

  128. 

  129. <div class="viewcode-block" id="TaggedJSONSerializer.dumps"><a class="viewcode-back" href="../../flask/flask.html#flask.app.TaggedJSONSerializer.dumps">[docs]</a>    <span class="k">def</span> <span class="nf">dumps</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
    130. 

  130.         <span class="k">return</span> <span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">_tag</span><span class="p">(</span><span class="n">value</span><span class="p">),</span> <span class="n">separators</span><span class="o">=</span><span class="p">(</span><span class="s1">&#39;,&#39;</span><span class="p">,</span> <span class="s1">&#39;:&#39;</span><span class="p">))</span></div>
    131. 

  131. 

  132. <div class="viewcode-block" id="TaggedJSONSerializer.loads"><a class="viewcode-back" href="../../flask/flask.html#flask.app.TaggedJSONSerializer.loads">[docs]</a>    <span class="k">def</span> <span class="nf">loads</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
    133. 

  133.         <span class="k">def</span> <span class="nf">object_hook</span><span class="p">(</span><span class="n">obj</span><span class="p">):</span>
    134. 

  134.             <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">1</span><span class="p">:</span>
    135. 

  135.                 <span class="k">return</span> <span class="n">obj</span>
    136. 

  136.             <span class="n">the_key</span><span class="p">,</span> <span class="n">the_value</span> <span class="o">=</span> <span class="nb">next</span><span class="p">(</span><span class="n">iteritems</span><span class="p">(</span><span class="n">obj</span><span class="p">))</span>
    137. 

  137.             <span class="k">if</span> <span class="n">the_key</span> <span class="o">==</span> <span class="s1">&#39; t&#39;</span><span class="p">:</span>
    138. 

  138.                 <span class="k">return</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">the_value</span><span class="p">)</span>
    139. 

  139.             <span class="k">elif</span> <span class="n">the_key</span> <span class="o">==</span> <span class="s1">&#39; u&#39;</span><span class="p">:</span>
    140. 

  140.                 <span class="k">return</span> <span class="n">uuid</span><span class="o">.</span><span class="n">UUID</span><span class="p">(</span><span class="n">the_value</span><span class="p">)</span>
    141. 

  141.             <span class="k">elif</span> <span class="n">the_key</span> <span class="o">==</span> <span class="s1">&#39; b&#39;</span><span class="p">:</span>
    142. 

  142.                 <span class="k">return</span> <span class="n">b64decode</span><span class="p">(</span><span class="n">the_value</span><span class="p">)</span>
    143. 

  143.             <span class="k">elif</span> <span class="n">the_key</span> <span class="o">==</span> <span class="s1">&#39; m&#39;</span><span class="p">:</span>
    144. 

  144.                 <span class="k">return</span> <span class="n">Markup</span><span class="p">(</span><span class="n">the_value</span><span class="p">)</span>
    145. 

  145.             <span class="k">elif</span> <span class="n">the_key</span> <span class="o">==</span> <span class="s1">&#39; d&#39;</span><span class="p">:</span>
    146. 

  146.                 <span class="k">return</span> <span class="n">parse_date</span><span class="p">(</span><span class="n">the_value</span><span class="p">)</span>
    147. 

  147.             <span class="k">return</span> <span class="n">obj</span>
    148. 

  148.         <span class="k">return</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">object_hook</span><span class="o">=</span><span class="n">object_hook</span><span class="p">)</span></div></div>
    149. 

  149. 

  150. 

  151. <span class="n">session_json_serializer</span> <span class="o">=</span> <span class="n">TaggedJSONSerializer</span><span class="p">()</span>
    152. 

  152. 

  153. 

  154. <div class="viewcode-block" id="SecureCookieSession"><a class="viewcode-back" href="../../flask/flask.html#flask.app.SecureCookieSession">[docs]</a><span class="k">class</span> <span class="nc">SecureCookieSession</span><span class="p">(</span><span class="n">CallbackDict</span><span class="p">,</span> <span class="n">SessionMixin</span><span class="p">):</span>
    155. 

  155.     <span class="sd">&quot;&quot;&quot;Base class for sessions based on signed cookies.&quot;&quot;&quot;</span>
    156. 

  156. 

  157.     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">initial</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    158. 

  158.         <span class="k">def</span> <span class="nf">on_update</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    159. 

  159.             <span class="bp">self</span><span class="o">.</span><span class="n">modified</span> <span class="o">=</span> <span class="kc">True</span>
    160. 

  160.         <span class="n">CallbackDict</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">initial</span><span class="p">,</span> <span class="n">on_update</span><span class="p">)</span>
    161. 

  161.         <span class="bp">self</span><span class="o">.</span><span class="n">modified</span> <span class="o">=</span> <span class="kc">False</span></div>
    162. 

  162. 

  163. 

  164. <div class="viewcode-block" id="NullSession"><a class="viewcode-back" href="../../flask/flask.html#flask.app.NullSession">[docs]</a><span class="k">class</span> <span class="nc">NullSession</span><span class="p">(</span><span class="n">SecureCookieSession</span><span class="p">):</span>
    165. 

  165.     <span class="sd">&quot;&quot;&quot;Class used to generate nicer error messages if sessions are not</span>
    166. 

  166. <span class="sd">    available.  Will still allow read-only access to the empty session</span>
    167. 

  167. <span class="sd">    but fail on setting.</span>
    168. 

  168. <span class="sd">    &quot;&quot;&quot;</span>
    169. 

  169. 

  170.     <span class="k">def</span> <span class="nf">_fail</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
    171. 

  171.         <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s1">&#39;The session is unavailable because no secret &#39;</span>
    172. 

  172.                            <span class="s1">&#39;key was set.  Set the secret_key on the &#39;</span>
    173. 

  173.                            <span class="s1">&#39;application to something unique and secret.&#39;</span><span class="p">)</span>
    174. 

  174.     <span class="n">__setitem__</span> <span class="o">=</span> <span class="n">__delitem__</span> <span class="o">=</span> <span class="n">clear</span> <span class="o">=</span> <span class="n">pop</span> <span class="o">=</span> <span class="n">popitem</span> <span class="o">=</span> \
    175. 

  175.         <span class="n">update</span> <span class="o">=</span> <span class="n">setdefault</span> <span class="o">=</span> <span class="n">_fail</span>
    176. 

  176.     <span class="k">del</span> <span class="n">_fail</span></div>
    177. 

  177. 

  178. 

  179. <div class="viewcode-block" id="SessionInterface"><a class="viewcode-back" href="../../flask/flask.html#flask.app.SessionInterface">[docs]</a><span class="k">class</span> <span class="nc">SessionInterface</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
    180. 

  180.     <span class="sd">&quot;&quot;&quot;The basic interface you have to implement in order to replace the</span>
    181. 

  181. <span class="sd">    default session interface which uses werkzeug&#39;s securecookie</span>
    182. 

  182. <span class="sd">    implementation.  The only methods you have to implement are</span>
    183. 

  183. <span class="sd">    :meth:`open_session` and :meth:`save_session`, the others have</span>
    184. 

  184. <span class="sd">    useful defaults which you don&#39;t need to change.</span>
    185. 

  185. 

  186. <span class="sd">    The session object returned by the :meth:`open_session` method has to</span>
    187. 

  187. <span class="sd">    provide a dictionary like interface plus the properties and methods</span>
    188. 

  188. <span class="sd">    from the :class:`SessionMixin`.  We recommend just subclassing a dict</span>
    189. 

  189. <span class="sd">    and adding that mixin::</span>
    190. 

  190. 

  191. <span class="sd">        class Session(dict, SessionMixin):</span>
    192. 

  192. <span class="sd">            pass</span>
    193. 

  193. 

  194. <span class="sd">    If :meth:`open_session` returns ``None`` Flask will call into</span>
    195. 

  195. <span class="sd">    :meth:`make_null_session` to create a session that acts as replacement</span>
    196. 

  196. <span class="sd">    if the session support cannot work because some requirement is not</span>
    197. 

  197. <span class="sd">    fulfilled.  The default :class:`NullSession` class that is created</span>
    198. 

  198. <span class="sd">    will complain that the secret key was not set.</span>
    199. 

  199. 

  200. <span class="sd">    To replace the session interface on an application all you have to do</span>
    201. 

  201. <span class="sd">    is to assign :attr:`flask.Flask.session_interface`::</span>
    202. 

  202. 

  203. <span class="sd">        app = Flask(__name__)</span>
    204. 

  204. <span class="sd">        app.session_interface = MySessionInterface()</span>
    205. 

  205. 

  206. <span class="sd">    .. versionadded:: 0.8</span>
    207. 

  207. <span class="sd">    &quot;&quot;&quot;</span>
    208. 

  208. 

  209.     <span class="c1">#: :meth:`make_null_session` will look here for the class that should</span>
    210. 

  210.     <span class="c1">#: be created when a null session is requested.  Likewise the</span>
    211. 

  211.     <span class="c1">#: :meth:`is_null_session` method will perform a typecheck against</span>
    212. 

  212.     <span class="c1">#: this type.</span>
    213. 

  213.     <span class="n">null_session_class</span> <span class="o">=</span> <span class="n">NullSession</span>
    214. 

  214. 

  215.     <span class="c1">#: A flag that indicates if the session interface is pickle based.</span>
    216. 

  216.     <span class="c1">#: This can be used by flask extensions to make a decision in regards</span>
    217. 

  217.     <span class="c1">#: to how to deal with the session object.</span>
    218. 

  218.     <span class="c1">#:</span>
    219. 

  219.     <span class="c1">#: .. versionadded:: 0.10</span>
    220. 

  220.     <span class="n">pickle_based</span> <span class="o">=</span> <span class="kc">False</span>
    221. 

  221. 

  222. <div class="viewcode-block" id="SessionInterface.make_null_session"><a class="viewcode-back" href="../../flask/flask.html#flask.app.SessionInterface.make_null_session">[docs]</a>    <span class="k">def</span> <span class="nf">make_null_session</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">app</span><span class="p">):</span>
    223. 

  223.         <span class="sd">&quot;&quot;&quot;Creates a null session which acts as a replacement object if the</span>
    224. 

  224. <span class="sd">        real session support could not be loaded due to a configuration</span>
    225. 

  225. <span class="sd">        error.  This mainly aids the user experience because the job of the</span>
    226. 

  226. <span class="sd">        null session is to still support lookup without complaining but</span>
    227. 

  227. <span class="sd">        modifications are answered with a helpful error message of what</span>
    228. 

  228. <span class="sd">        failed.</span>
    229. 

  229. 

  230. <span class="sd">        This creates an instance of :attr:`null_session_class` by default.</span>
    231. 

  231. <span class="sd">        &quot;&quot;&quot;</span>
    232. 

  232.         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">null_session_class</span><span class="p">()</span></div>
    233. 

  233. 

  234. <div class="viewcode-block" id="SessionInterface.is_null_session"><a class="viewcode-back" href="../../flask/flask.html#flask.app.SessionInterface.is_null_session">[docs]</a>    <span class="k">def</span> <span class="nf">is_null_session</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">):</span>
    235. 

  235.         <span class="sd">&quot;&quot;&quot;Checks if a given object is a null session.  Null sessions are</span>
    236. 

  236. <span class="sd">        not asked to be saved.</span>
    237. 

  237. 

  238. <span class="sd">        This checks if the object is an instance of :attr:`null_session_class`</span>
    239. 

  239. <span class="sd">        by default.</span>
    240. 

  240. <span class="sd">        &quot;&quot;&quot;</span>
    241. 

  241.         <span class="k">return</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">null_session_class</span><span class="p">)</span></div>
    242. 

  242. 

  243. <div class="viewcode-block" id="SessionInterface.get_cookie_domain"><a class="viewcode-back" href="../../flask/flask.html#flask.app.SessionInterface.get_cookie_domain">[docs]</a>    <span class="k">def</span> <span class="nf">get_cookie_domain</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">app</span><span class="p">):</span>
    244. 

  244.         <span class="sd">&quot;&quot;&quot;Helpful helper method that returns the cookie domain that should</span>
    245. 

  245. <span class="sd">        be used for the session cookie if session cookies are used.</span>
    246. 

  246. <span class="sd">        &quot;&quot;&quot;</span>
    247. 

  247.         <span class="k">if</span> <span class="n">app</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s1">&#39;SESSION_COOKIE_DOMAIN&#39;</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    248. 

  248.             <span class="k">return</span> <span class="n">app</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s1">&#39;SESSION_COOKIE_DOMAIN&#39;</span><span class="p">]</span>
    249. 

  249.         <span class="k">if</span> <span class="n">app</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s1">&#39;SERVER_NAME&#39;</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    250. 

  250.             <span class="c1"># chop off the port which is usually not supported by browsers</span>
    251. 

  251.             <span class="n">rv</span> <span class="o">=</span> <span class="s1">&#39;.&#39;</span> <span class="o">+</span> <span class="n">app</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s1">&#39;SERVER_NAME&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">rsplit</span><span class="p">(</span><span class="s1">&#39;:&#39;</span><span class="p">,</span> <span class="mi">1</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
    252. 

  252. 

  253.             <span class="c1"># Google chrome does not like cookies set to .localhost, so</span>
    254. 

  254.             <span class="c1"># we just go with no domain then.  Flask documents anyways that</span>
    255. 

  255.             <span class="c1"># cross domain cookies need a fully qualified domain name</span>
    256. 

  256.             <span class="k">if</span> <span class="n">rv</span> <span class="o">==</span> <span class="s1">&#39;.localhost&#39;</span><span class="p">:</span>
    257. 

  257.                 <span class="n">rv</span> <span class="o">=</span> <span class="kc">None</span>
    258. 

  258. 

  259.             <span class="c1"># If we infer the cookie domain from the server name we need</span>
    260. 

  260.             <span class="c1"># to check if we are in a subpath.  In that case we can&#39;t</span>
    261. 

  261.             <span class="c1"># set a cross domain cookie.</span>
    262. 

  262.             <span class="k">if</span> <span class="n">rv</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    263. 

  263.                 <span class="n">path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_cookie_path</span><span class="p">(</span><span class="n">app</span><span class="p">)</span>
    264. 

  264.                 <span class="k">if</span> <span class="n">path</span> <span class="o">!=</span> <span class="s1">&#39;/&#39;</span><span class="p">:</span>
    265. 

  265.                     <span class="n">rv</span> <span class="o">=</span> <span class="n">rv</span><span class="o">.</span><span class="n">lstrip</span><span class="p">(</span><span class="s1">&#39;.&#39;</span><span class="p">)</span>
    266. 

  266. 

  267.             <span class="k">return</span> <span class="n">rv</span></div>
    268. 

  268. 

  269. <div class="viewcode-block" id="SessionInterface.get_cookie_path"><a class="viewcode-back" href="../../flask/flask.html#flask.app.SessionInterface.get_cookie_path">[docs]</a>    <span class="k">def</span> <span class="nf">get_cookie_path</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">app</span><span class="p">):</span>
    270. 

  270.         <span class="sd">&quot;&quot;&quot;Returns the path for which the cookie should be valid.  The</span>
    271. 

  271. <span class="sd">        default implementation uses the value from the ``SESSION_COOKIE_PATH``</span>
    272. 

  272. <span class="sd">        config var if it&#39;s set, and falls back to ``APPLICATION_ROOT`` or</span>
    273. 

  273. <span class="sd">        uses ``/`` if it&#39;s ``None``.</span>
    274. 

  274. <span class="sd">        &quot;&quot;&quot;</span>
    275. 

  275.         <span class="k">return</span> <span class="n">app</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s1">&#39;SESSION_COOKIE_PATH&#39;</span><span class="p">]</span> <span class="ow">or</span> \
    276. 

  276.                <span class="n">app</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s1">&#39;APPLICATION_ROOT&#39;</span><span class="p">]</span> <span class="ow">or</span> <span class="s1">&#39;/&#39;</span></div>
    277. 

  277. 

  278. <div class="viewcode-block" id="SessionInterface.get_cookie_httponly"><a class="viewcode-back" href="../../flask/flask.html#flask.app.SessionInterface.get_cookie_httponly">[docs]</a>    <span class="k">def</span> <span class="nf">get_cookie_httponly</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">app</span><span class="p">):</span>
    279. 

  279.         <span class="sd">&quot;&quot;&quot;Returns True if the session cookie should be httponly.  This</span>
    280. 

  280. <span class="sd">        currently just returns the value of the ``SESSION_COOKIE_HTTPONLY``</span>
    281. 

  281. <span class="sd">        config var.</span>
    282. 

  282. <span class="sd">        &quot;&quot;&quot;</span>
    283. 

  283.         <span class="k">return</span> <span class="n">app</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s1">&#39;SESSION_COOKIE_HTTPONLY&#39;</span><span class="p">]</span></div>
    284. 

  284. 

  285. <div class="viewcode-block" id="SessionInterface.get_cookie_secure"><a class="viewcode-back" href="../../flask/flask.html#flask.app.SessionInterface.get_cookie_secure">[docs]</a>    <span class="k">def</span> <span class="nf">get_cookie_secure</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">app</span><span class="p">):</span>
    286. 

  286.         <span class="sd">&quot;&quot;&quot;Returns True if the cookie should be secure.  This currently</span>
    287. 

  287. <span class="sd">        just returns the value of the ``SESSION_COOKIE_SECURE`` setting.</span>
    288. 

  288. <span class="sd">        &quot;&quot;&quot;</span>
    289. 

  289.         <span class="k">return</span> <span class="n">app</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s1">&#39;SESSION_COOKIE_SECURE&#39;</span><span class="p">]</span></div>
    290. 

  290. 

  291. <div class="viewcode-block" id="SessionInterface.get_expiration_time"><a class="viewcode-back" href="../../flask/flask.html#flask.app.SessionInterface.get_expiration_time">[docs]</a>    <span class="k">def</span> <span class="nf">get_expiration_time</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">app</span><span class="p">,</span> <span class="n">session</span><span class="p">):</span>
    292. 

  292.         <span class="sd">&quot;&quot;&quot;A helper method that returns an expiration date for the session</span>
    293. 

  293. <span class="sd">        or ``None`` if the session is linked to the browser session.  The</span>
    294. 

  294. <span class="sd">        default implementation returns now + the permanent session</span>
    295. 

  295. <span class="sd">        lifetime configured on the application.</span>
    296. 

  296. <span class="sd">        &quot;&quot;&quot;</span>
    297. 

  297.         <span class="k">if</span> <span class="n">session</span><span class="o">.</span><span class="n">permanent</span><span class="p">:</span>
    298. 

  298.             <span class="k">return</span> <span class="n">datetime</span><span class="o">.</span><span class="n">utcnow</span><span class="p">()</span> <span class="o">+</span> <span class="n">app</span><span class="o">.</span><span class="n">permanent_session_lifetime</span></div>
    299. 

  299. 

  300. <div class="viewcode-block" id="SessionInterface.should_set_cookie"><a class="viewcode-back" href="../../flask/flask.html#flask.app.SessionInterface.should_set_cookie">[docs]</a>    <span class="k">def</span> <span class="nf">should_set_cookie</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">app</span><span class="p">,</span> <span class="n">session</span><span class="p">):</span>
    301. 

  301.         <span class="sd">&quot;&quot;&quot;Indicates whether a cookie should be set now or not.  This is</span>
    302. 

  302. <span class="sd">        used by session backends to figure out if they should emit a</span>
    303. 

  303. <span class="sd">        set-cookie header or not.  The default behavior is controlled by</span>
    304. 

  304. <span class="sd">        the ``SESSION_REFRESH_EACH_REQUEST`` config variable.  If</span>
    305. 

  305. <span class="sd">        it&#39;s set to ``False`` then a cookie is only set if the session is</span>
    306. 

  306. <span class="sd">        modified, if set to ``True`` it&#39;s always set if the session is</span>
    307. 

  307. <span class="sd">        permanent.</span>
    308. 

  308. 

  309. <span class="sd">        This check is usually skipped if sessions get deleted.</span>
    310. 

  310. 

  311. <span class="sd">        .. versionadded:: 0.11</span>
    312. 

  312. <span class="sd">        &quot;&quot;&quot;</span>
    313. 

  313.         <span class="k">if</span> <span class="n">session</span><span class="o">.</span><span class="n">modified</span><span class="p">:</span>
    314. 

  314.             <span class="k">return</span> <span class="kc">True</span>
    315. 

  315.         <span class="n">save_each</span> <span class="o">=</span> <span class="n">app</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s1">&#39;SESSION_REFRESH_EACH_REQUEST&#39;</span><span class="p">]</span>
    316. 

  316.         <span class="k">return</span> <span class="n">save_each</span> <span class="ow">and</span> <span class="n">session</span><span class="o">.</span><span class="n">permanent</span></div>
    317. 

  317. 

  318. <div class="viewcode-block" id="SessionInterface.open_session"><a class="viewcode-back" href="../../flask/flask.html#flask.app.SessionInterface.open_session">[docs]</a>    <span class="k">def</span> <span class="nf">open_session</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">app</span><span class="p">,</span> <span class="n">request</span><span class="p">):</span>
    319. 

  319.         <span class="sd">&quot;&quot;&quot;This method has to be implemented and must either return ``None``</span>
    320. 

  320. <span class="sd">        in case the loading failed because of a configuration error or an</span>
    321. 

  321. <span class="sd">        instance of a session object which implements a dictionary like</span>
    322. 

  322. <span class="sd">        interface + the methods and attributes on :class:`SessionMixin`.</span>
    323. 

  323. <span class="sd">        &quot;&quot;&quot;</span>
    324. 

  324.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    325. 

  325. 

  326. <div class="viewcode-block" id="SessionInterface.save_session"><a class="viewcode-back" href="../../flask/flask.html#flask.app.SessionInterface.save_session">[docs]</a>    <span class="k">def</span> <span class="nf">save_session</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">app</span><span class="p">,</span> <span class="n">session</span><span class="p">,</span> <span class="n">response</span><span class="p">):</span>
    327. 

  327.         <span class="sd">&quot;&quot;&quot;This is called for actual sessions returned by :meth:`open_session`</span>
    328. 

  328. <span class="sd">        at the end of the request.  This is still called during a request</span>
    329. 

  329. <span class="sd">        context so if you absolutely need access to the request you can do</span>
    330. 

  330. <span class="sd">        that.</span>
    331. 

  331. <span class="sd">        &quot;&quot;&quot;</span>
    332. 

  332.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>
    333. 

  333. 

  334. 

  335. <div class="viewcode-block" id="SecureCookieSessionInterface"><a class="viewcode-back" href="../../flask/flask.html#flask.app.SecureCookieSessionInterface">[docs]</a><span class="k">class</span> <span class="nc">SecureCookieSessionInterface</span><span class="p">(</span><span class="n">SessionInterface</span><span class="p">):</span>
    336. 

  336.     <span class="sd">&quot;&quot;&quot;The default session interface that stores sessions in signed cookies</span>
    337. 

  337. <span class="sd">    through the :mod:`itsdangerous` module.</span>
    338. 

  338. <span class="sd">    &quot;&quot;&quot;</span>
    339. 

  339.     <span class="c1">#: the salt that should be applied on top of the secret key for the</span>
    340. 

  340.     <span class="c1">#: signing of cookie based sessions.</span>
    341. 

  341.     <span class="n">salt</span> <span class="o">=</span> <span class="s1">&#39;cookie-session&#39;</span>
    342. 

  342.     <span class="c1">#: the hash function to use for the signature.  The default is sha1</span>
    343. 

  343.     <span class="n">digest_method</span> <span class="o">=</span> <span class="nb">staticmethod</span><span class="p">(</span><span class="n">hashlib</span><span class="o">.</span><span class="n">sha1</span><span class="p">)</span>
    344. 

  344.     <span class="c1">#: the name of the itsdangerous supported key derivation.  The default</span>
    345. 

  345.     <span class="c1">#: is hmac.</span>
    346. 

  346.     <span class="n">key_derivation</span> <span class="o">=</span> <span class="s1">&#39;hmac&#39;</span>
    347. 

  347.     <span class="c1">#: A python serializer for the payload.  The default is a compact</span>
    348. 

  348.     <span class="c1">#: JSON derived serializer with support for some extra Python types</span>
    349. 

  349.     <span class="c1">#: such as datetime objects or tuples.</span>
    350. 

  350.     <span class="n">serializer</span> <span class="o">=</span> <span class="n">session_json_serializer</span>
    351. 

  351.     <span class="n">session_class</span> <span class="o">=</span> <span class="n">SecureCookieSession</span>
    352. 

  352. 

  353. <div class="viewcode-block" id="SecureCookieSessionInterface.get_signing_serializer"><a class="viewcode-back" href="../../flask/flask.html#flask.app.SecureCookieSessionInterface.get_signing_serializer">[docs]</a>    <span class="k">def</span> <span class="nf">get_signing_serializer</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">app</span><span class="p">):</span>
    354. 

  354.         <span class="k">if</span> <span class="ow">not</span> <span class="n">app</span><span class="o">.</span><span class="n">secret_key</span><span class="p">:</span>
    355. 

  355.             <span class="k">return</span> <span class="kc">None</span>
    356. 

  356.         <span class="n">signer_kwargs</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
    357. 

  357.             <span class="n">key_derivation</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">key_derivation</span><span class="p">,</span>
    358. 

  358.             <span class="n">digest_method</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">digest_method</span>
    359. 

  359.         <span class="p">)</span>
    360. 

  360.         <span class="k">return</span> <span class="n">URLSafeTimedSerializer</span><span class="p">(</span><span class="n">app</span><span class="o">.</span><span class="n">secret_key</span><span class="p">,</span> <span class="n">salt</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">salt</span><span class="p">,</span>
    361. 

  361.                                       <span class="n">serializer</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">serializer</span><span class="p">,</span>
    362. 

  362.                                       <span class="n">signer_kwargs</span><span class="o">=</span><span class="n">signer_kwargs</span><span class="p">)</span></div>
    363. 

  363. 

  364. <div class="viewcode-block" id="SecureCookieSessionInterface.open_session"><a class="viewcode-back" href="../../flask/flask.html#flask.app.SecureCookieSessionInterface.open_session">[docs]</a>    <span class="k">def</span> <span class="nf">open_session</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">app</span><span class="p">,</span> <span class="n">request</span><span class="p">):</span>
    365. 

  365.         <span class="n">s</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_signing_serializer</span><span class="p">(</span><span class="n">app</span><span class="p">)</span>
    366. 

  366.         <span class="k">if</span> <span class="n">s</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    367. 

  367.             <span class="k">return</span> <span class="kc">None</span>
    368. 

  368.         <span class="n">val</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">cookies</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">app</span><span class="o">.</span><span class="n">session_cookie_name</span><span class="p">)</span>
    369. 

  369.         <span class="k">if</span> <span class="ow">not</span> <span class="n">val</span><span class="p">:</span>
    370. 

  370.             <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">session_class</span><span class="p">()</span>
    371. 

  371.         <span class="n">max_age</span> <span class="o">=</span> <span class="n">total_seconds</span><span class="p">(</span><span class="n">app</span><span class="o">.</span><span class="n">permanent_session_lifetime</span><span class="p">)</span>
    372. 

  372.         <span class="k">try</span><span class="p">:</span>
    373. 

  373.             <span class="n">data</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">val</span><span class="p">,</span> <span class="n">max_age</span><span class="o">=</span><span class="n">max_age</span><span class="p">)</span>
    374. 

  374.             <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">session_class</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
    375. 

  375.         <span class="k">except</span> <span class="n">BadSignature</span><span class="p">:</span>
    376. 

  376.             <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">session_class</span><span class="p">()</span></div>
    377. 

  377. 

  378. <div class="viewcode-block" id="SecureCookieSessionInterface.save_session"><a class="viewcode-back" href="../../flask/flask.html#flask.app.SecureCookieSessionInterface.save_session">[docs]</a>    <span class="k">def</span> <span class="nf">save_session</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">app</span><span class="p">,</span> <span class="n">session</span><span class="p">,</span> <span class="n">response</span><span class="p">):</span>
    379. 

  379.         <span class="n">domain</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_cookie_domain</span><span class="p">(</span><span class="n">app</span><span class="p">)</span>
    380. 

  380.         <span class="n">path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_cookie_path</span><span class="p">(</span><span class="n">app</span><span class="p">)</span>
    381. 

  381. 

  382.         <span class="c1"># Delete case.  If there is no session we bail early.</span>
    383. 

  383.         <span class="c1"># If the session was modified to be empty we remove the</span>
    384. 

  384.         <span class="c1"># whole cookie.</span>
    385. 

  385.         <span class="k">if</span> <span class="ow">not</span> <span class="n">session</span><span class="p">:</span>
    386. 

  386.             <span class="k">if</span> <span class="n">session</span><span class="o">.</span><span class="n">modified</span><span class="p">:</span>
    387. 

  387.                 <span class="n">response</span><span class="o">.</span><span class="n">delete_cookie</span><span class="p">(</span><span class="n">app</span><span class="o">.</span><span class="n">session_cookie_name</span><span class="p">,</span>
    388. 

  388.                                        <span class="n">domain</span><span class="o">=</span><span class="n">domain</span><span class="p">,</span> <span class="n">path</span><span class="o">=</span><span class="n">path</span><span class="p">)</span>
    389. 

  389.             <span class="k">return</span>
    390. 

  390. 

  391.         <span class="c1"># Modification case.  There are upsides and downsides to</span>
    392. 

  392.         <span class="c1"># emitting a set-cookie header each request.  The behavior</span>
    393. 

  393.         <span class="c1"># is controlled by the :meth:`should_set_cookie` method</span>
    394. 

  394.         <span class="c1"># which performs a quick check to figure out if the cookie</span>
    395. 

  395.         <span class="c1"># should be set or not.  This is controlled by the</span>
    396. 

  396.         <span class="c1"># SESSION_REFRESH_EACH_REQUEST config flag as well as</span>
    397. 

  397.         <span class="c1"># the permanent flag on the session itself.</span>
    398. 

  398.         <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">should_set_cookie</span><span class="p">(</span><span class="n">app</span><span class="p">,</span> <span class="n">session</span><span class="p">):</span>
    399. 

  399.             <span class="k">return</span>
    400. 

  400. 

  401.         <span class="n">httponly</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_cookie_httponly</span><span class="p">(</span><span class="n">app</span><span class="p">)</span>
    402. 

  402.         <span class="n">secure</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_cookie_secure</span><span class="p">(</span><span class="n">app</span><span class="p">)</span>
    403. 

  403.         <span class="n">expires</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_expiration_time</span><span class="p">(</span><span class="n">app</span><span class="p">,</span> <span class="n">session</span><span class="p">)</span>
    404. 

  404.         <span class="n">val</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_signing_serializer</span><span class="p">(</span><span class="n">app</span><span class="p">)</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="nb">dict</span><span class="p">(</span><span class="n">session</span><span class="p">))</span>
    405. 

  405.         <span class="n">response</span><span class="o">.</span><span class="n">set_cookie</span><span class="p">(</span><span class="n">app</span><span class="o">.</span><span class="n">session_cookie_name</span><span class="p">,</span> <span class="n">val</span><span class="p">,</span>
    406. 

  406.                             <span class="n">expires</span><span class="o">=</span><span class="n">expires</span><span class="p">,</span> <span class="n">httponly</span><span class="o">=</span><span class="n">httponly</span><span class="p">,</span>
    407. 

  407.                             <span class="n">domain</span><span class="o">=</span><span class="n">domain</span><span class="p">,</span> <span class="n">path</span><span class="o">=</span><span class="n">path</span><span class="p">,</span> <span class="n">secure</span><span class="o">=</span><span class="n">secure</span><span class="p">)</span></div></div>
    408. 

  408. </pre></div>
    409. 

  409. 

  410.           </div>
    411. 

  411.         </div>
    412. 

  412.       </div>
    413. 

  413.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
    414. 

  414.         <div class="sphinxsidebarwrapper"><div class="relations">
    415. 

  415. <h3>Related Topics</h3>
    416. 

  416. <ul>
    417. 

  417.   <li><a href="../../index.html">Documentation overview</a><ul>
    418. 

  418.   <li><a href="../index.html">Module code</a><ul>
    419. 

  419.   </ul></li>
    420. 

  420.   </ul></li>
    421. 

  421. </ul>
    422. 

  422. </div>
    423. 

  423. <div id="searchbox" style="display: none" role="search">
    424. 

  424.   <h3>Quick search</h3>
    425. 

  425.     <form class="search" action="../../search.html" method="get">
    426. 

  426.       <div><input type="text" name="q" /></div>
    427. 

  427.       <div><input type="submit" value="Go" /></div>
    428. 

  428.       <input type="hidden" name="check_keywords" value="yes" />
    429. 

  429.       <input type="hidden" name="area" value="default" />
    430. 

  430.     </form>
    431. 

  431. </div>
    432. 

  432. <script type="text/javascript">$('#searchbox').show(0);</script>
    433. 

  433.         </div>
    434. 

  434.       </div>
    435. 

  435.       <div class="clearer"></div>
    436. 

  436.     </div>
    437. 

  437.     <div class="footer">
    438. 

  438.       &copy;2016, Author.
    439. 

  439.       
    440. 

  440.       |
    441. 

  441.       Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.8</a>
    442. 

  442.       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.9</a>
    443. 

  443.       
    444. 

  444.     </div>
    445. 

  445. 

  446.     
    447. 

  447. 

  448.     
    449. 

  449.   </body>
    450. 

  450. </html>
    451.