config.html 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <title>flask.config &#8212; proxypool documentation</title>
  7. <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
  8. <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
  9. <script type="text/javascript">
  10. var DOCUMENTATION_OPTIONS = {
  11. URL_ROOT: '../../',
  12. VERSION: '',
  13. COLLAPSE_INDEX: false,
  14. FILE_SUFFIX: '.html',
  15. HAS_SOURCE: true
  16. };
  17. </script>
  18. <script type="text/javascript" src="../../_static/jquery.js"></script>
  19. <script type="text/javascript" src="../../_static/underscore.js"></script>
  20. <script type="text/javascript" src="../../_static/doctools.js"></script>
  21. <link rel="index" title="Index" href="../../genindex.html" />
  22. <link rel="search" title="Search" href="../../search.html" />
  23. <link rel="top" title="proxypool documentation" href="../../index.html" />
  24. <link rel="up" title="Module code" href="../index.html" />
  25. <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
  26. <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
  27. </head>
  28. <body role="document">
  29. <div class="document">
  30. <div class="documentwrapper">
  31. <div class="bodywrapper">
  32. <div class="body" role="main">
  33. <h1>Source code for flask.config</h1><div class="highlight"><pre>
  34. <span></span><span class="c1"># -*- coding: utf-8 -*-</span>
  35. <span class="sd">&quot;&quot;&quot;</span>
  36. <span class="sd"> flask.config</span>
  37. <span class="sd"> ~~~~~~~~~~~~</span>
  38. <span class="sd"> Implements the configuration related objects.</span>
  39. <span class="sd"> :copyright: (c) 2015 by Armin Ronacher.</span>
  40. <span class="sd"> :license: BSD, see LICENSE for more details.</span>
  41. <span class="sd">&quot;&quot;&quot;</span>
  42. <span class="kn">import</span> <span class="nn">os</span>
  43. <span class="kn">import</span> <span class="nn">types</span>
  44. <span class="kn">import</span> <span class="nn">errno</span>
  45. <span class="kn">from</span> <span class="nn">werkzeug.utils</span> <span class="k">import</span> <span class="n">import_string</span>
  46. <span class="kn">from</span> <span class="nn">._compat</span> <span class="k">import</span> <span class="n">string_types</span><span class="p">,</span> <span class="n">iteritems</span>
  47. <span class="kn">from</span> <span class="nn">.</span> <span class="k">import</span> <span class="n">json</span>
  48. <div class="viewcode-block" id="ConfigAttribute"><a class="viewcode-back" href="../../flask/flask.html#flask.app.ConfigAttribute">[docs]</a><span class="k">class</span> <span class="nc">ConfigAttribute</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
  49. <span class="sd">&quot;&quot;&quot;Makes an attribute forward to the config&quot;&quot;&quot;</span>
  50. <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">name</span><span class="p">,</span> <span class="n">get_converter</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
  51. <span class="bp">self</span><span class="o">.</span><span class="n">__name__</span> <span class="o">=</span> <span class="n">name</span>
  52. <span class="bp">self</span><span class="o">.</span><span class="n">get_converter</span> <span class="o">=</span> <span class="n">get_converter</span>
  53. <span class="k">def</span> <span class="nf">__get__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
  54. <span class="k">if</span> <span class="n">obj</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
  55. <span class="k">return</span> <span class="bp">self</span>
  56. <span class="n">rv</span> <span class="o">=</span> <span class="n">obj</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">__name__</span><span class="p">]</span>
  57. <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_converter</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
  58. <span class="n">rv</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_converter</span><span class="p">(</span><span class="n">rv</span><span class="p">)</span>
  59. <span class="k">return</span> <span class="n">rv</span>
  60. <span class="k">def</span> <span class="nf">__set__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
  61. <span class="n">obj</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">__name__</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span></div>
  62. <div class="viewcode-block" id="Config"><a class="viewcode-back" href="../../flask/flask.html#flask.app.Config">[docs]</a><span class="k">class</span> <span class="nc">Config</span><span class="p">(</span><span class="nb">dict</span><span class="p">):</span>
  63. <span class="sd">&quot;&quot;&quot;Works exactly like a dict but provides ways to fill it from files</span>
  64. <span class="sd"> or special dictionaries. There are two common patterns to populate the</span>
  65. <span class="sd"> config.</span>
  66. <span class="sd"> Either you can fill the config from a config file::</span>
  67. <span class="sd"> app.config.from_pyfile(&#39;yourconfig.cfg&#39;)</span>
  68. <span class="sd"> Or alternatively you can define the configuration options in the</span>
  69. <span class="sd"> module that calls :meth:`from_object` or provide an import path to</span>
  70. <span class="sd"> a module that should be loaded. It is also possible to tell it to</span>
  71. <span class="sd"> use the same module and with that provide the configuration values</span>
  72. <span class="sd"> just before the call::</span>
  73. <span class="sd"> DEBUG = True</span>
  74. <span class="sd"> SECRET_KEY = &#39;development key&#39;</span>
  75. <span class="sd"> app.config.from_object(__name__)</span>
  76. <span class="sd"> In both cases (loading from any Python file or loading from modules),</span>
  77. <span class="sd"> only uppercase keys are added to the config. This makes it possible to use</span>
  78. <span class="sd"> lowercase values in the config file for temporary values that are not added</span>
  79. <span class="sd"> to the config or to define the config keys in the same file that implements</span>
  80. <span class="sd"> the application.</span>
  81. <span class="sd"> Probably the most interesting way to load configurations is from an</span>
  82. <span class="sd"> environment variable pointing to a file::</span>
  83. <span class="sd"> app.config.from_envvar(&#39;YOURAPPLICATION_SETTINGS&#39;)</span>
  84. <span class="sd"> In this case before launching the application you have to set this</span>
  85. <span class="sd"> environment variable to the file you want to use. On Linux and OS X</span>
  86. <span class="sd"> use the export statement::</span>
  87. <span class="sd"> export YOURAPPLICATION_SETTINGS=&#39;/path/to/config/file&#39;</span>
  88. <span class="sd"> On windows use `set` instead.</span>
  89. <span class="sd"> :param root_path: path to which files are read relative from. When the</span>
  90. <span class="sd"> config object is created by the application, this is</span>
  91. <span class="sd"> the application&#39;s :attr:`~flask.Flask.root_path`.</span>
  92. <span class="sd"> :param defaults: an optional dictionary of default values</span>
  93. <span class="sd"> &quot;&quot;&quot;</span>
  94. <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">root_path</span><span class="p">,</span> <span class="n">defaults</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
  95. <span class="nb">dict</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">defaults</span> <span class="ow">or</span> <span class="p">{})</span>
  96. <span class="bp">self</span><span class="o">.</span><span class="n">root_path</span> <span class="o">=</span> <span class="n">root_path</span>
  97. <div class="viewcode-block" id="Config.from_envvar"><a class="viewcode-back" href="../../flask/flask.html#flask.app.Config.from_envvar">[docs]</a> <span class="k">def</span> <span class="nf">from_envvar</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">variable_name</span><span class="p">,</span> <span class="n">silent</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
  98. <span class="sd">&quot;&quot;&quot;Loads a configuration from an environment variable pointing to</span>
  99. <span class="sd"> a configuration file. This is basically just a shortcut with nicer</span>
  100. <span class="sd"> error messages for this line of code::</span>
  101. <span class="sd"> app.config.from_pyfile(os.environ[&#39;YOURAPPLICATION_SETTINGS&#39;])</span>
  102. <span class="sd"> :param variable_name: name of the environment variable</span>
  103. <span class="sd"> :param silent: set to ``True`` if you want silent failure for missing</span>
  104. <span class="sd"> files.</span>
  105. <span class="sd"> :return: bool. ``True`` if able to load config, ``False`` otherwise.</span>
  106. <span class="sd"> &quot;&quot;&quot;</span>
  107. <span class="n">rv</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="n">variable_name</span><span class="p">)</span>
  108. <span class="k">if</span> <span class="ow">not</span> <span class="n">rv</span><span class="p">:</span>
  109. <span class="k">if</span> <span class="n">silent</span><span class="p">:</span>
  110. <span class="k">return</span> <span class="kc">False</span>
  111. <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s1">&#39;The environment variable </span><span class="si">%r</span><span class="s1"> is not set &#39;</span>
  112. <span class="s1">&#39;and as such configuration could not be &#39;</span>
  113. <span class="s1">&#39;loaded. Set this variable and make it &#39;</span>
  114. <span class="s1">&#39;point to a configuration file&#39;</span> <span class="o">%</span>
  115. <span class="n">variable_name</span><span class="p">)</span>
  116. <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">from_pyfile</span><span class="p">(</span><span class="n">rv</span><span class="p">,</span> <span class="n">silent</span><span class="o">=</span><span class="n">silent</span><span class="p">)</span></div>
  117. <div class="viewcode-block" id="Config.from_pyfile"><a class="viewcode-back" href="../../flask/flask.html#flask.app.Config.from_pyfile">[docs]</a> <span class="k">def</span> <span class="nf">from_pyfile</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename</span><span class="p">,</span> <span class="n">silent</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
  118. <span class="sd">&quot;&quot;&quot;Updates the values in the config from a Python file. This function</span>
  119. <span class="sd"> behaves as if the file was imported as module with the</span>
  120. <span class="sd"> :meth:`from_object` function.</span>
  121. <span class="sd"> :param filename: the filename of the config. This can either be an</span>
  122. <span class="sd"> absolute filename or a filename relative to the</span>
  123. <span class="sd"> root path.</span>
  124. <span class="sd"> :param silent: set to ``True`` if you want silent failure for missing</span>
  125. <span class="sd"> files.</span>
  126. <span class="sd"> .. versionadded:: 0.7</span>
  127. <span class="sd"> `silent` parameter.</span>
  128. <span class="sd"> &quot;&quot;&quot;</span>
  129. <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">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">root_path</span><span class="p">,</span> <span class="n">filename</span><span class="p">)</span>
  130. <span class="n">d</span> <span class="o">=</span> <span class="n">types</span><span class="o">.</span><span class="n">ModuleType</span><span class="p">(</span><span class="s1">&#39;config&#39;</span><span class="p">)</span>
  131. <span class="n">d</span><span class="o">.</span><span class="n">__file__</span> <span class="o">=</span> <span class="n">filename</span>
  132. <span class="k">try</span><span class="p">:</span>
  133. <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span> <span class="k">as</span> <span class="n">config_file</span><span class="p">:</span>
  134. <span class="n">exec</span><span class="p">(</span><span class="nb">compile</span><span class="p">(</span><span class="n">config_file</span><span class="o">.</span><span class="n">read</span><span class="p">(),</span> <span class="n">filename</span><span class="p">,</span> <span class="s1">&#39;exec&#39;</span><span class="p">),</span> <span class="n">d</span><span class="o">.</span><span class="n">__dict__</span><span class="p">)</span>
  135. <span class="k">except</span> <span class="ne">IOError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
  136. <span class="k">if</span> <span class="n">silent</span> <span class="ow">and</span> <span class="n">e</span><span class="o">.</span><span class="n">errno</span> <span class="ow">in</span> <span class="p">(</span><span class="n">errno</span><span class="o">.</span><span class="n">ENOENT</span><span class="p">,</span> <span class="n">errno</span><span class="o">.</span><span class="n">EISDIR</span><span class="p">):</span>
  137. <span class="k">return</span> <span class="kc">False</span>
  138. <span class="n">e</span><span class="o">.</span><span class="n">strerror</span> <span class="o">=</span> <span class="s1">&#39;Unable to load configuration file (</span><span class="si">%s</span><span class="s1">)&#39;</span> <span class="o">%</span> <span class="n">e</span><span class="o">.</span><span class="n">strerror</span>
  139. <span class="k">raise</span>
  140. <span class="bp">self</span><span class="o">.</span><span class="n">from_object</span><span class="p">(</span><span class="n">d</span><span class="p">)</span>
  141. <span class="k">return</span> <span class="kc">True</span></div>
  142. <div class="viewcode-block" id="Config.from_object"><a class="viewcode-back" href="../../flask/flask.html#flask.app.Config.from_object">[docs]</a> <span class="k">def</span> <span class="nf">from_object</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">):</span>
  143. <span class="sd">&quot;&quot;&quot;Updates the values from the given object. An object can be of one</span>
  144. <span class="sd"> of the following two types:</span>
  145. <span class="sd"> - a string: in this case the object with that name will be imported</span>
  146. <span class="sd"> - an actual object reference: that object is used directly</span>
  147. <span class="sd"> Objects are usually either modules or classes.</span>
  148. <span class="sd"> Just the uppercase variables in that object are stored in the config.</span>
  149. <span class="sd"> Example usage::</span>
  150. <span class="sd"> app.config.from_object(&#39;yourapplication.default_config&#39;)</span>
  151. <span class="sd"> from yourapplication import default_config</span>
  152. <span class="sd"> app.config.from_object(default_config)</span>
  153. <span class="sd"> You should not use this function to load the actual configuration but</span>
  154. <span class="sd"> rather configuration defaults. The actual config should be loaded</span>
  155. <span class="sd"> with :meth:`from_pyfile` and ideally from a location not within the</span>
  156. <span class="sd"> package because the package might be installed system wide.</span>
  157. <span class="sd"> :param obj: an import name or object</span>
  158. <span class="sd"> &quot;&quot;&quot;</span>
  159. <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">string_types</span><span class="p">):</span>
  160. <span class="n">obj</span> <span class="o">=</span> <span class="n">import_string</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span>
  161. <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="nb">dir</span><span class="p">(</span><span class="n">obj</span><span class="p">):</span>
  162. <span class="k">if</span> <span class="n">key</span><span class="o">.</span><span class="n">isupper</span><span class="p">():</span>
  163. <span class="bp">self</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">key</span><span class="p">)</span></div>
  164. <div class="viewcode-block" id="Config.from_json"><a class="viewcode-back" href="../../flask/flask.html#flask.app.Config.from_json">[docs]</a> <span class="k">def</span> <span class="nf">from_json</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename</span><span class="p">,</span> <span class="n">silent</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
  165. <span class="sd">&quot;&quot;&quot;Updates the values in the config from a JSON file. This function</span>
  166. <span class="sd"> behaves as if the JSON object was a dictionary and passed to the</span>
  167. <span class="sd"> :meth:`from_mapping` function.</span>
  168. <span class="sd"> :param filename: the filename of the JSON file. This can either be an</span>
  169. <span class="sd"> absolute filename or a filename relative to the</span>
  170. <span class="sd"> root path.</span>
  171. <span class="sd"> :param silent: set to ``True`` if you want silent failure for missing</span>
  172. <span class="sd"> files.</span>
  173. <span class="sd"> .. versionadded:: 0.11</span>
  174. <span class="sd"> &quot;&quot;&quot;</span>
  175. <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">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">root_path</span><span class="p">,</span> <span class="n">filename</span><span class="p">)</span>
  176. <span class="k">try</span><span class="p">:</span>
  177. <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span> <span class="k">as</span> <span class="n">json_file</span><span class="p">:</span>
  178. <span class="n">obj</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">json_file</span><span class="o">.</span><span class="n">read</span><span class="p">())</span>
  179. <span class="k">except</span> <span class="ne">IOError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
  180. <span class="k">if</span> <span class="n">silent</span> <span class="ow">and</span> <span class="n">e</span><span class="o">.</span><span class="n">errno</span> <span class="ow">in</span> <span class="p">(</span><span class="n">errno</span><span class="o">.</span><span class="n">ENOENT</span><span class="p">,</span> <span class="n">errno</span><span class="o">.</span><span class="n">EISDIR</span><span class="p">):</span>
  181. <span class="k">return</span> <span class="kc">False</span>
  182. <span class="n">e</span><span class="o">.</span><span class="n">strerror</span> <span class="o">=</span> <span class="s1">&#39;Unable to load configuration file (</span><span class="si">%s</span><span class="s1">)&#39;</span> <span class="o">%</span> <span class="n">e</span><span class="o">.</span><span class="n">strerror</span>
  183. <span class="k">raise</span>
  184. <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">from_mapping</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span></div>
  185. <div class="viewcode-block" id="Config.from_mapping"><a class="viewcode-back" href="../../flask/flask.html#flask.app.Config.from_mapping">[docs]</a> <span class="k">def</span> <span class="nf">from_mapping</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">mapping</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
  186. <span class="sd">&quot;&quot;&quot;Updates the config like :meth:`update` ignoring items with non-upper</span>
  187. <span class="sd"> keys.</span>
  188. <span class="sd"> .. versionadded:: 0.11</span>
  189. <span class="sd"> &quot;&quot;&quot;</span>
  190. <span class="n">mappings</span> <span class="o">=</span> <span class="p">[]</span>
  191. <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">mapping</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
  192. <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">mapping</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="s1">&#39;items&#39;</span><span class="p">):</span>
  193. <span class="n">mappings</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">mapping</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">items</span><span class="p">())</span>
  194. <span class="k">else</span><span class="p">:</span>
  195. <span class="n">mappings</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">mapping</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
  196. <span class="k">elif</span> <span class="nb">len</span><span class="p">(</span><span class="n">mapping</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
  197. <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span>
  198. <span class="s1">&#39;expected at most 1 positional argument, got </span><span class="si">%d</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="nb">len</span><span class="p">(</span><span class="n">mapping</span><span class="p">)</span>
  199. <span class="p">)</span>
  200. <span class="n">mappings</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">kwargs</span><span class="o">.</span><span class="n">items</span><span class="p">())</span>
  201. <span class="k">for</span> <span class="n">mapping</span> <span class="ow">in</span> <span class="n">mappings</span><span class="p">:</span>
  202. <span class="k">for</span> <span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span> <span class="ow">in</span> <span class="n">mapping</span><span class="p">:</span>
  203. <span class="k">if</span> <span class="n">key</span><span class="o">.</span><span class="n">isupper</span><span class="p">():</span>
  204. <span class="bp">self</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
  205. <span class="k">return</span> <span class="kc">True</span></div>
  206. <div class="viewcode-block" id="Config.get_namespace"><a class="viewcode-back" href="../../flask/flask.html#flask.app.Config.get_namespace">[docs]</a> <span class="k">def</span> <span class="nf">get_namespace</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">namespace</span><span class="p">,</span> <span class="n">lowercase</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">trim_namespace</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
  207. <span class="sd">&quot;&quot;&quot;Returns a dictionary containing a subset of configuration options</span>
  208. <span class="sd"> that match the specified namespace/prefix. Example usage::</span>
  209. <span class="sd"> app.config[&#39;IMAGE_STORE_TYPE&#39;] = &#39;fs&#39;</span>
  210. <span class="sd"> app.config[&#39;IMAGE_STORE_PATH&#39;] = &#39;/var/app/images&#39;</span>
  211. <span class="sd"> app.config[&#39;IMAGE_STORE_BASE_URL&#39;] = &#39;http://img.website.com&#39;</span>
  212. <span class="sd"> image_store_config = app.config.get_namespace(&#39;IMAGE_STORE_&#39;)</span>
  213. <span class="sd"> The resulting dictionary `image_store_config` would look like::</span>
  214. <span class="sd"> {</span>
  215. <span class="sd"> &#39;type&#39;: &#39;fs&#39;,</span>
  216. <span class="sd"> &#39;path&#39;: &#39;/var/app/images&#39;,</span>
  217. <span class="sd"> &#39;base_url&#39;: &#39;http://img.website.com&#39;</span>
  218. <span class="sd"> }</span>
  219. <span class="sd"> This is often useful when configuration options map directly to</span>
  220. <span class="sd"> keyword arguments in functions or class constructors.</span>
  221. <span class="sd"> :param namespace: a configuration namespace</span>
  222. <span class="sd"> :param lowercase: a flag indicating if the keys of the resulting</span>
  223. <span class="sd"> dictionary should be lowercase</span>
  224. <span class="sd"> :param trim_namespace: a flag indicating if the keys of the resulting</span>
  225. <span class="sd"> dictionary should not include the namespace</span>
  226. <span class="sd"> .. versionadded:: 0.11</span>
  227. <span class="sd"> &quot;&quot;&quot;</span>
  228. <span class="n">rv</span> <span class="o">=</span> <span class="p">{}</span>
  229. <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="bp">self</span><span class="p">):</span>
  230. <span class="k">if</span> <span class="ow">not</span> <span class="n">k</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">namespace</span><span class="p">):</span>
  231. <span class="k">continue</span>
  232. <span class="k">if</span> <span class="n">trim_namespace</span><span class="p">:</span>
  233. <span class="n">key</span> <span class="o">=</span> <span class="n">k</span><span class="p">[</span><span class="nb">len</span><span class="p">(</span><span class="n">namespace</span><span class="p">):]</span>
  234. <span class="k">else</span><span class="p">:</span>
  235. <span class="n">key</span> <span class="o">=</span> <span class="n">k</span>
  236. <span class="k">if</span> <span class="n">lowercase</span><span class="p">:</span>
  237. <span class="n">key</span> <span class="o">=</span> <span class="n">key</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
  238. <span class="n">rv</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">v</span>
  239. <span class="k">return</span> <span class="n">rv</span></div>
  240. <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  241. <span class="k">return</span> <span class="s1">&#39;&lt;</span><span class="si">%s</span><span class="s1"> </span><span class="si">%s</span><span class="s1">&gt;&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span><span class="p">,</span> <span class="nb">dict</span><span class="o">.</span><span class="n">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span></div>
  242. </pre></div>
  243. </div>
  244. </div>
  245. </div>
  246. <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  247. <div class="sphinxsidebarwrapper"><div class="relations">
  248. <h3>Related Topics</h3>
  249. <ul>
  250. <li><a href="../../index.html">Documentation overview</a><ul>
  251. <li><a href="../index.html">Module code</a><ul>
  252. </ul></li>
  253. </ul></li>
  254. </ul>
  255. </div>
  256. <div id="searchbox" style="display: none" role="search">
  257. <h3>Quick search</h3>
  258. <form class="search" action="../../search.html" method="get">
  259. <div><input type="text" name="q" /></div>
  260. <div><input type="submit" value="Go" /></div>
  261. <input type="hidden" name="check_keywords" value="yes" />
  262. <input type="hidden" name="area" value="default" />
  263. </form>
  264. </div>
  265. <script type="text/javascript">$('#searchbox').show(0);</script>
  266. </div>
  267. </div>
  268. <div class="clearer"></div>
  269. </div>
  270. <div class="footer">
  271. &copy;2016, Author.
  272. |
  273. Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.8</a>
  274. &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.9</a>
  275. </div>
  276. </body>
  277. </html>