python-oslo.config-doc 1:3.9.0-3 / usr / share / doc / python-oslo.config-doc / html / helpers.html

This file is indexed.

/usr/share/doc/python-oslo.config-doc/html/helpers.html is in python-oslo.config-doc 1:3.9.0-3.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
<!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="Content-Type" content="text/html; charset=utf-8" />
    
    <title>Helper Functions &mdash; oslo.config  documentation</title>
    
    <link rel="stylesheet" href="_static/nature.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <link rel="stylesheet" href="_static/tweaks.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="top" title="oslo.config  documentation" href="index.html" />
    <link rel="next" title="Test Fixture" href="fixture.html" />
    <link rel="prev" title="The cfgfilter Module" href="cfgfilter.html" /> 
  </head>
  <body role="document">
  <div id="header">
    <h1 id="logo"><a href="http://www.openstack.org/">OpenStack</a></h1>
    <ul id="navigation">
      
      <li><a href="http://www.openstack.org/" title="Go to the Home page" class="link">Home</a></li>
      <li><a href="http://www.openstack.org/projects/" title="Go to the OpenStack Projects page">Projects</a></li>
      <li><a href="http://www.openstack.org/user-stories/" title="Go to the User Stories page" class="link">User Stories</a></li>
      <li><a href="http://www.openstack.org/community/" title="Go to the Community page" class="link">Community</a></li>
      <li><a href="http://www.openstack.org/blog/" title="Go to the OpenStack Blog">Blog</a></li>
      <li><a href="http://wiki.openstack.org/" title="Go to the OpenStack Wiki">Wiki</a></li>
      <li><a href="http://docs.openstack.org/" title="Go to OpenStack Documentation" class="current">Documentation</a></li>
      
    </ul>
  </div>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="helper-functions">
<h1>Helper Functions<a class="headerlink" href="#helper-functions" title="Permalink to this headline"></a></h1>
<dl class="function">
<dt id="oslo_config.cfg.find_config_files">
<code class="descclassname">oslo_config.cfg.</code><code class="descname">find_config_files</code><span class="sig-paren">(</span><em>project=None</em>, <em>prog=None</em>, <em>extension='.conf'</em><span class="sig-paren">)</span><a class="headerlink" href="#oslo_config.cfg.find_config_files" title="Permalink to this definition"></a></dt>
<dd><p>Return a list of default configuration files.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>project</strong> &#8211; an optional project name</li>
<li><strong>prog</strong> &#8211; the program name, defaulting to the basename of sys.argv[0]</li>
<li><strong>extension</strong> &#8211; the type of the config file</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>We default to two config files: [${project}.conf, ${prog}.conf]</p>
<p>And we look for those config files in the following directories:</p>
<div class="highlight-python"><div class="highlight"><pre>~/.${project}/
~/
/etc/${project}/
/etc/
</pre></div>
</div>
<p>We return an absolute path for (at most) one of each the default config
files, for the topmost directory it exists in.</p>
<p>For example, if project=foo, prog=bar and /etc/foo/foo.conf, /etc/bar.conf
and ~/.foo/bar.conf all exist, then we return [&#8216;/etc/foo/foo.conf&#8217;,
&#8216;~/.foo/bar.conf&#8217;]</p>
<p>If no project name is supplied, we only look for ${prog.conf}.</p>
</dd></dl>

<dl class="function">
<dt id="oslo_config.cfg.set_defaults">
<code class="descclassname">oslo_config.cfg.</code><code class="descname">set_defaults</code><span class="sig-paren">(</span><em>opts</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#oslo_config.cfg.set_defaults" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

</div>


          </div>
        </div>
      </div>
<div class="sphinxsidebar">
    <div class="sphinxsidebarwrapper">
            <h4>Previous topic</h4>
            <p class="topless"><a href="cfgfilter.html"
                                  title="previous chapter">The cfgfilter Module</a></p>
            <h4>Next topic</h4>
            <p class="topless"><a href="fixture.html"
                                  title="next chapter">Test Fixture</a></p>
            <h3>This Page</h3>
            <ul class="this-page-menu">
              <li><a href="_sources/helpers.txt"
                     rel="nofollow">Show Source</a></li>
            </ul>
          <div id="searchbox" style="display: none">
            <h3>Quick search</h3>
              <form class="search" action="search.html" method="get">
                <input type="text" name="q" size="18" />
                <input type="submit" value="Go" />
                <input type="hidden" name="check_keywords" value="yes" />
                <input type="hidden" name="area" value="default" />
              </form>
              <p class="searchtip" style="font-size: 90%">
              Enter search terms or a module, class or function name.
              </p>
          </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"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="fixture.html" title="Test Fixture"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="cfgfilter.html" title="The cfgfilter Module"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">oslo.config  documentation</a> &raquo;</li> 
      </ul>
    </div>

    <div class="footer" role="contentinfo">
        &copy; Copyright 2013, OpenStack Foundation.
      Last updated on April 04, 2016.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.6.
    </div>
<script type="text/javascript">
try {
//Tracking docs.openstack.org/developer/<projectname> only
//The URL is built from the project variable in conf.py
var pageTracker = _gat._getTracker("UA-17511903-1");
pageTracker._setCookiePath("/developer/oslo.config");
pageTracker._trackPageview();
} catch(err) {}</script>

  </body>
</html>

APT Browse - Built by Thomas Orozco.