<!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"> <head> <meta http-equiv="X-UA-Compatible" content="IE=Edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>Usage — django-appconf 1.0.2 documentation</title> <link rel="stylesheet" href="_static/classic.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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> <script type="text/javascript" src="_static/language_data.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> <link rel="next" title="Reference" href="reference.html" /> <link rel="prev" title="django-appconf" href="index.html" /> </head><body> <div class="related" role="navigation" aria-label="related navigation"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="reference.html" title="Reference" accesskey="N">next</a> |</li> <li class="right" > <a href="index.html" title="django-appconf" accesskey="P">previous</a> |</li> <li class="nav-item nav-item-0"><a href="index.html">django-appconf 1.0.2 documentation</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body" role="main"> <div class="section" id="usage"> <h1>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h1> <p>It’s strongly recommended to use the usual <code class="docutils literal notranslate"><span class="pre">from</span> <span class="pre">django.conf</span> <span class="pre">import</span> <span class="pre">settings</span></code> in your own code to access the configured settings.</p> <p>But you can also <strong>OPTIONALLY</strong> use your app’s own settings object directly, by instantiating it in place:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">myapp.models</span> <span class="k">import</span> <span class="n">MyAppConf</span> <span class="n">myapp_settings</span> <span class="o">=</span> <span class="n">MyAppConf</span><span class="p">()</span> <span class="nb">print</span> <span class="n">myapp_settings</span><span class="o">.</span><span class="n">SETTING_1</span> </pre></div> </div> <p>Note that accessing the settings that way means they don’t have a prefix.</p> <p><code class="docutils literal notranslate"><span class="pre">AppConf</span></code> instances don’t automatically work as proxies for the global settings. But you can enable this if you want by setting the <code class="docutils literal notranslate"><span class="pre">proxy</span></code> attribute of the inner <code class="docutils literal notranslate"><span class="pre">Meta</span></code> class to <code class="docutils literal notranslate"><span class="pre">True</span></code>:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">appconf</span> <span class="k">import</span> <span class="n">AppConf</span> <span class="k">class</span> <span class="nc">MyAppConf</span><span class="p">(</span><span class="n">AppConf</span><span class="p">):</span> <span class="n">SETTING_1</span> <span class="o">=</span> <span class="s2">"one"</span> <span class="n">SETTING_2</span> <span class="o">=</span> <span class="p">(</span> <span class="s2">"two"</span><span class="p">,</span> <span class="p">)</span> <span class="k">class</span> <span class="nc">Meta</span><span class="p">:</span> <span class="n">proxy</span> <span class="o">=</span> <span class="kc">True</span> <span class="n">myapp_settings</span> <span class="o">=</span> <span class="n">MyAppConf</span><span class="p">()</span> <span class="k">if</span> <span class="s2">"myapp"</span> <span class="ow">in</span> <span class="n">myapp_settings</span><span class="o">.</span><span class="n">INSTALLED_APPS</span><span class="p">:</span> <span class="nb">print</span> <span class="s2">"yay, myapp is installed!"</span> </pre></div> </div> <p>In case you want to override some settings programmatically, you can simply pass the value when instantiating the <code class="docutils literal notranslate"><span class="pre">AppConf</span></code> class:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">myapp.models</span> <span class="k">import</span> <span class="n">MyAppConf</span> <span class="n">myapp_settings</span> <span class="o">=</span> <span class="n">MyAppConf</span><span class="p">(</span><span class="n">SETTING_1</span><span class="o">=</span><span class="s1">'something completely different'</span><span class="p">)</span> <span class="k">if</span> <span class="s1">'different'</span> <span class="ow">in</span> <span class="n">myapp_settings</span><span class="o">.</span><span class="n">SETTING_1</span><span class="p">:</span> <span class="nb">print</span> <span class="s2">"yay, I'm different!"</span> </pre></div> </div> <div class="section" id="custom-configuration"> <h2>Custom configuration<a class="headerlink" href="#custom-configuration" title="Permalink to this headline">¶</a></h2> <p>Each of the settings can be individually configured with callbacks. For example, in case a value of a setting depends on other settings or other dependencies. The following example sets one setting to a different value depending on a global setting:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">django.conf</span> <span class="k">import</span> <span class="n">settings</span> <span class="kn">from</span> <span class="nn">appconf</span> <span class="k">import</span> <span class="n">AppConf</span> <span class="k">class</span> <span class="nc">MyCustomAppConf</span><span class="p">(</span><span class="n">AppConf</span><span class="p">):</span> <span class="n">ENABLED</span> <span class="o">=</span> <span class="kc">True</span> <span class="k">def</span> <span class="nf">configure_enabled</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span> <span class="k">return</span> <span class="n">value</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">settings</span><span class="o">.</span><span class="n">DEBUG</span> </pre></div> </div> <p>The value of <code class="docutils literal notranslate"><span class="pre">MYAPP_ENABLED</span></code> will vary depending on the value of the global <code class="docutils literal notranslate"><span class="pre">DEBUG</span></code> setting.</p> <p>Each of the app settings can be customized by providing a method <code class="docutils literal notranslate"><span class="pre">configure_<lower_setting_name></span></code> that takes the default value as defined in the class attributes of the <code class="docutils literal notranslate"><span class="pre">AppConf</span></code> subclass or the override value from the global settings as the only parameter. The method <strong>must return</strong> the value to be use for the setting in question.</p> <p>After each of the <code class="docutils literal notranslate"><span class="pre">configure_*</span></code> methods has been called, the <code class="docutils literal notranslate"><span class="pre">AppConf</span></code> class will additionally call a main <code class="docutils literal notranslate"><span class="pre">configure</span></code> method, which can be used to do any further custom configuration handling, e.g. if multiple settings depend on each other. For that a <code class="docutils literal notranslate"><span class="pre">configured_data</span></code> dictionary is provided in the setting instance:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">django.conf</span> <span class="k">import</span> <span class="n">settings</span> <span class="kn">from</span> <span class="nn">appconf</span> <span class="k">import</span> <span class="n">AppConf</span> <span class="k">class</span> <span class="nc">MyCustomAppConf</span><span class="p">(</span><span class="n">AppConf</span><span class="p">):</span> <span class="n">ENABLED</span> <span class="o">=</span> <span class="kc">True</span> <span class="n">MODE</span> <span class="o">=</span> <span class="s1">'development'</span> <span class="k">def</span> <span class="nf">configure_enabled</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span> <span class="k">return</span> <span class="n">value</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">settings</span><span class="o">.</span><span class="n">DEBUG</span> <span class="k">def</span> <span class="nf">configure</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="n">mode</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">configured_data</span><span class="p">[</span><span class="s1">'MODE'</span><span class="p">]</span> <span class="n">enabled</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">configured_data</span><span class="p">[</span><span class="s1">'ENABLED'</span><span class="p">]</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">enabled</span> <span class="ow">and</span> <span class="n">mode</span> <span class="o">!=</span> <span class="s1">'development'</span><span class="p">:</span> <span class="nb">print</span> <span class="s2">"WARNING: app not enabled in </span><span class="si">%s</span><span class="s2"> mode!"</span> <span class="o">%</span> <span class="n">mode</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">configured_data</span> </pre></div> </div> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">Don’t forget to return the configured data in your custom <code class="docutils literal notranslate"><span class="pre">configure</span></code> method if you edit it.</p> </div> </div> </div> </div> </div> </div> <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> <div class="sphinxsidebarwrapper"> <h3><a href="index.html">Table of Contents</a></h3> <ul> <li><a class="reference internal" href="#">Usage</a><ul> <li><a class="reference internal" href="#custom-configuration">Custom configuration</a></li> </ul> </li> </ul> <h4>Previous topic</h4> <p class="topless"><a href="index.html" title="previous chapter">django-appconf</a></p> <h4>Next topic</h4> <p class="topless"><a href="reference.html" title="next chapter">Reference</a></p> <div role="note" aria-label="source link"> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="_sources/usage.rst.txt" rel="nofollow">Show Source</a></li> </ul> </div> <div id="searchbox" style="display: none" role="search"> <h3>Quick search</h3> <div class="searchformwrapper"> <form class="search" action="search.html" method="get"> <input type="text" name="q" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="clearer"></div> </div> <div class="related" role="navigation" aria-label="related navigation"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="reference.html" title="Reference" >next</a> |</li> <li class="right" > <a href="index.html" title="django-appconf" >previous</a> |</li> <li class="nav-item nav-item-0"><a href="index.html">django-appconf 1.0.2 documentation</a> »</li> </ul> </div> <div class="footer" role="contentinfo"> © Copyright 2011-2013, Jannis Leidel and individual contributors. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3. </div> </body> </html>