| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-
- <title>flask.config — proxypool documentation</title>
-
- <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
- <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
-
- <script type="text/javascript">
- var DOCUMENTATION_OPTIONS = {
- URL_ROOT: '../../',
- VERSION: '',
- COLLAPSE_INDEX: false,
- FILE_SUFFIX: '.html',
- HAS_SOURCE: true
- };
- </script>
- <script type="text/javascript" src="../../_static/jquery.js"></script>
- <script type="text/javascript" src="../../_static/underscore.js"></script>
- <script type="text/javascript" src="../../_static/doctools.js"></script>
- <link rel="index" title="Index" href="../../genindex.html" />
- <link rel="search" title="Search" href="../../search.html" />
- <link rel="top" title="proxypool documentation" href="../../index.html" />
- <link rel="up" title="Module code" href="../index.html" />
-
- <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
-
-
- <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head>
- <body role="document">
-
- <div class="document">
- <div class="documentwrapper">
- <div class="bodywrapper">
- <div class="body" role="main">
-
- <h1>Source code for flask.config</h1><div class="highlight"><pre>
- <span></span><span class="c1"># -*- coding: utf-8 -*-</span>
- <span class="sd">"""</span>
- <span class="sd"> flask.config</span>
- <span class="sd"> ~~~~~~~~~~~~</span>
- <span class="sd"> Implements the configuration related objects.</span>
- <span class="sd"> :copyright: (c) 2015 by Armin Ronacher.</span>
- <span class="sd"> :license: BSD, see LICENSE for more details.</span>
- <span class="sd">"""</span>
- <span class="kn">import</span> <span class="nn">os</span>
- <span class="kn">import</span> <span class="nn">types</span>
- <span class="kn">import</span> <span class="nn">errno</span>
- <span class="kn">from</span> <span class="nn">werkzeug.utils</span> <span class="k">import</span> <span class="n">import_string</span>
- <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>
- <span class="kn">from</span> <span class="nn">.</span> <span class="k">import</span> <span class="n">json</span>
- <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>
- <span class="sd">"""Makes an attribute forward to the config"""</span>
- <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>
- <span class="bp">self</span><span class="o">.</span><span class="n">__name__</span> <span class="o">=</span> <span class="n">name</span>
- <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>
- <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>
- <span class="k">if</span> <span class="n">obj</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
- <span class="k">return</span> <span class="bp">self</span>
- <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>
- <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>
- <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>
- <span class="k">return</span> <span class="n">rv</span>
- <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>
- <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>
- <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>
- <span class="sd">"""Works exactly like a dict but provides ways to fill it from files</span>
- <span class="sd"> or special dictionaries. There are two common patterns to populate the</span>
- <span class="sd"> config.</span>
- <span class="sd"> Either you can fill the config from a config file::</span>
- <span class="sd"> app.config.from_pyfile('yourconfig.cfg')</span>
- <span class="sd"> Or alternatively you can define the configuration options in the</span>
- <span class="sd"> module that calls :meth:`from_object` or provide an import path to</span>
- <span class="sd"> a module that should be loaded. It is also possible to tell it to</span>
- <span class="sd"> use the same module and with that provide the configuration values</span>
- <span class="sd"> just before the call::</span>
- <span class="sd"> DEBUG = True</span>
- <span class="sd"> SECRET_KEY = 'development key'</span>
- <span class="sd"> app.config.from_object(__name__)</span>
- <span class="sd"> In both cases (loading from any Python file or loading from modules),</span>
- <span class="sd"> only uppercase keys are added to the config. This makes it possible to use</span>
- <span class="sd"> lowercase values in the config file for temporary values that are not added</span>
- <span class="sd"> to the config or to define the config keys in the same file that implements</span>
- <span class="sd"> the application.</span>
- <span class="sd"> Probably the most interesting way to load configurations is from an</span>
- <span class="sd"> environment variable pointing to a file::</span>
- <span class="sd"> app.config.from_envvar('YOURAPPLICATION_SETTINGS')</span>
- <span class="sd"> In this case before launching the application you have to set this</span>
- <span class="sd"> environment variable to the file you want to use. On Linux and OS X</span>
- <span class="sd"> use the export statement::</span>
- <span class="sd"> export YOURAPPLICATION_SETTINGS='/path/to/config/file'</span>
- <span class="sd"> On windows use `set` instead.</span>
- <span class="sd"> :param root_path: path to which files are read relative from. When the</span>
- <span class="sd"> config object is created by the application, this is</span>
- <span class="sd"> the application's :attr:`~flask.Flask.root_path`.</span>
- <span class="sd"> :param defaults: an optional dictionary of default values</span>
- <span class="sd"> """</span>
- <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>
- <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>
- <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>
- <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>
- <span class="sd">"""Loads a configuration from an environment variable pointing to</span>
- <span class="sd"> a configuration file. This is basically just a shortcut with nicer</span>
- <span class="sd"> error messages for this line of code::</span>
- <span class="sd"> app.config.from_pyfile(os.environ['YOURAPPLICATION_SETTINGS'])</span>
- <span class="sd"> :param variable_name: name of the environment variable</span>
- <span class="sd"> :param silent: set to ``True`` if you want silent failure for missing</span>
- <span class="sd"> files.</span>
- <span class="sd"> :return: bool. ``True`` if able to load config, ``False`` otherwise.</span>
- <span class="sd"> """</span>
- <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>
- <span class="k">if</span> <span class="ow">not</span> <span class="n">rv</span><span class="p">:</span>
- <span class="k">if</span> <span class="n">silent</span><span class="p">:</span>
- <span class="k">return</span> <span class="kc">False</span>
- <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s1">'The environment variable </span><span class="si">%r</span><span class="s1"> is not set '</span>
- <span class="s1">'and as such configuration could not be '</span>
- <span class="s1">'loaded. Set this variable and make it '</span>
- <span class="s1">'point to a configuration file'</span> <span class="o">%</span>
- <span class="n">variable_name</span><span class="p">)</span>
- <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>
- <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>
- <span class="sd">"""Updates the values in the config from a Python file. This function</span>
- <span class="sd"> behaves as if the file was imported as module with the</span>
- <span class="sd"> :meth:`from_object` function.</span>
- <span class="sd"> :param filename: the filename of the config. This can either be an</span>
- <span class="sd"> absolute filename or a filename relative to the</span>
- <span class="sd"> root path.</span>
- <span class="sd"> :param silent: set to ``True`` if you want silent failure for missing</span>
- <span class="sd"> files.</span>
- <span class="sd"> .. versionadded:: 0.7</span>
- <span class="sd"> `silent` parameter.</span>
- <span class="sd"> """</span>
- <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>
- <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">'config'</span><span class="p">)</span>
- <span class="n">d</span><span class="o">.</span><span class="n">__file__</span> <span class="o">=</span> <span class="n">filename</span>
- <span class="k">try</span><span class="p">:</span>
- <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>
- <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">'exec'</span><span class="p">),</span> <span class="n">d</span><span class="o">.</span><span class="n">__dict__</span><span class="p">)</span>
- <span class="k">except</span> <span class="ne">IOError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
- <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>
- <span class="k">return</span> <span class="kc">False</span>
- <span class="n">e</span><span class="o">.</span><span class="n">strerror</span> <span class="o">=</span> <span class="s1">'Unable to load configuration file (</span><span class="si">%s</span><span class="s1">)'</span> <span class="o">%</span> <span class="n">e</span><span class="o">.</span><span class="n">strerror</span>
- <span class="k">raise</span>
- <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>
- <span class="k">return</span> <span class="kc">True</span></div>
- <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>
- <span class="sd">"""Updates the values from the given object. An object can be of one</span>
- <span class="sd"> of the following two types:</span>
- <span class="sd"> - a string: in this case the object with that name will be imported</span>
- <span class="sd"> - an actual object reference: that object is used directly</span>
- <span class="sd"> Objects are usually either modules or classes.</span>
- <span class="sd"> Just the uppercase variables in that object are stored in the config.</span>
- <span class="sd"> Example usage::</span>
- <span class="sd"> app.config.from_object('yourapplication.default_config')</span>
- <span class="sd"> from yourapplication import default_config</span>
- <span class="sd"> app.config.from_object(default_config)</span>
- <span class="sd"> You should not use this function to load the actual configuration but</span>
- <span class="sd"> rather configuration defaults. The actual config should be loaded</span>
- <span class="sd"> with :meth:`from_pyfile` and ideally from a location not within the</span>
- <span class="sd"> package because the package might be installed system wide.</span>
- <span class="sd"> :param obj: an import name or object</span>
- <span class="sd"> """</span>
- <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>
- <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>
- <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>
- <span class="k">if</span> <span class="n">key</span><span class="o">.</span><span class="n">isupper</span><span class="p">():</span>
- <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>
- <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>
- <span class="sd">"""Updates the values in the config from a JSON file. This function</span>
- <span class="sd"> behaves as if the JSON object was a dictionary and passed to the</span>
- <span class="sd"> :meth:`from_mapping` function.</span>
- <span class="sd"> :param filename: the filename of the JSON file. This can either be an</span>
- <span class="sd"> absolute filename or a filename relative to the</span>
- <span class="sd"> root path.</span>
- <span class="sd"> :param silent: set to ``True`` if you want silent failure for missing</span>
- <span class="sd"> files.</span>
- <span class="sd"> .. versionadded:: 0.11</span>
- <span class="sd"> """</span>
- <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>
- <span class="k">try</span><span class="p">:</span>
- <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>
- <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>
- <span class="k">except</span> <span class="ne">IOError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
- <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>
- <span class="k">return</span> <span class="kc">False</span>
- <span class="n">e</span><span class="o">.</span><span class="n">strerror</span> <span class="o">=</span> <span class="s1">'Unable to load configuration file (</span><span class="si">%s</span><span class="s1">)'</span> <span class="o">%</span> <span class="n">e</span><span class="o">.</span><span class="n">strerror</span>
- <span class="k">raise</span>
- <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>
- <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>
- <span class="sd">"""Updates the config like :meth:`update` ignoring items with non-upper</span>
- <span class="sd"> keys.</span>
- <span class="sd"> .. versionadded:: 0.11</span>
- <span class="sd"> """</span>
- <span class="n">mappings</span> <span class="o">=</span> <span class="p">[]</span>
- <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>
- <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">'items'</span><span class="p">):</span>
- <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>
- <span class="k">else</span><span class="p">:</span>
- <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="k">elif</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>
- <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span>
- <span class="s1">'expected at most 1 positional argument, got </span><span class="si">%d</span><span class="s1">'</span> <span class="o">%</span> <span class="nb">len</span><span class="p">(</span><span class="n">mapping</span><span class="p">)</span>
- <span class="p">)</span>
- <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>
- <span class="k">for</span> <span class="n">mapping</span> <span class="ow">in</span> <span class="n">mappings</span><span class="p">:</span>
- <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>
- <span class="k">if</span> <span class="n">key</span><span class="o">.</span><span class="n">isupper</span><span class="p">():</span>
- <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>
- <span class="k">return</span> <span class="kc">True</span></div>
- <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>
- <span class="sd">"""Returns a dictionary containing a subset of configuration options</span>
- <span class="sd"> that match the specified namespace/prefix. Example usage::</span>
- <span class="sd"> app.config['IMAGE_STORE_TYPE'] = 'fs'</span>
- <span class="sd"> app.config['IMAGE_STORE_PATH'] = '/var/app/images'</span>
- <span class="sd"> app.config['IMAGE_STORE_BASE_URL'] = 'http://img.website.com'</span>
- <span class="sd"> image_store_config = app.config.get_namespace('IMAGE_STORE_')</span>
- <span class="sd"> The resulting dictionary `image_store_config` would look like::</span>
- <span class="sd"> {</span>
- <span class="sd"> 'type': 'fs',</span>
- <span class="sd"> 'path': '/var/app/images',</span>
- <span class="sd"> 'base_url': 'http://img.website.com'</span>
- <span class="sd"> }</span>
- <span class="sd"> This is often useful when configuration options map directly to</span>
- <span class="sd"> keyword arguments in functions or class constructors.</span>
- <span class="sd"> :param namespace: a configuration namespace</span>
- <span class="sd"> :param lowercase: a flag indicating if the keys of the resulting</span>
- <span class="sd"> dictionary should be lowercase</span>
- <span class="sd"> :param trim_namespace: a flag indicating if the keys of the resulting</span>
- <span class="sd"> dictionary should not include the namespace</span>
- <span class="sd"> .. versionadded:: 0.11</span>
- <span class="sd"> """</span>
- <span class="n">rv</span> <span class="o">=</span> <span class="p">{}</span>
- <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">iteritems</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
- <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>
- <span class="k">continue</span>
- <span class="k">if</span> <span class="n">trim_namespace</span><span class="p">:</span>
- <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>
- <span class="k">else</span><span class="p">:</span>
- <span class="n">key</span> <span class="o">=</span> <span class="n">k</span>
- <span class="k">if</span> <span class="n">lowercase</span><span class="p">:</span>
- <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>
- <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>
- <span class="k">return</span> <span class="n">rv</span></div>
- <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
- <span class="k">return</span> <span class="s1">'<</span><span class="si">%s</span><span class="s1"> </span><span class="si">%s</span><span class="s1">>'</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>
- </pre></div>
- </div>
- </div>
- </div>
- <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
- <div class="sphinxsidebarwrapper"><div class="relations">
- <h3>Related Topics</h3>
- <ul>
- <li><a href="../../index.html">Documentation overview</a><ul>
- <li><a href="../index.html">Module code</a><ul>
- </ul></li>
- </ul></li>
- </ul>
- </div>
- <div id="searchbox" style="display: none" role="search">
- <h3>Quick search</h3>
- <form class="search" action="../../search.html" method="get">
- <div><input type="text" name="q" /></div>
- <div><input type="submit" value="Go" /></div>
- <input type="hidden" name="check_keywords" value="yes" />
- <input type="hidden" name="area" value="default" />
- </form>
- </div>
- <script type="text/javascript">$('#searchbox').show(0);</script>
- </div>
- </div>
- <div class="clearer"></div>
- </div>
- <div class="footer">
- ©2016, Author.
-
- |
- Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.8</a>
- & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.9</a>
-
- </div>
-
-
- </body>
- </html>
|