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

cli.html 64 KB
История Исходник

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570 
  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.cli &#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.cli</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.cli</span>
    49. 

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

  50. 

  51. <span class="sd">    A simple command line application to run flask apps.</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">os</span>
    58. 

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

  59. <span class="kn">from</span> <span class="nn">threading</span> <span class="k">import</span> <span class="n">Lock</span><span class="p">,</span> <span class="n">Thread</span>
    60. 

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

  61. 

  62. <span class="kn">import</span> <span class="nn">click</span>
    63. 

  63. 

  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">reraise</span>
    65. 

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

  66. 

  67. 

  68. <div class="viewcode-block" id="NoAppException"><a class="viewcode-back" href="../../flask/flask.html#flask.cli.NoAppException">[docs]</a><span class="k">class</span> <span class="nc">NoAppException</span><span class="p">(</span><span class="n">click</span><span class="o">.</span><span class="n">UsageError</span><span class="p">):</span>
    69. 

  69.     <span class="sd">&quot;&quot;&quot;Raised if an application cannot be found or loaded.&quot;&quot;&quot;</span></div>
    70. 

  70. 

  71. 

  72. <div class="viewcode-block" id="find_best_app"><a class="viewcode-back" href="../../flask/flask.html#flask.cli.find_best_app">[docs]</a><span class="k">def</span> <span class="nf">find_best_app</span><span class="p">(</span><span class="n">module</span><span class="p">):</span>
    73. 

  73.     <span class="sd">&quot;&quot;&quot;Given a module instance this tries to find the best possible</span>
    74. 

  74. <span class="sd">    application in the module or raises an exception.</span>
    75. 

  75. <span class="sd">    &quot;&quot;&quot;</span>
    76. 

  76.     <span class="kn">from</span> <span class="nn">.</span> <span class="k">import</span> <span class="n">Flask</span>
    77. 

  77. 

  78.     <span class="c1"># Search for the most common names first.</span>
    79. 

  79.     <span class="k">for</span> <span class="n">attr_name</span> <span class="ow">in</span> <span class="s1">&#39;app&#39;</span><span class="p">,</span> <span class="s1">&#39;application&#39;</span><span class="p">:</span>
    80. 

  80.         <span class="n">app</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">module</span><span class="p">,</span> <span class="n">attr_name</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
    81. 

  81.         <span class="k">if</span> <span class="n">app</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">app</span><span class="p">,</span> <span class="n">Flask</span><span class="p">):</span>
    82. 

  82.             <span class="k">return</span> <span class="n">app</span>
    83. 

  83. 

  84.     <span class="c1"># Otherwise find the only object that is a Flask instance.</span>
    85. 

  85.     <span class="n">matches</span> <span class="o">=</span> <span class="p">[</span><span class="n">v</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">module</span><span class="o">.</span><span class="n">__dict__</span><span class="p">)</span>
    86. 

  86.                <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="n">Flask</span><span class="p">)]</span>
    87. 

  87. 

  88.     <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">matches</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
    89. 

  89.         <span class="k">return</span> <span class="n">matches</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
    90. 

  90.     <span class="k">raise</span> <span class="n">NoAppException</span><span class="p">(</span><span class="s1">&#39;Failed to find application in module &quot;</span><span class="si">%s</span><span class="s1">&quot;.  Are &#39;</span>
    91. 

  91.                          <span class="s1">&#39;you sure it contains a Flask application?  Maybe &#39;</span>
    92. 

  92.                          <span class="s1">&#39;you wrapped it in a WSGI middleware or you are &#39;</span>
    93. 

  93.                          <span class="s1">&#39;using a factory function.&#39;</span> <span class="o">%</span> <span class="n">module</span><span class="o">.</span><span class="n">__name__</span><span class="p">)</span></div>
    94. 

  94. 

  95. 

  96. <div class="viewcode-block" id="prepare_exec_for_file"><a class="viewcode-back" href="../../flask/flask.html#flask.cli.prepare_exec_for_file">[docs]</a><span class="k">def</span> <span class="nf">prepare_exec_for_file</span><span class="p">(</span><span class="n">filename</span><span class="p">):</span>
    97. 

  97.     <span class="sd">&quot;&quot;&quot;Given a filename this will try to calculate the python path, add it</span>
    98. 

  98. <span class="sd">    to the search path and return the actual module name that is expected.</span>
    99. 

  99. <span class="sd">    &quot;&quot;&quot;</span>
    100. 

  100.     <span class="n">module</span> <span class="o">=</span> <span class="p">[]</span>
    101. 

  101. 

  102.     <span class="c1"># Chop off file extensions or package markers</span>
    103. 

  103.     <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">filename</span><span class="p">)[</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="s1">&#39;__init__.py&#39;</span><span class="p">:</span>
    104. 

  104.         <span class="n">filename</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span>
    105. 

  105.     <span class="k">elif</span> <span class="n">filename</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s1">&#39;.py&#39;</span><span class="p">):</span>
    106. 

  106.         <span class="n">filename</span> <span class="o">=</span> <span class="n">filename</span><span class="p">[:</span><span class="o">-</span><span class="mi">3</span><span class="p">]</span>
    107. 

  107.     <span class="k">else</span><span class="p">:</span>
    108. 

  108.         <span class="k">raise</span> <span class="n">NoAppException</span><span class="p">(</span><span class="s1">&#39;The file provided (</span><span class="si">%s</span><span class="s1">) does exist but is not a &#39;</span>
    109. 

  109.                              <span class="s1">&#39;valid Python file.  This means that it cannot &#39;</span>
    110. 

  110.                              <span class="s1">&#39;be used as application.  Please change the &#39;</span>
    111. 

  111.                              <span class="s1">&#39;extension to .py&#39;</span> <span class="o">%</span> <span class="n">filename</span><span class="p">)</span>
    112. 

  112.     <span class="n">filename</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">realpath</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span>
    113. 

  113. 

  114.     <span class="n">dirpath</span> <span class="o">=</span> <span class="n">filename</span>
    115. 

  115.     <span class="k">while</span> <span class="mi">1</span><span class="p">:</span>
    116. 

  116.         <span class="n">dirpath</span><span class="p">,</span> <span class="n">extra</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">dirpath</span><span class="p">)</span>
    117. 

  117.         <span class="n">module</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">extra</span><span class="p">)</span>
    118. 

  118.         <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">dirpath</span><span class="p">,</span> <span class="s1">&#39;__init__.py&#39;</span><span class="p">)):</span>
    119. 

  119.             <span class="k">break</span>
    120. 

  120. 

  121.     <span class="n">sys</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">dirpath</span><span class="p">)</span>
    122. 

  122.     <span class="k">return</span> <span class="s1">&#39;.&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">module</span><span class="p">[::</span><span class="o">-</span><span class="mi">1</span><span class="p">])</span></div>
    123. 

  123. 

  124. 

  125. <div class="viewcode-block" id="locate_app"><a class="viewcode-back" href="../../flask/flask.html#flask.cli.locate_app">[docs]</a><span class="k">def</span> <span class="nf">locate_app</span><span class="p">(</span><span class="n">app_id</span><span class="p">):</span>
    126. 

  126.     <span class="sd">&quot;&quot;&quot;Attempts to locate the application.&quot;&quot;&quot;</span>
    127. 

  127.     <span class="n">__traceback_hide__</span> <span class="o">=</span> <span class="kc">True</span>
    128. 

  128.     <span class="k">if</span> <span class="s1">&#39;:&#39;</span> <span class="ow">in</span> <span class="n">app_id</span><span class="p">:</span>
    129. 

  129.         <span class="n">module</span><span class="p">,</span> <span class="n">app_obj</span> <span class="o">=</span> <span class="n">app_id</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;:&#39;</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
    130. 

  130.     <span class="k">else</span><span class="p">:</span>
    131. 

  131.         <span class="n">module</span> <span class="o">=</span> <span class="n">app_id</span>
    132. 

  132.         <span class="n">app_obj</span> <span class="o">=</span> <span class="kc">None</span>
    133. 

  133. 

  134.     <span class="nb">__import__</span><span class="p">(</span><span class="n">module</span><span class="p">)</span>
    135. 

  135.     <span class="n">mod</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="n">module</span><span class="p">]</span>
    136. 

  136.     <span class="k">if</span> <span class="n">app_obj</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    137. 

  137.         <span class="n">app</span> <span class="o">=</span> <span class="n">find_best_app</span><span class="p">(</span><span class="n">mod</span><span class="p">)</span>
    138. 

  138.     <span class="k">else</span><span class="p">:</span>
    139. 

  139.         <span class="n">app</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">mod</span><span class="p">,</span> <span class="n">app_obj</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
    140. 

  140.         <span class="k">if</span> <span class="n">app</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    141. 

  141.             <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s1">&#39;Failed to find application in module &quot;</span><span class="si">%s</span><span class="s1">&quot;&#39;</span>
    142. 

  142.                                <span class="o">%</span> <span class="n">module</span><span class="p">)</span>
    143. 

  143. 

  144.     <span class="k">return</span> <span class="n">app</span></div>
    145. 

  145. 

  146. 

  147. <div class="viewcode-block" id="find_default_import_path"><a class="viewcode-back" href="../../flask/flask.html#flask.cli.find_default_import_path">[docs]</a><span class="k">def</span> <span class="nf">find_default_import_path</span><span class="p">():</span>
    148. 

  148.     <span class="n">app</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;FLASK_APP&#39;</span><span class="p">)</span>
    149. 

  149.     <span class="k">if</span> <span class="n">app</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    150. 

  150.         <span class="k">return</span>
    151. 

  151.     <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">app</span><span class="p">):</span>
    152. 

  152.         <span class="k">return</span> <span class="n">prepare_exec_for_file</span><span class="p">(</span><span class="n">app</span><span class="p">)</span>
    153. 

  153.     <span class="k">return</span> <span class="n">app</span></div>
    154. 

  154. 

  155. 

  156. <div class="viewcode-block" id="DispatchingApp"><a class="viewcode-back" href="../../flask/flask.html#flask.cli.DispatchingApp">[docs]</a><span class="k">class</span> <span class="nc">DispatchingApp</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
    157. 

  157.     <span class="sd">&quot;&quot;&quot;Special application that dispatches to a flask application which</span>
    158. 

  158. <span class="sd">    is imported by name in a background thread.  If an error happens</span>
    159. 

  159. <span class="sd">    it is is recorded and shows as part of the WSGI handling which in case</span>
    160. 

  160. <span class="sd">    of the Werkzeug debugger means that it shows up in the browser.</span>
    161. 

  161. <span class="sd">    &quot;&quot;&quot;</span>
    162. 

  162. 

  163.     <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">loader</span><span class="p">,</span> <span class="n">use_eager_loading</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
    164. 

  164.         <span class="bp">self</span><span class="o">.</span><span class="n">loader</span> <span class="o">=</span> <span class="n">loader</span>
    165. 

  165.         <span class="bp">self</span><span class="o">.</span><span class="n">_app</span> <span class="o">=</span> <span class="kc">None</span>
    166. 

  166.         <span class="bp">self</span><span class="o">.</span><span class="n">_lock</span> <span class="o">=</span> <span class="n">Lock</span><span class="p">()</span>
    167. 

  167.         <span class="bp">self</span><span class="o">.</span><span class="n">_bg_loading_exc_info</span> <span class="o">=</span> <span class="kc">None</span>
    168. 

  168.         <span class="k">if</span> <span class="n">use_eager_loading</span><span class="p">:</span>
    169. 

  169.             <span class="bp">self</span><span class="o">.</span><span class="n">_load_unlocked</span><span class="p">()</span>
    170. 

  170.         <span class="k">else</span><span class="p">:</span>
    171. 

  171.             <span class="bp">self</span><span class="o">.</span><span class="n">_load_in_background</span><span class="p">()</span>
    172. 

  172. 

  173.     <span class="k">def</span> <span class="nf">_load_in_background</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    174. 

  174.         <span class="k">def</span> <span class="nf">_load_app</span><span class="p">():</span>
    175. 

  175.             <span class="n">__traceback_hide__</span> <span class="o">=</span> <span class="kc">True</span>
    176. 

  176.             <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">_lock</span><span class="p">:</span>
    177. 

  177.                 <span class="k">try</span><span class="p">:</span>
    178. 

  178.                     <span class="bp">self</span><span class="o">.</span><span class="n">_load_unlocked</span><span class="p">()</span>
    179. 

  179.                 <span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
    180. 

  180.                     <span class="bp">self</span><span class="o">.</span><span class="n">_bg_loading_exc_info</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">exc_info</span><span class="p">()</span>
    181. 

  181.         <span class="n">t</span> <span class="o">=</span> <span class="n">Thread</span><span class="p">(</span><span class="n">target</span><span class="o">=</span><span class="n">_load_app</span><span class="p">,</span> <span class="n">args</span><span class="o">=</span><span class="p">())</span>
    182. 

  182.         <span class="n">t</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
    183. 

  183. 

  184.     <span class="k">def</span> <span class="nf">_flush_bg_loading_exception</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    185. 

  185.         <span class="n">__traceback_hide__</span> <span class="o">=</span> <span class="kc">True</span>
    186. 

  186.         <span class="n">exc_info</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_bg_loading_exc_info</span>
    187. 

  187.         <span class="k">if</span> <span class="n">exc_info</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    188. 

  188.             <span class="bp">self</span><span class="o">.</span><span class="n">_bg_loading_exc_info</span> <span class="o">=</span> <span class="kc">None</span>
    189. 

  189.             <span class="n">reraise</span><span class="p">(</span><span class="o">*</span><span class="n">exc_info</span><span class="p">)</span>
    190. 

  190. 

  191.     <span class="k">def</span> <span class="nf">_load_unlocked</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    192. 

  192.         <span class="n">__traceback_hide__</span> <span class="o">=</span> <span class="kc">True</span>
    193. 

  193.         <span class="bp">self</span><span class="o">.</span><span class="n">_app</span> <span class="o">=</span> <span class="n">rv</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">loader</span><span class="p">()</span>
    194. 

  194.         <span class="bp">self</span><span class="o">.</span><span class="n">_bg_loading_exc_info</span> <span class="o">=</span> <span class="kc">None</span>
    195. 

  195.         <span class="k">return</span> <span class="n">rv</span>
    196. 

  196. 

  197.     <span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">environ</span><span class="p">,</span> <span class="n">start_response</span><span class="p">):</span>
    198. 

  198.         <span class="n">__traceback_hide__</span> <span class="o">=</span> <span class="kc">True</span>
    199. 

  199.         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_app</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    200. 

  200.             <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_app</span><span class="p">(</span><span class="n">environ</span><span class="p">,</span> <span class="n">start_response</span><span class="p">)</span>
    201. 

  201.         <span class="bp">self</span><span class="o">.</span><span class="n">_flush_bg_loading_exception</span><span class="p">()</span>
    202. 

  202.         <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">_lock</span><span class="p">:</span>
    203. 

  203.             <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_app</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    204. 

  204.                 <span class="n">rv</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_app</span>
    205. 

  205.             <span class="k">else</span><span class="p">:</span>
    206. 

  206.                 <span class="n">rv</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_load_unlocked</span><span class="p">()</span>
    207. 

  207.             <span class="k">return</span> <span class="n">rv</span><span class="p">(</span><span class="n">environ</span><span class="p">,</span> <span class="n">start_response</span><span class="p">)</span></div>
    208. 

  208. 

  209. 

  210. <div class="viewcode-block" id="ScriptInfo"><a class="viewcode-back" href="../../flask/flask.html#flask.cli.ScriptInfo">[docs]</a><span class="k">class</span> <span class="nc">ScriptInfo</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
    211. 

  211.     <span class="sd">&quot;&quot;&quot;Help object to deal with Flask applications.  This is usually not</span>
    212. 

  212. <span class="sd">    necessary to interface with as it&#39;s used internally in the dispatching</span>
    213. 

  213. <span class="sd">    to click.  In future versions of Flask this object will most likely play</span>
    214. 

  214. <span class="sd">    a bigger role.  Typically it&#39;s created automatically by the</span>
    215. 

  215. <span class="sd">    :class:`FlaskGroup` but you can also manually create it and pass it</span>
    216. 

  216. <span class="sd">    onwards as click object.</span>
    217. 

  217. <span class="sd">    &quot;&quot;&quot;</span>
    218. 

  218. 

  219.     <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">app_import_path</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">create_app</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    220. 

  220.         <span class="k">if</span> <span class="n">create_app</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    221. 

  221.             <span class="k">if</span> <span class="n">app_import_path</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    222. 

  222.                 <span class="n">app_import_path</span> <span class="o">=</span> <span class="n">find_default_import_path</span><span class="p">()</span>
    223. 

  223.             <span class="bp">self</span><span class="o">.</span><span class="n">app_import_path</span> <span class="o">=</span> <span class="n">app_import_path</span>
    224. 

  224.         <span class="k">else</span><span class="p">:</span>
    225. 

  225.             <span class="n">app_import_path</span> <span class="o">=</span> <span class="kc">None</span>
    226. 

  226. 

  227.         <span class="c1">#: Optionally the import path for the Flask application.</span>
    228. 

  228.         <span class="bp">self</span><span class="o">.</span><span class="n">app_import_path</span> <span class="o">=</span> <span class="n">app_import_path</span>
    229. 

  229.         <span class="c1">#: Optionally a function that is passed the script info to create</span>
    230. 

  230.         <span class="c1">#: the instance of the application.</span>
    231. 

  231.         <span class="bp">self</span><span class="o">.</span><span class="n">create_app</span> <span class="o">=</span> <span class="n">create_app</span>
    232. 

  232.         <span class="c1">#: A dictionary with arbitrary data that can be associated with</span>
    233. 

  233.         <span class="c1">#: this script info.</span>
    234. 

  234.         <span class="bp">self</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="p">{}</span>
    235. 

  235.         <span class="bp">self</span><span class="o">.</span><span class="n">_loaded_app</span> <span class="o">=</span> <span class="kc">None</span>
    236. 

  236. 

  237. <div class="viewcode-block" id="ScriptInfo.load_app"><a class="viewcode-back" href="../../flask/flask.html#flask.cli.ScriptInfo.load_app">[docs]</a>    <span class="k">def</span> <span class="nf">load_app</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    238. 

  238.         <span class="sd">&quot;&quot;&quot;Loads the Flask app (if not yet loaded) and returns it.  Calling</span>
    239. 

  239. <span class="sd">        this multiple times will just result in the already loaded app to</span>
    240. 

  240. <span class="sd">        be returned.</span>
    241. 

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

  242.         <span class="n">__traceback_hide__</span> <span class="o">=</span> <span class="kc">True</span>
    243. 

  243.         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_loaded_app</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    244. 

  244.             <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_loaded_app</span>
    245. 

  245.         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">create_app</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    246. 

  246.             <span class="n">rv</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">create_app</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
    247. 

  247.         <span class="k">else</span><span class="p">:</span>
    248. 

  248.             <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">app_import_path</span><span class="p">:</span>
    249. 

  249.                 <span class="k">raise</span> <span class="n">NoAppException</span><span class="p">(</span>
    250. 

  250.                     <span class="s1">&#39;Could not locate Flask application. You did not provide &#39;</span>
    251. 

  251.                     <span class="s1">&#39;the FLASK_APP environment variable.</span><span class="se">\n\n</span><span class="s1">For more &#39;</span>
    252. 

  252.                     <span class="s1">&#39;information see &#39;</span>
    253. 

  253.                     <span class="s1">&#39;http://flask.pocoo.org/docs/latest/quickstart/&#39;</span><span class="p">)</span>
    254. 

  254.             <span class="n">rv</span> <span class="o">=</span> <span class="n">locate_app</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">app_import_path</span><span class="p">)</span>
    255. 

  255.         <span class="n">debug</span> <span class="o">=</span> <span class="n">get_debug_flag</span><span class="p">()</span>
    256. 

  256.         <span class="k">if</span> <span class="n">debug</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    257. 

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

  258.         <span class="bp">self</span><span class="o">.</span><span class="n">_loaded_app</span> <span class="o">=</span> <span class="n">rv</span>
    259. 

  259.         <span class="k">return</span> <span class="n">rv</span></div></div>
    260. 

  260. 

  261. 

  262. <span class="n">pass_script_info</span> <span class="o">=</span> <span class="n">click</span><span class="o">.</span><span class="n">make_pass_decorator</span><span class="p">(</span><span class="n">ScriptInfo</span><span class="p">,</span> <span class="n">ensure</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
    263. 

  263. 

  264. 

  265. <div class="viewcode-block" id="with_appcontext"><a class="viewcode-back" href="../../flask/flask.html#flask.cli.with_appcontext">[docs]</a><span class="k">def</span> <span class="nf">with_appcontext</span><span class="p">(</span><span class="n">f</span><span class="p">):</span>
    266. 

  266.     <span class="sd">&quot;&quot;&quot;Wraps a callback so that it&#39;s guaranteed to be executed with the</span>
    267. 

  267. <span class="sd">    script&#39;s application context.  If callbacks are registered directly</span>
    268. 

  268. <span class="sd">    to the ``app.cli`` object then they are wrapped with this function</span>
    269. 

  269. <span class="sd">    by default unless it&#39;s disabled.</span>
    270. 

  270. <span class="sd">    &quot;&quot;&quot;</span>
    271. 

  271.     <span class="nd">@click</span><span class="o">.</span><span class="n">pass_context</span>
    272. 

  272.     <span class="k">def</span> <span class="nf">decorator</span><span class="p">(</span><span class="n">__ctx</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>
    273. 

  273.         <span class="k">with</span> <span class="n">__ctx</span><span class="o">.</span><span class="n">ensure_object</span><span class="p">(</span><span class="n">ScriptInfo</span><span class="p">)</span><span class="o">.</span><span class="n">load_app</span><span class="p">()</span><span class="o">.</span><span class="n">app_context</span><span class="p">():</span>
    274. 

  274.             <span class="k">return</span> <span class="n">__ctx</span><span class="o">.</span><span class="n">invoke</span><span class="p">(</span><span class="n">f</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>
    275. 

  275.     <span class="k">return</span> <span class="n">update_wrapper</span><span class="p">(</span><span class="n">decorator</span><span class="p">,</span> <span class="n">f</span><span class="p">)</span></div>
    276. 

  276. 

  277. 

  278. <div class="viewcode-block" id="AppGroup"><a class="viewcode-back" href="../../flask/flask.html#flask.cli.AppGroup">[docs]</a><span class="k">class</span> <span class="nc">AppGroup</span><span class="p">(</span><span class="n">click</span><span class="o">.</span><span class="n">Group</span><span class="p">):</span>
    279. 

  279.     <span class="sd">&quot;&quot;&quot;This works similar to a regular click :class:`~click.Group` but it</span>
    280. 

  280. <span class="sd">    changes the behavior of the :meth:`command` decorator so that it</span>
    281. 

  281. <span class="sd">    automatically wraps the functions in :func:`with_appcontext`.</span>
    282. 

  282. 

  283. <span class="sd">    Not to be confused with :class:`FlaskGroup`.</span>
    284. 

  284. <span class="sd">    &quot;&quot;&quot;</span>
    285. 

  285. 

  286. <div class="viewcode-block" id="AppGroup.command"><a class="viewcode-back" href="../../flask/flask.html#flask.cli.AppGroup.command">[docs]</a>    <span class="k">def</span> <span class="nf">command</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>
    287. 

  287.         <span class="sd">&quot;&quot;&quot;This works exactly like the method of the same name on a regular</span>
    288. 

  288. <span class="sd">        :class:`click.Group` but it wraps callbacks in :func:`with_appcontext`</span>
    289. 

  289. <span class="sd">        unless it&#39;s disabled by passing ``with_appcontext=False``.</span>
    290. 

  290. <span class="sd">        &quot;&quot;&quot;</span>
    291. 

  291.         <span class="n">wrap_for_ctx</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;with_appcontext&#39;</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span>
    292. 

  292.         <span class="k">def</span> <span class="nf">decorator</span><span class="p">(</span><span class="n">f</span><span class="p">):</span>
    293. 

  293.             <span class="k">if</span> <span class="n">wrap_for_ctx</span><span class="p">:</span>
    294. 

  294.                 <span class="n">f</span> <span class="o">=</span> <span class="n">with_appcontext</span><span class="p">(</span><span class="n">f</span><span class="p">)</span>
    295. 

  295.             <span class="k">return</span> <span class="n">click</span><span class="o">.</span><span class="n">Group</span><span class="o">.</span><span class="n">command</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><span class="n">f</span><span class="p">)</span>
    296. 

  296.         <span class="k">return</span> <span class="n">decorator</span></div>
    297. 

  297. 

  298. <div class="viewcode-block" id="AppGroup.group"><a class="viewcode-back" href="../../flask/flask.html#flask.cli.AppGroup.group">[docs]</a>    <span class="k">def</span> <span class="nf">group</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>
    299. 

  299.         <span class="sd">&quot;&quot;&quot;This works exactly like the method of the same name on a regular</span>
    300. 

  300. <span class="sd">        :class:`click.Group` but it defaults the group class to</span>
    301. 

  301. <span class="sd">        :class:`AppGroup`.</span>
    302. 

  302. <span class="sd">        &quot;&quot;&quot;</span>
    303. 

  303.         <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">AppGroup</span><span class="p">)</span>
    304. 

  304.         <span class="k">return</span> <span class="n">click</span><span class="o">.</span><span class="n">Group</span><span class="o">.</span><span class="n">group</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></div></div>
    305. 

  305. 

  306. 

  307. <div class="viewcode-block" id="FlaskGroup"><a class="viewcode-back" href="../../flask/flask.html#flask.cli.FlaskGroup">[docs]</a><span class="k">class</span> <span class="nc">FlaskGroup</span><span class="p">(</span><span class="n">AppGroup</span><span class="p">):</span>
    308. 

  308.     <span class="sd">&quot;&quot;&quot;Special subclass of the :class:`AppGroup` group that supports</span>
    309. 

  309. <span class="sd">    loading more commands from the configured Flask app.  Normally a</span>
    310. 

  310. <span class="sd">    developer does not have to interface with this class but there are</span>
    311. 

  311. <span class="sd">    some very advanced use cases for which it makes sense to create an</span>
    312. 

  312. <span class="sd">    instance of this.</span>
    313. 

  313. 

  314. <span class="sd">    For information as of why this is useful see :ref:`custom-scripts`.</span>
    315. 

  315. 

  316. <span class="sd">    :param add_default_commands: if this is True then the default run and</span>
    317. 

  317. <span class="sd">                                 shell commands wil be added.</span>
    318. 

  318. <span class="sd">    :param create_app: an optional callback that is passed the script info</span>
    319. 

  319. <span class="sd">                       and returns the loaded app.</span>
    320. 

  320. <span class="sd">    &quot;&quot;&quot;</span>
    321. 

  321. 

  322.     <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">add_default_commands</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">create_app</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">extra</span><span class="p">):</span>
    323. 

  323.         <span class="n">AppGroup</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="o">**</span><span class="n">extra</span><span class="p">)</span>
    324. 

  324.         <span class="bp">self</span><span class="o">.</span><span class="n">create_app</span> <span class="o">=</span> <span class="n">create_app</span>
    325. 

  325. 

  326.         <span class="k">if</span> <span class="n">add_default_commands</span><span class="p">:</span>
    327. 

  327.             <span class="bp">self</span><span class="o">.</span><span class="n">add_command</span><span class="p">(</span><span class="n">run_command</span><span class="p">)</span>
    328. 

  328.             <span class="bp">self</span><span class="o">.</span><span class="n">add_command</span><span class="p">(</span><span class="n">shell_command</span><span class="p">)</span>
    329. 

  329. 

  330.         <span class="bp">self</span><span class="o">.</span><span class="n">_loaded_plugin_commands</span> <span class="o">=</span> <span class="kc">False</span>
    331. 

  331. 

  332.     <span class="k">def</span> <span class="nf">_load_plugin_commands</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    333. 

  333.         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_loaded_plugin_commands</span><span class="p">:</span>
    334. 

  334.             <span class="k">return</span>
    335. 

  335.         <span class="k">try</span><span class="p">:</span>
    336. 

  336.             <span class="kn">import</span> <span class="nn">pkg_resources</span>
    337. 

  337.         <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
    338. 

  338.             <span class="bp">self</span><span class="o">.</span><span class="n">_loaded_plugin_commands</span> <span class="o">=</span> <span class="kc">True</span>
    339. 

  339.             <span class="k">return</span>
    340. 

  340. 

  341.         <span class="k">for</span> <span class="n">ep</span> <span class="ow">in</span> <span class="n">pkg_resources</span><span class="o">.</span><span class="n">iter_entry_points</span><span class="p">(</span><span class="s1">&#39;flask.commands&#39;</span><span class="p">):</span>
    342. 

  342.             <span class="bp">self</span><span class="o">.</span><span class="n">add_command</span><span class="p">(</span><span class="n">ep</span><span class="o">.</span><span class="n">load</span><span class="p">(),</span> <span class="n">ep</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
    343. 

  343.         <span class="bp">self</span><span class="o">.</span><span class="n">_loaded_plugin_commands</span> <span class="o">=</span> <span class="kc">True</span>
    344. 

  344. 

  345. <div class="viewcode-block" id="FlaskGroup.get_command"><a class="viewcode-back" href="../../flask/flask.html#flask.cli.FlaskGroup.get_command">[docs]</a>    <span class="k">def</span> <span class="nf">get_command</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ctx</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
    346. 

  346.         <span class="bp">self</span><span class="o">.</span><span class="n">_load_plugin_commands</span><span class="p">()</span>
    347. 

  347. 

  348.         <span class="c1"># We load built-in commands first as these should always be the</span>
    349. 

  349.         <span class="c1"># same no matter what the app does.  If the app does want to</span>
    350. 

  350.         <span class="c1"># override this it needs to make a custom instance of this group</span>
    351. 

  351.         <span class="c1"># and not attach the default commands.</span>
    352. 

  352.         <span class="c1">#</span>
    353. 

  353.         <span class="c1"># This also means that the script stays functional in case the</span>
    354. 

  354.         <span class="c1"># application completely fails.</span>
    355. 

  355.         <span class="n">rv</span> <span class="o">=</span> <span class="n">AppGroup</span><span class="o">.</span><span class="n">get_command</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ctx</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
    356. 

  356.         <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>
    357. 

  357.             <span class="k">return</span> <span class="n">rv</span>
    358. 

  358. 

  359.         <span class="n">info</span> <span class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span class="n">ensure_object</span><span class="p">(</span><span class="n">ScriptInfo</span><span class="p">)</span>
    360. 

  360.         <span class="k">try</span><span class="p">:</span>
    361. 

  361.             <span class="n">rv</span> <span class="o">=</span> <span class="n">info</span><span class="o">.</span><span class="n">load_app</span><span class="p">()</span><span class="o">.</span><span class="n">cli</span><span class="o">.</span><span class="n">get_command</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
    362. 

  362.             <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>
    363. 

  363.                 <span class="k">return</span> <span class="n">rv</span>
    364. 

  364.         <span class="k">except</span> <span class="n">NoAppException</span><span class="p">:</span>
    365. 

  365.             <span class="k">pass</span></div>
    366. 

  366. 

  367. <div class="viewcode-block" id="FlaskGroup.list_commands"><a class="viewcode-back" href="../../flask/flask.html#flask.cli.FlaskGroup.list_commands">[docs]</a>    <span class="k">def</span> <span class="nf">list_commands</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ctx</span><span class="p">):</span>
    368. 

  368.         <span class="bp">self</span><span class="o">.</span><span class="n">_load_plugin_commands</span><span class="p">()</span>
    369. 

  369. 

  370.         <span class="c1"># The commands available is the list of both the application (if</span>
    371. 

  371.         <span class="c1"># available) plus the builtin commands.</span>
    372. 

  372.         <span class="n">rv</span> <span class="o">=</span> <span class="nb">set</span><span class="p">(</span><span class="n">click</span><span class="o">.</span><span class="n">Group</span><span class="o">.</span><span class="n">list_commands</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ctx</span><span class="p">))</span>
    373. 

  373.         <span class="n">info</span> <span class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span class="n">ensure_object</span><span class="p">(</span><span class="n">ScriptInfo</span><span class="p">)</span>
    374. 

  374.         <span class="k">try</span><span class="p">:</span>
    375. 

  375.             <span class="n">rv</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">info</span><span class="o">.</span><span class="n">load_app</span><span class="p">()</span><span class="o">.</span><span class="n">cli</span><span class="o">.</span><span class="n">list_commands</span><span class="p">(</span><span class="n">ctx</span><span class="p">))</span>
    376. 

  376.         <span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
    377. 

  377.             <span class="c1"># Here we intentionally swallow all exceptions as we don&#39;t</span>
    378. 

  378.             <span class="c1"># want the help page to break if the app does not exist.</span>
    379. 

  379.             <span class="c1"># If someone attempts to use the command we try to create</span>
    380. 

  380.             <span class="c1"># the app again and this will give us the error.</span>
    381. 

  381.             <span class="k">pass</span>
    382. 

  382.         <span class="k">return</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">rv</span><span class="p">)</span></div>
    383. 

  383. 

  384. <div class="viewcode-block" id="FlaskGroup.main"><a class="viewcode-back" href="../../flask/flask.html#flask.cli.FlaskGroup.main">[docs]</a>    <span class="k">def</span> <span class="nf">main</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>
    385. 

  385.         <span class="n">obj</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;obj&#39;</span><span class="p">)</span>
    386. 

  386.         <span class="k">if</span> <span class="n">obj</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    387. 

  387.             <span class="n">obj</span> <span class="o">=</span> <span class="n">ScriptInfo</span><span class="p">(</span><span class="n">create_app</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">create_app</span><span class="p">)</span>
    388. 

  388.         <span class="n">kwargs</span><span class="p">[</span><span class="s1">&#39;obj&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">obj</span>
    389. 

  389.         <span class="n">kwargs</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="s1">&#39;auto_envvar_prefix&#39;</span><span class="p">,</span> <span class="s1">&#39;FLASK&#39;</span><span class="p">)</span>
    390. 

  390.         <span class="k">return</span> <span class="n">AppGroup</span><span class="o">.</span><span class="n">main</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></div></div>
    391. 

  391. 

  392. 

  393. <span class="nd">@click</span><span class="o">.</span><span class="n">command</span><span class="p">(</span><span class="s1">&#39;run&#39;</span><span class="p">,</span> <span class="n">short_help</span><span class="o">=</span><span class="s1">&#39;Runs a development server.&#39;</span><span class="p">)</span>
    394. 

  394. <span class="nd">@click</span><span class="o">.</span><span class="n">option</span><span class="p">(</span><span class="s1">&#39;--host&#39;</span><span class="p">,</span> <span class="s1">&#39;-h&#39;</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s1">&#39;127.0.0.1&#39;</span><span class="p">,</span>
    395. 

  395.               <span class="n">help</span><span class="o">=</span><span class="s1">&#39;The interface to bind to.&#39;</span><span class="p">)</span>
    396. 

  396. <span class="nd">@click</span><span class="o">.</span><span class="n">option</span><span class="p">(</span><span class="s1">&#39;--port&#39;</span><span class="p">,</span> <span class="s1">&#39;-p&#39;</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="mi">5000</span><span class="p">,</span>
    397. 

  397.               <span class="n">help</span><span class="o">=</span><span class="s1">&#39;The port to bind to.&#39;</span><span class="p">)</span>
    398. 

  398. <span class="nd">@click</span><span class="o">.</span><span class="n">option</span><span class="p">(</span><span class="s1">&#39;--reload/--no-reload&#39;</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    399. 

  399.               <span class="n">help</span><span class="o">=</span><span class="s1">&#39;Enable or disable the reloader.  By default the reloader &#39;</span>
    400. 

  400.               <span class="s1">&#39;is active if debug is enabled.&#39;</span><span class="p">)</span>
    401. 

  401. <span class="nd">@click</span><span class="o">.</span><span class="n">option</span><span class="p">(</span><span class="s1">&#39;--debugger/--no-debugger&#39;</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    402. 

  402.               <span class="n">help</span><span class="o">=</span><span class="s1">&#39;Enable or disable the debugger.  By default the debugger &#39;</span>
    403. 

  403.               <span class="s1">&#39;is active if debug is enabled.&#39;</span><span class="p">)</span>
    404. 

  404. <span class="nd">@click</span><span class="o">.</span><span class="n">option</span><span class="p">(</span><span class="s1">&#39;--eager-loading/--lazy-loader&#39;</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    405. 

  405.               <span class="n">help</span><span class="o">=</span><span class="s1">&#39;Enable or disable eager loading.  By default eager &#39;</span>
    406. 

  406.               <span class="s1">&#39;loading is enabled if the reloader is disabled.&#39;</span><span class="p">)</span>
    407. 

  407. <span class="nd">@click</span><span class="o">.</span><span class="n">option</span><span class="p">(</span><span class="s1">&#39;--with-threads/--without-threads&#39;</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
    408. 

  408.               <span class="n">help</span><span class="o">=</span><span class="s1">&#39;Enable or disable multithreading.&#39;</span><span class="p">)</span>
    409. 

  409. <span class="nd">@pass_script_info</span>
    410. 

  410. <span class="k">def</span> <span class="nf">run_command</span><span class="p">(</span><span class="n">info</span><span class="p">,</span> <span class="n">host</span><span class="p">,</span> <span class="n">port</span><span class="p">,</span> <span class="n">reload</span><span class="p">,</span> <span class="n">debugger</span><span class="p">,</span> <span class="n">eager_loading</span><span class="p">,</span>
    411. 

  411.                 <span class="n">with_threads</span><span class="p">):</span>
    412. 

  412.     <span class="sd">&quot;&quot;&quot;Runs a local development server for the Flask application.</span>
    413. 

  413. 

  414. <span class="sd">    This local server is recommended for development purposes only but it</span>
    415. 

  415. <span class="sd">    can also be used for simple intranet deployments.  By default it will</span>
    416. 

  416. <span class="sd">    not support any sort of concurrency at all to simplify debugging.  This</span>
    417. 

  417. <span class="sd">    can be changed with the --with-threads option which will enable basic</span>
    418. 

  418. <span class="sd">    multithreading.</span>
    419. 

  419. 

  420. <span class="sd">    The reloader and debugger are by default enabled if the debug flag of</span>
    421. 

  421. <span class="sd">    Flask is enabled and disabled otherwise.</span>
    422. 

  422. <span class="sd">    &quot;&quot;&quot;</span>
    423. 

  423.     <span class="kn">from</span> <span class="nn">werkzeug.serving</span> <span class="k">import</span> <span class="n">run_simple</span>
    424. 

  424. 

  425.     <span class="n">debug</span> <span class="o">=</span> <span class="n">get_debug_flag</span><span class="p">()</span>
    426. 

  426.     <span class="k">if</span> <span class="n">reload</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    427. 

  427.         <span class="n">reload</span> <span class="o">=</span> <span class="nb">bool</span><span class="p">(</span><span class="n">debug</span><span class="p">)</span>
    428. 

  428.     <span class="k">if</span> <span class="n">debugger</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    429. 

  429.         <span class="n">debugger</span> <span class="o">=</span> <span class="nb">bool</span><span class="p">(</span><span class="n">debug</span><span class="p">)</span>
    430. 

  430.     <span class="k">if</span> <span class="n">eager_loading</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    431. 

  431.         <span class="n">eager_loading</span> <span class="o">=</span> <span class="ow">not</span> <span class="n">reload</span>
    432. 

  432. 

  433.     <span class="n">app</span> <span class="o">=</span> <span class="n">DispatchingApp</span><span class="p">(</span><span class="n">info</span><span class="o">.</span><span class="n">load_app</span><span class="p">,</span> <span class="n">use_eager_loading</span><span class="o">=</span><span class="n">eager_loading</span><span class="p">)</span>
    434. 

  434. 

  435.     <span class="c1"># Extra startup messages.  This depends a but on Werkzeug internals to</span>
    436. 

  436.     <span class="c1"># not double execute when the reloader kicks in.</span>
    437. 

  437.     <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;WERKZEUG_RUN_MAIN&#39;</span><span class="p">)</span> <span class="o">!=</span> <span class="s1">&#39;true&#39;</span><span class="p">:</span>
    438. 

  438.         <span class="c1"># If we have an import path we can print it out now which can help</span>
    439. 

  439.         <span class="c1"># people understand what&#39;s being served.  If we do not have an</span>
    440. 

  440.         <span class="c1"># import path because the app was loaded through a callback then</span>
    441. 

  441.         <span class="c1"># we won&#39;t print anything.</span>
    442. 

  442.         <span class="k">if</span> <span class="n">info</span><span class="o">.</span><span class="n">app_import_path</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    443. 

  443.             <span class="nb">print</span><span class="p">(</span><span class="s1">&#39; * Serving Flask app &quot;</span><span class="si">%s</span><span class="s1">&quot;&#39;</span> <span class="o">%</span> <span class="n">info</span><span class="o">.</span><span class="n">app_import_path</span><span class="p">)</span>
    444. 

  444.         <span class="k">if</span> <span class="n">debug</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    445. 

  445.             <span class="nb">print</span><span class="p">(</span><span class="s1">&#39; * Forcing debug mode </span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">debug</span> <span class="ow">and</span> <span class="s1">&#39;on&#39;</span> <span class="ow">or</span> <span class="s1">&#39;off&#39;</span><span class="p">))</span>
    446. 

  446. 

  447.     <span class="n">run_simple</span><span class="p">(</span><span class="n">host</span><span class="p">,</span> <span class="n">port</span><span class="p">,</span> <span class="n">app</span><span class="p">,</span> <span class="n">use_reloader</span><span class="o">=</span><span class="n">reload</span><span class="p">,</span>
    448. 

  448.                <span class="n">use_debugger</span><span class="o">=</span><span class="n">debugger</span><span class="p">,</span> <span class="n">threaded</span><span class="o">=</span><span class="n">with_threads</span><span class="p">)</span>
    449. 

  449. 

  450. 

  451. <span class="nd">@click</span><span class="o">.</span><span class="n">command</span><span class="p">(</span><span class="s1">&#39;shell&#39;</span><span class="p">,</span> <span class="n">short_help</span><span class="o">=</span><span class="s1">&#39;Runs a shell in the app context.&#39;</span><span class="p">)</span>
    452. 

  452. <span class="nd">@with_appcontext</span>
    453. 

  453. <span class="k">def</span> <span class="nf">shell_command</span><span class="p">():</span>
    454. 

  454.     <span class="sd">&quot;&quot;&quot;Runs an interactive Python shell in the context of a given</span>
    455. 

  455. <span class="sd">    Flask application.  The application will populate the default</span>
    456. 

  456. <span class="sd">    namespace of this shell according to it&#39;s configuration.</span>
    457. 

  457. 

  458. <span class="sd">    This is useful for executing small snippets of management code</span>
    459. 

  459. <span class="sd">    without having to manually configuring the application.</span>
    460. 

  460. <span class="sd">    &quot;&quot;&quot;</span>
    461. 

  461.     <span class="kn">import</span> <span class="nn">code</span>
    462. 

  462.     <span class="kn">from</span> <span class="nn">flask.globals</span> <span class="k">import</span> <span class="n">_app_ctx_stack</span>
    463. 

  463.     <span class="n">app</span> <span class="o">=</span> <span class="n">_app_ctx_stack</span><span class="o">.</span><span class="n">top</span><span class="o">.</span><span class="n">app</span>
    464. 

  464.     <span class="n">banner</span> <span class="o">=</span> <span class="s1">&#39;Python </span><span class="si">%s</span><span class="s1"> on </span><span class="si">%s</span><span class="se">\n</span><span class="s1">App: </span><span class="si">%s%s</span><span class="se">\n</span><span class="s1">Instance: </span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="p">(</span>
    465. 

  465.         <span class="n">sys</span><span class="o">.</span><span class="n">version</span><span class="p">,</span>
    466. 

  466.         <span class="n">sys</span><span class="o">.</span><span class="n">platform</span><span class="p">,</span>
    467. 

  467.         <span class="n">app</span><span class="o">.</span><span class="n">import_name</span><span class="p">,</span>
    468. 

  468.         <span class="n">app</span><span class="o">.</span><span class="n">debug</span> <span class="ow">and</span> <span class="s1">&#39; [debug]&#39;</span> <span class="ow">or</span> <span class="s1">&#39;&#39;</span><span class="p">,</span>
    469. 

  469.         <span class="n">app</span><span class="o">.</span><span class="n">instance_path</span><span class="p">,</span>
    470. 

  470.     <span class="p">)</span>
    471. 

  471.     <span class="n">ctx</span> <span class="o">=</span> <span class="p">{}</span>
    472. 

  472. 

  473.     <span class="c1"># Support the regular Python interpreter startup script if someone</span>
    474. 

  474.     <span class="c1"># is using it.</span>
    475. 

  475.     <span class="n">startup</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;PYTHONSTARTUP&#39;</span><span class="p">)</span>
    476. 

  476.     <span class="k">if</span> <span class="n">startup</span> <span class="ow">and</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">startup</span><span class="p">):</span>
    477. 

  477.         <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">startup</span><span class="p">,</span> <span class="s1">&#39;r&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
    478. 

  478.             <span class="nb">eval</span><span class="p">(</span><span class="nb">compile</span><span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">(),</span> <span class="n">startup</span><span class="p">,</span> <span class="s1">&#39;exec&#39;</span><span class="p">),</span> <span class="n">ctx</span><span class="p">)</span>
    479. 

  479. 

  480.     <span class="n">ctx</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">app</span><span class="o">.</span><span class="n">make_shell_context</span><span class="p">())</span>
    481. 

  481. 

  482.     <span class="n">code</span><span class="o">.</span><span class="n">interact</span><span class="p">(</span><span class="n">banner</span><span class="o">=</span><span class="n">banner</span><span class="p">,</span> <span class="n">local</span><span class="o">=</span><span class="n">ctx</span><span class="p">)</span>
    483. 

  483. 

  484. 

  485. <span class="n">cli</span> <span class="o">=</span> <span class="n">FlaskGroup</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">&quot;&quot;&quot;</span><span class="se">\</span>
    486. 

  486. <span class="s2">This shell command acts as general utility script for Flask applications.</span>
    487. 

  487. 

  488. <span class="s2">It loads the application configured (either through the FLASK_APP environment</span>
    489. 

  489. <span class="s2">variable) and then provides commands either provided by the application or</span>
    490. 

  490. <span class="s2">Flask itself.</span>
    491. 

  491. 

  492. <span class="s2">The most useful commands are the &quot;run&quot; and &quot;shell&quot; command.</span>
    493. 

  493. 

  494. <span class="s2">Example usage:</span>
    495. 

  495. 

  496. <span class="se">\b</span><span class="s2"></span>
    497. 

  497. <span class="s2">  </span><span class="si">%(prefix)s%(cmd)s</span><span class="s2"> FLASK_APP=hello</span>
    498. 

  498. <span class="s2">  </span><span class="si">%(prefix)s%(cmd)s</span><span class="s2"> FLASK_DEBUG=1</span>
    499. 

  499. <span class="s2">  </span><span class="si">%(prefix)s</span><span class="s2">flask run</span>
    500. 

  500. <span class="s2">&quot;&quot;&quot;</span> <span class="o">%</span> <span class="p">{</span>
    501. 

  501.     <span class="s1">&#39;cmd&#39;</span><span class="p">:</span> <span class="n">os</span><span class="o">.</span><span class="n">name</span> <span class="o">==</span> <span class="s1">&#39;posix&#39;</span> <span class="ow">and</span> <span class="s1">&#39;export&#39;</span> <span class="ow">or</span> <span class="s1">&#39;set&#39;</span><span class="p">,</span>
    502. 

  502.     <span class="s1">&#39;prefix&#39;</span><span class="p">:</span> <span class="n">os</span><span class="o">.</span><span class="n">name</span> <span class="o">==</span> <span class="s1">&#39;posix&#39;</span> <span class="ow">and</span> <span class="s1">&#39;$ &#39;</span> <span class="ow">or</span> <span class="s1">&#39;&#39;</span><span class="p">,</span>
    503. 

  503. <span class="p">})</span>
    504. 

  504. 

  505. 

  506. <div class="viewcode-block" id="main"><a class="viewcode-back" href="../../flask/flask.html#flask.cli.main">[docs]</a><span class="k">def</span> <span class="nf">main</span><span class="p">(</span><span class="n">as_module</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
    507. 

  507.     <span class="n">this_module</span> <span class="o">=</span> <span class="n">__package__</span> <span class="o">+</span> <span class="s1">&#39;.cli&#39;</span>
    508. 

  508.     <span class="n">args</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span>
    509. 

  509. 

  510.     <span class="k">if</span> <span class="n">as_module</span><span class="p">:</span>
    511. 

  511.         <span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span> <span class="o">&gt;=</span> <span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">7</span><span class="p">):</span>
    512. 

  512.             <span class="n">name</span> <span class="o">=</span> <span class="s1">&#39;python -m &#39;</span> <span class="o">+</span> <span class="n">this_module</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>
    513. 

  513.         <span class="k">else</span><span class="p">:</span>
    514. 

  514.             <span class="n">name</span> <span class="o">=</span> <span class="s1">&#39;python -m &#39;</span> <span class="o">+</span> <span class="n">this_module</span>
    515. 

  515. 

  516.         <span class="c1"># This module is always executed as &quot;python -m flask.run&quot; and as such</span>
    517. 

  517.         <span class="c1"># we need to ensure that we restore the actual command line so that</span>
    518. 

  518.         <span class="c1"># the reloader can properly operate.</span>
    519. 

  519.         <span class="n">sys</span><span class="o">.</span><span class="n">argv</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;-m&#39;</span><span class="p">,</span> <span class="n">this_module</span><span class="p">]</span> <span class="o">+</span> <span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span>
    520. 

  520.     <span class="k">else</span><span class="p">:</span>
    521. 

  521.         <span class="n">name</span> <span class="o">=</span> <span class="kc">None</span>
    522. 

  522. 

  523.     <span class="n">cli</span><span class="o">.</span><span class="n">main</span><span class="p">(</span><span class="n">args</span><span class="o">=</span><span class="n">args</span><span class="p">,</span> <span class="n">prog_name</span><span class="o">=</span><span class="n">name</span><span class="p">)</span></div>
    524. 

  524. 

  525. 

  526. <span class="k">if</span> <span class="n">__name__</span> <span class="o">==</span> <span class="s1">&#39;__main__&#39;</span><span class="p">:</span>
    527. 

  527.     <span class="n">main</span><span class="p">(</span><span class="n">as_module</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
    528. 

  528. </pre></div>
    529. 

  529. 

  530.           </div>
    531. 

  531.         </div>
    532. 

  532.       </div>
    533. 

  533.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
    534. 

  534.         <div class="sphinxsidebarwrapper"><div class="relations">
    535. 

  535. <h3>Related Topics</h3>
    536. 

  536. <ul>
    537. 

  537.   <li><a href="../../index.html">Documentation overview</a><ul>
    538. 

  538.   <li><a href="../index.html">Module code</a><ul>
    539. 

  539.   </ul></li>
    540. 

  540.   </ul></li>
    541. 

  541. </ul>
    542. 

  542. </div>
    543. 

  543. <div id="searchbox" style="display: none" role="search">
    544. 

  544.   <h3>Quick search</h3>
    545. 

  545.     <form class="search" action="../../search.html" method="get">
    546. 

  546.       <div><input type="text" name="q" /></div>
    547. 

  547.       <div><input type="submit" value="Go" /></div>
    548. 

  548.       <input type="hidden" name="check_keywords" value="yes" />
    549. 

  549.       <input type="hidden" name="area" value="default" />
    550. 

  550.     </form>
    551. 

  551. </div>
    552. 

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

  553.         </div>
    554. 

  554.       </div>
    555. 

  555.       <div class="clearer"></div>
    556. 

  556.     </div>
    557. 

  557.     <div class="footer">
    558. 

  558.       &copy;2016, Author.
    559. 

  559.       
    560. 

  560.       |
    561. 

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

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

  563.       
    564. 

  564.     </div>
    565. 

  565. 

  566.     
    567. 

  567. 

  568.     
    569. 

  569.   </body>
    570. 

  570. </html>
    571.