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

json.html 33 KB
История Исходник

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360 
  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.json &#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.json</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.jsonimpl</span>
    49. 

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

  50. 

  51. <span class="sd">    Implementation helpers for the JSON support in Flask.</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. <span class="kn">import</span> <span class="nn">io</span>
    57. 

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

  58. <span class="kn">from</span> <span class="nn">datetime</span> <span class="k">import</span> <span class="n">date</span>
    59. 

  59. <span class="kn">from</span> <span class="nn">.globals</span> <span class="k">import</span> <span class="n">current_app</span><span class="p">,</span> <span class="n">request</span>
    60. 

  60. <span class="kn">from</span> <span class="nn">._compat</span> <span class="k">import</span> <span class="n">text_type</span><span class="p">,</span> <span class="n">PY2</span>
    61. 

  61. 

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

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

  64. 

  65. <span class="c1"># Use the same json implementation as itsdangerous on which we</span>
    66. 

  66. <span class="c1"># depend anyways.</span>
    67. 

  67. <span class="k">try</span><span class="p">:</span>
    68. 

  68.     <span class="kn">from</span> <span class="nn">itsdangerous</span> <span class="k">import</span> <span class="n">simplejson</span> <span class="k">as</span> <span class="n">_json</span>
    69. 

  69. <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
    70. 

  70.     <span class="kn">from</span> <span class="nn">itsdangerous</span> <span class="k">import</span> <span class="n">json</span> <span class="k">as</span> <span class="n">_json</span>
    71. 

  71. 

  72. 

  73. <span class="c1"># Figure out if simplejson escapes slashes.  This behavior was changed</span>
    74. 

  74. <span class="c1"># from one version to another without reason.</span>
    75. 

  75. <span class="n">_slash_escape</span> <span class="o">=</span> <span class="s1">&#39;</span><span class="se">\\</span><span class="s1">/&#39;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">_json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="s1">&#39;/&#39;</span><span class="p">)</span>
    76. 

  76. 

  77. 

  78. <span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;dump&#39;</span><span class="p">,</span> <span class="s1">&#39;dumps&#39;</span><span class="p">,</span> <span class="s1">&#39;load&#39;</span><span class="p">,</span> <span class="s1">&#39;loads&#39;</span><span class="p">,</span> <span class="s1">&#39;htmlsafe_dump&#39;</span><span class="p">,</span>
    79. 

  79.            <span class="s1">&#39;htmlsafe_dumps&#39;</span><span class="p">,</span> <span class="s1">&#39;JSONDecoder&#39;</span><span class="p">,</span> <span class="s1">&#39;JSONEncoder&#39;</span><span class="p">,</span>
    80. 

  80.            <span class="s1">&#39;jsonify&#39;</span><span class="p">]</span>
    81. 

  81. 

  82. 

  83. <span class="k">def</span> <span class="nf">_wrap_reader_for_text</span><span class="p">(</span><span class="n">fp</span><span class="p">,</span> <span class="n">encoding</span><span class="p">):</span>
    84. 

  84.     <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">fp</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="mi">0</span><span class="p">),</span> <span class="nb">bytes</span><span class="p">):</span>
    85. 

  85.         <span class="n">fp</span> <span class="o">=</span> <span class="n">io</span><span class="o">.</span><span class="n">TextIOWrapper</span><span class="p">(</span><span class="n">io</span><span class="o">.</span><span class="n">BufferedReader</span><span class="p">(</span><span class="n">fp</span><span class="p">),</span> <span class="n">encoding</span><span class="p">)</span>
    86. 

  86.     <span class="k">return</span> <span class="n">fp</span>
    87. 

  87. 

  88. 

  89. <span class="k">def</span> <span class="nf">_wrap_writer_for_text</span><span class="p">(</span><span class="n">fp</span><span class="p">,</span> <span class="n">encoding</span><span class="p">):</span>
    90. 

  90.     <span class="k">try</span><span class="p">:</span>
    91. 

  91.         <span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">)</span>
    92. 

  92.     <span class="k">except</span> <span class="ne">TypeError</span><span class="p">:</span>
    93. 

  93.         <span class="n">fp</span> <span class="o">=</span> <span class="n">io</span><span class="o">.</span><span class="n">TextIOWrapper</span><span class="p">(</span><span class="n">fp</span><span class="p">,</span> <span class="n">encoding</span><span class="p">)</span>
    94. 

  94.     <span class="k">return</span> <span class="n">fp</span>
    95. 

  95. 

  96. 

  97. <div class="viewcode-block" id="JSONEncoder"><a class="viewcode-back" href="../../flask/flask.html#flask.app.JSONEncoder">[docs]</a><span class="k">class</span> <span class="nc">JSONEncoder</span><span class="p">(</span><span class="n">_json</span><span class="o">.</span><span class="n">JSONEncoder</span><span class="p">):</span>
    98. 

  98.     <span class="sd">&quot;&quot;&quot;The default Flask JSON encoder.  This one extends the default simplejson</span>
    99. 

  99. <span class="sd">    encoder by also supporting ``datetime`` objects, ``UUID`` as well as</span>
    100. 

  100. <span class="sd">    ``Markup`` objects which are serialized as RFC 822 datetime strings (same</span>
    101. 

  101. <span class="sd">    as the HTTP date format).  In order to support more data types override the</span>
    102. 

  102. <span class="sd">    :meth:`default` method.</span>
    103. 

  103. <span class="sd">    &quot;&quot;&quot;</span>
    104. 

  104. 

  105. <div class="viewcode-block" id="JSONEncoder.default"><a class="viewcode-back" href="../../flask/flask.html#flask.app.JSONEncoder.default">[docs]</a>    <span class="k">def</span> <span class="nf">default</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">o</span><span class="p">):</span>
    106. 

  106.         <span class="sd">&quot;&quot;&quot;Implement this method in a subclass such that it returns a</span>
    107. 

  107. <span class="sd">        serializable object for ``o``, or calls the base implementation (to</span>
    108. 

  108. <span class="sd">        raise a :exc:`TypeError`).</span>
    109. 

  109. 

  110. <span class="sd">        For example, to support arbitrary iterators, you could implement</span>
    111. 

  111. <span class="sd">        default like this::</span>
    112. 

  112. 

  113. <span class="sd">            def default(self, o):</span>
    114. 

  114. <span class="sd">                try:</span>
    115. 

  115. <span class="sd">                    iterable = iter(o)</span>
    116. 

  116. <span class="sd">                except TypeError:</span>
    117. 

  117. <span class="sd">                    pass</span>
    118. 

  118. <span class="sd">                else:</span>
    119. 

  119. <span class="sd">                    return list(iterable)</span>
    120. 

  120. <span class="sd">                return JSONEncoder.default(self, o)</span>
    121. 

  121. <span class="sd">        &quot;&quot;&quot;</span>
    122. 

  122.         <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">o</span><span class="p">,</span> <span class="n">date</span><span class="p">):</span>
    123. 

  123.             <span class="k">return</span> <span class="n">http_date</span><span class="p">(</span><span class="n">o</span><span class="o">.</span><span class="n">timetuple</span><span class="p">())</span>
    124. 

  124.         <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">o</span><span class="p">,</span> <span class="n">uuid</span><span class="o">.</span><span class="n">UUID</span><span class="p">):</span>
    125. 

  125.             <span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="n">o</span><span class="p">)</span>
    126. 

  126.         <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">o</span><span class="p">,</span> <span class="s1">&#39;__html__&#39;</span><span class="p">):</span>
    127. 

  127.             <span class="k">return</span> <span class="n">text_type</span><span class="p">(</span><span class="n">o</span><span class="o">.</span><span class="n">__html__</span><span class="p">())</span>
    128. 

  128.         <span class="k">return</span> <span class="n">_json</span><span class="o">.</span><span class="n">JSONEncoder</span><span class="o">.</span><span class="n">default</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">o</span><span class="p">)</span></div></div>
    129. 

  129. 

  130. 

  131. <div class="viewcode-block" id="JSONDecoder"><a class="viewcode-back" href="../../flask/flask.html#flask.app.JSONDecoder">[docs]</a><span class="k">class</span> <span class="nc">JSONDecoder</span><span class="p">(</span><span class="n">_json</span><span class="o">.</span><span class="n">JSONDecoder</span><span class="p">):</span>
    132. 

  132.     <span class="sd">&quot;&quot;&quot;The default JSON decoder.  This one does not change the behavior from</span>
    133. 

  133. <span class="sd">    the default simplejson decoder.  Consult the :mod:`json` documentation</span>
    134. 

  134. <span class="sd">    for more information.  This decoder is not only used for the load</span>
    135. 

  135. <span class="sd">    functions of this module but also :attr:`~flask.Request`.</span>
    136. 

  136. <span class="sd">    &quot;&quot;&quot;</span></div>
    137. 

  137. 

  138. 

  139. <span class="k">def</span> <span class="nf">_dump_arg_defaults</span><span class="p">(</span><span class="n">kwargs</span><span class="p">):</span>
    140. 

  140.     <span class="sd">&quot;&quot;&quot;Inject default arguments for dump functions.&quot;&quot;&quot;</span>
    141. 

  141.     <span class="k">if</span> <span class="n">current_app</span><span class="p">:</span>
    142. 

  142.         <span class="n">kwargs</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="s1">&#39;cls&#39;</span><span class="p">,</span> <span class="n">current_app</span><span class="o">.</span><span class="n">json_encoder</span><span class="p">)</span>
    143. 

  143.         <span class="k">if</span> <span class="ow">not</span> <span class="n">current_app</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s1">&#39;JSON_AS_ASCII&#39;</span><span class="p">]:</span>
    144. 

  144.             <span class="n">kwargs</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="s1">&#39;ensure_ascii&#39;</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
    145. 

  145.         <span class="n">kwargs</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="s1">&#39;sort_keys&#39;</span><span class="p">,</span> <span class="n">current_app</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s1">&#39;JSON_SORT_KEYS&#39;</span><span class="p">])</span>
    146. 

  146.     <span class="k">else</span><span class="p">:</span>
    147. 

  147.         <span class="n">kwargs</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="s1">&#39;sort_keys&#39;</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span>
    148. 

  148.         <span class="n">kwargs</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="s1">&#39;cls&#39;</span><span class="p">,</span> <span class="n">JSONEncoder</span><span class="p">)</span>
    149. 

  149. 

  150. 

  151. <span class="k">def</span> <span class="nf">_load_arg_defaults</span><span class="p">(</span><span class="n">kwargs</span><span class="p">):</span>
    152. 

  152.     <span class="sd">&quot;&quot;&quot;Inject default arguments for load functions.&quot;&quot;&quot;</span>
    153. 

  153.     <span class="k">if</span> <span class="n">current_app</span><span class="p">:</span>
    154. 

  154.         <span class="n">kwargs</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="s1">&#39;cls&#39;</span><span class="p">,</span> <span class="n">current_app</span><span class="o">.</span><span class="n">json_decoder</span><span class="p">)</span>
    155. 

  155.     <span class="k">else</span><span class="p">:</span>
    156. 

  156.         <span class="n">kwargs</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="s1">&#39;cls&#39;</span><span class="p">,</span> <span class="n">JSONDecoder</span><span class="p">)</span>
    157. 

  157. 

  158. 

  159. <div class="viewcode-block" id="dumps"><a class="viewcode-back" href="../../flask/flask.html#flask.app.dumps">[docs]</a><span class="k">def</span> <span class="nf">dumps</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
    160. 

  160.     <span class="sd">&quot;&quot;&quot;Serialize ``obj`` to a JSON formatted ``str`` by using the application&#39;s</span>
    161. 

  161. <span class="sd">    configured encoder (:attr:`~flask.Flask.json_encoder`) if there is an</span>
    162. 

  162. <span class="sd">    application on the stack.</span>
    163. 

  163. 

  164. <span class="sd">    This function can return ``unicode`` strings or ascii-only bytestrings by</span>
    165. 

  165. <span class="sd">    default which coerce into unicode strings automatically.  That behavior by</span>
    166. 

  166. <span class="sd">    default is controlled by the ``JSON_AS_ASCII`` configuration variable</span>
    167. 

  167. <span class="sd">    and can be overridden by the simplejson ``ensure_ascii`` parameter.</span>
    168. 

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

  169.     <span class="n">_dump_arg_defaults</span><span class="p">(</span><span class="n">kwargs</span><span class="p">)</span>
    170. 

  170.     <span class="n">encoding</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s1">&#39;encoding&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
    171. 

  171.     <span class="n">rv</span> <span class="o">=</span> <span class="n">_json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
    172. 

  172.     <span class="k">if</span> <span class="n">encoding</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">rv</span><span class="p">,</span> <span class="n">text_type</span><span class="p">):</span>
    173. 

  173.         <span class="n">rv</span> <span class="o">=</span> <span class="n">rv</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">encoding</span><span class="p">)</span>
    174. 

  174.     <span class="k">return</span> <span class="n">rv</span></div>
    175. 

  175. 

  176. 

  177. <div class="viewcode-block" id="dump"><a class="viewcode-back" href="../../flask/flask.html#flask.app.dump">[docs]</a><span class="k">def</span> <span class="nf">dump</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">fp</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
    178. 

  178.     <span class="sd">&quot;&quot;&quot;Like :func:`dumps` but writes into a file object.&quot;&quot;&quot;</span>
    179. 

  179.     <span class="n">_dump_arg_defaults</span><span class="p">(</span><span class="n">kwargs</span><span class="p">)</span>
    180. 

  180.     <span class="n">encoding</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s1">&#39;encoding&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
    181. 

  181.     <span class="k">if</span> <span class="n">encoding</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    182. 

  182.         <span class="n">fp</span> <span class="o">=</span> <span class="n">_wrap_writer_for_text</span><span class="p">(</span><span class="n">fp</span><span class="p">,</span> <span class="n">encoding</span><span class="p">)</span>
    183. 

  183.     <span class="n">_json</span><span class="o">.</span><span class="n">dump</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">fp</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div>
    184. 

  184. 

  185. 

  186. <div class="viewcode-block" id="loads"><a class="viewcode-back" href="../../flask/flask.html#flask.app.loads">[docs]</a><span class="k">def</span> <span class="nf">loads</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
    187. 

  187.     <span class="sd">&quot;&quot;&quot;Unserialize a JSON object from a string ``s`` by using the application&#39;s</span>
    188. 

  188. <span class="sd">    configured decoder (:attr:`~flask.Flask.json_decoder`) if there is an</span>
    189. 

  189. <span class="sd">    application on the stack.</span>
    190. 

  190. <span class="sd">    &quot;&quot;&quot;</span>
    191. 

  191.     <span class="n">_load_arg_defaults</span><span class="p">(</span><span class="n">kwargs</span><span class="p">)</span>
    192. 

  192.     <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">):</span>
    193. 

  193.         <span class="n">s</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="n">kwargs</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s1">&#39;encoding&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> <span class="ow">or</span> <span class="s1">&#39;utf-8&#39;</span><span class="p">)</span>
    194. 

  194.     <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">s</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div>
    195. 

  195. 

  196. 

  197. <div class="viewcode-block" id="load"><a class="viewcode-back" href="../../flask/flask.html#flask.app.load">[docs]</a><span class="k">def</span> <span class="nf">load</span><span class="p">(</span><span class="n">fp</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
    198. 

  198.     <span class="sd">&quot;&quot;&quot;Like :func:`loads` but reads from a file object.</span>
    199. 

  199. <span class="sd">    &quot;&quot;&quot;</span>
    200. 

  200.     <span class="n">_load_arg_defaults</span><span class="p">(</span><span class="n">kwargs</span><span class="p">)</span>
    201. 

  201.     <span class="k">if</span> <span class="ow">not</span> <span class="n">PY2</span><span class="p">:</span>
    202. 

  202.         <span class="n">fp</span> <span class="o">=</span> <span class="n">_wrap_reader_for_text</span><span class="p">(</span><span class="n">fp</span><span class="p">,</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s1">&#39;encoding&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> <span class="ow">or</span> <span class="s1">&#39;utf-8&#39;</span><span class="p">)</span>
    203. 

  203.     <span class="k">return</span> <span class="n">_json</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">fp</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div>
    204. 

  204. 

  205. 

  206. <div class="viewcode-block" id="htmlsafe_dumps"><a class="viewcode-back" href="../../flask/flask.html#flask.app.htmlsafe_dumps">[docs]</a><span class="k">def</span> <span class="nf">htmlsafe_dumps</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
    207. 

  207.     <span class="sd">&quot;&quot;&quot;Works exactly like :func:`dumps` but is safe for use in ``&lt;script&gt;``</span>
    208. 

  208. <span class="sd">    tags.  It accepts the same arguments and returns a JSON string.  Note that</span>
    209. 

  209. <span class="sd">    this is available in templates through the ``|tojson`` filter which will</span>
    210. 

  210. <span class="sd">    also mark the result as safe.  Due to how this function escapes certain</span>
    211. 

  211. <span class="sd">    characters this is safe even if used outside of ``&lt;script&gt;`` tags.</span>
    212. 

  212. 

  213. <span class="sd">    The following characters are escaped in strings:</span>
    214. 

  214. 

  215. <span class="sd">    -   ``&lt;``</span>
    216. 

  216. <span class="sd">    -   ``&gt;``</span>
    217. 

  217. <span class="sd">    -   ``&amp;``</span>
    218. 

  218. <span class="sd">    -   ``&#39;``</span>
    219. 

  219. 

  220. <span class="sd">    This makes it safe to embed such strings in any place in HTML with the</span>
    221. 

  221. <span class="sd">    notable exception of double quoted attributes.  In that case single</span>
    222. 

  222. <span class="sd">    quote your attributes or HTML escape it in addition.</span>
    223. 

  223. 

  224. <span class="sd">    .. versionchanged:: 0.10</span>
    225. 

  225. <span class="sd">       This function&#39;s return value is now always safe for HTML usage, even</span>
    226. 

  226. <span class="sd">       if outside of script tags or if used in XHTML.  This rule does not</span>
    227. 

  227. <span class="sd">       hold true when using this function in HTML attributes that are double</span>
    228. 

  228. <span class="sd">       quoted.  Always single quote attributes if you use the ``|tojson``</span>
    229. 

  229. <span class="sd">       filter.  Alternatively use ``|tojson|forceescape``.</span>
    230. 

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

  231.     <span class="n">rv</span> <span class="o">=</span> <span class="n">dumps</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> \
    232. 

  232.         <span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">u&#39;&lt;&#39;</span><span class="p">,</span> <span class="s1">u&#39;</span><span class="se">\\</span><span class="s1">u003c&#39;</span><span class="p">)</span> \
    233. 

  233.         <span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">u&#39;&gt;&#39;</span><span class="p">,</span> <span class="s1">u&#39;</span><span class="se">\\</span><span class="s1">u003e&#39;</span><span class="p">)</span> \
    234. 

  234.         <span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">u&#39;&amp;&#39;</span><span class="p">,</span> <span class="s1">u&#39;</span><span class="se">\\</span><span class="s1">u0026&#39;</span><span class="p">)</span> \
    235. 

  235.         <span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">u&quot;&#39;&quot;</span><span class="p">,</span> <span class="s1">u&#39;</span><span class="se">\\</span><span class="s1">u0027&#39;</span><span class="p">)</span>
    236. 

  236.     <span class="k">if</span> <span class="ow">not</span> <span class="n">_slash_escape</span><span class="p">:</span>
    237. 

  237.         <span class="n">rv</span> <span class="o">=</span> <span class="n">rv</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\\</span><span class="s1">/&#39;</span><span class="p">,</span> <span class="s1">&#39;/&#39;</span><span class="p">)</span>
    238. 

  238.     <span class="k">return</span> <span class="n">rv</span></div>
    239. 

  239. 

  240. 

  241. <div class="viewcode-block" id="htmlsafe_dump"><a class="viewcode-back" href="../../flask/flask.html#flask.app.htmlsafe_dump">[docs]</a><span class="k">def</span> <span class="nf">htmlsafe_dump</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">fp</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
    242. 

  242.     <span class="sd">&quot;&quot;&quot;Like :func:`htmlsafe_dumps` but writes into a file object.&quot;&quot;&quot;</span>
    243. 

  243.     <span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">text_type</span><span class="p">(</span><span class="n">htmlsafe_dumps</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)))</span></div>
    244. 

  244. 

  245. 

  246. <div class="viewcode-block" id="jsonify"><a class="viewcode-back" href="../../flask/flask.html#flask.app.jsonify">[docs]</a><span class="k">def</span> <span class="nf">jsonify</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>
    247. 

  247.     <span class="sd">&quot;&quot;&quot;This function wraps :func:`dumps` to add a few enhancements that make</span>
    248. 

  248. <span class="sd">    life easier.  It turns the JSON output into a :class:`~flask.Response`</span>
    249. 

  249. <span class="sd">    object with the :mimetype:`application/json` mimetype.  For convenience, it</span>
    250. 

  250. <span class="sd">    also converts multiple arguments into an array or multiple keyword arguments</span>
    251. 

  251. <span class="sd">    into a dict.  This means that both ``jsonify(1,2,3)`` and</span>
    252. 

  252. <span class="sd">    ``jsonify([1,2,3])`` serialize to ``[1,2,3]``.</span>
    253. 

  253. 

  254. <span class="sd">    For clarity, the JSON serialization behavior has the following differences</span>
    255. 

  255. <span class="sd">    from :func:`dumps`:</span>
    256. 

  256. 

  257. <span class="sd">    1. Single argument: Passed straight through to :func:`dumps`.</span>
    258. 

  258. <span class="sd">    2. Multiple arguments: Converted to an array before being passed to</span>
    259. 

  259. <span class="sd">       :func:`dumps`.</span>
    260. 

  260. <span class="sd">    3. Multiple keyword arguments: Converted to a dict before being passed to</span>
    261. 

  261. <span class="sd">       :func:`dumps`.</span>
    262. 

  262. <span class="sd">    4. Both args and kwargs: Behavior undefined and will throw an exception.</span>
    263. 

  263. 

  264. <span class="sd">    Example usage::</span>
    265. 

  265. 

  266. <span class="sd">        from flask import jsonify</span>
    267. 

  267. 

  268. <span class="sd">        @app.route(&#39;/_get_current_user&#39;)</span>
    269. 

  269. <span class="sd">        def get_current_user():</span>
    270. 

  270. <span class="sd">            return jsonify(username=g.user.username,</span>
    271. 

  271. <span class="sd">                           email=g.user.email,</span>
    272. 

  272. <span class="sd">                           id=g.user.id)</span>
    273. 

  273. 

  274. <span class="sd">    This will send a JSON response like this to the browser::</span>
    275. 

  275. 

  276. <span class="sd">        {</span>
    277. 

  277. <span class="sd">            &quot;username&quot;: &quot;admin&quot;,</span>
    278. 

  278. <span class="sd">            &quot;email&quot;: &quot;admin@localhost&quot;,</span>
    279. 

  279. <span class="sd">            &quot;id&quot;: 42</span>
    280. 

  280. <span class="sd">        }</span>
    281. 

  281. 

  282. 

  283. <span class="sd">    .. versionchanged:: 0.11</span>
    284. 

  284. <span class="sd">       Added support for serializing top-level arrays. This introduces a</span>
    285. 

  285. <span class="sd">       security risk in ancient browsers. See :ref:`json-security` for details.</span>
    286. 

  286. 

  287. <span class="sd">    This function&#39;s response will be pretty printed if it was not requested</span>
    288. 

  288. <span class="sd">    with ``X-Requested-With: XMLHttpRequest`` to simplify debugging unless</span>
    289. 

  289. <span class="sd">    the ``JSONIFY_PRETTYPRINT_REGULAR`` config parameter is set to false.</span>
    290. 

  290. <span class="sd">    Compressed (not pretty) formatting currently means no indents and no</span>
    291. 

  291. <span class="sd">    spaces after separators.</span>
    292. 

  292. 

  293. <span class="sd">    .. versionadded:: 0.2</span>
    294. 

  294. <span class="sd">    &quot;&quot;&quot;</span>
    295. 

  295. 

  296.     <span class="n">indent</span> <span class="o">=</span> <span class="kc">None</span>
    297. 

  297.     <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>
    298. 

  298. 

  299.     <span class="k">if</span> <span class="n">current_app</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s1">&#39;JSONIFY_PRETTYPRINT_REGULAR&#39;</span><span class="p">]</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">request</span><span class="o">.</span><span class="n">is_xhr</span><span class="p">:</span>
    300. 

  300.         <span class="n">indent</span> <span class="o">=</span> <span class="mi">2</span>
    301. 

  301.         <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>
    302. 

  302. 

  303.     <span class="k">if</span> <span class="n">args</span> <span class="ow">and</span> <span class="n">kwargs</span><span class="p">:</span>
    304. 

  304.         <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">&#39;jsonify() behavior undefined when passed both args and kwargs&#39;</span><span class="p">)</span>
    305. 

  305.     <span class="k">elif</span> <span class="nb">len</span><span class="p">(</span><span class="n">args</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>  <span class="c1"># single args are passed directly to dumps()</span>
    306. 

  306.         <span class="n">data</span> <span class="o">=</span> <span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
    307. 

  307.     <span class="k">else</span><span class="p">:</span>
    308. 

  308.         <span class="n">data</span> <span class="o">=</span> <span class="n">args</span> <span class="ow">or</span> <span class="n">kwargs</span>
    309. 

  309. 

  310.     <span class="k">return</span> <span class="n">current_app</span><span class="o">.</span><span class="n">response_class</span><span class="p">(</span>
    311. 

  311.         <span class="p">(</span><span class="n">dumps</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">indent</span><span class="o">=</span><span class="n">indent</span><span class="p">,</span> <span class="n">separators</span><span class="o">=</span><span class="n">separators</span><span class="p">),</span> <span class="s1">&#39;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="p">),</span>
    312. 

  312.         <span class="n">mimetype</span><span class="o">=</span><span class="n">current_app</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s1">&#39;JSONIFY_MIMETYPE&#39;</span><span class="p">]</span>
    313. 

  313.     <span class="p">)</span></div>
    314. 

  314. 

  315. 

  316. <span class="k">def</span> <span class="nf">tojson_filter</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
    317. 

  317.     <span class="k">return</span> <span class="n">Markup</span><span class="p">(</span><span class="n">htmlsafe_dumps</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">))</span>
    318. 

  318. </pre></div>
    319. 

  319. 

  320.           </div>
    321. 

  321.         </div>
    322. 

  322.       </div>
    323. 

  323.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
    324. 

  324.         <div class="sphinxsidebarwrapper"><div class="relations">
    325. 

  325. <h3>Related Topics</h3>
    326. 

  326. <ul>
    327. 

  327.   <li><a href="../../index.html">Documentation overview</a><ul>
    328. 

  328.   <li><a href="../index.html">Module code</a><ul>
    329. 

  329.   </ul></li>
    330. 

  330.   </ul></li>
    331. 

  331. </ul>
    332. 

  332. </div>
    333. 

  333. <div id="searchbox" style="display: none" role="search">
    334. 

  334.   <h3>Quick search</h3>
    335. 

  335.     <form class="search" action="../../search.html" method="get">
    336. 

  336.       <div><input type="text" name="q" /></div>
    337. 

  337.       <div><input type="submit" value="Go" /></div>
    338. 

  338.       <input type="hidden" name="check_keywords" value="yes" />
    339. 

  339.       <input type="hidden" name="area" value="default" />
    340. 

  340.     </form>
    341. 

  341. </div>
    342. 

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

  343.         </div>
    344. 

  344.       </div>
    345. 

  345.       <div class="clearer"></div>
    346. 

  346.     </div>
    347. 

  347.     <div class="footer">
    348. 

  348.       &copy;2016, Author.
    349. 

  349.       
    350. 

  350.       |
    351. 

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

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

  353.       
    354. 

  354.     </div>
    355. 

  355. 

  356.     
    357. 

  357. 

  358.     
    359. 

  359.   </body>
    360. 

  360. </html>
    361.