Sophie

Sophie

distrib > Fedora > 17 > i386 > media > updates > by-pkgid > b50d8ee6d7871fcc13c0677a9364ed59 > files > 44

bcfg2-doc-1.3.0-1.fc17.noarch.rpm



<!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>Bcfg2.Server.Plugins.Cfg.CfgInfoXML &mdash; Bcfg2 1.3.0 documentation</title>
    
    <link rel="stylesheet" href="../../../../../_static/default.css" type="text/css" />
    <link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../../../../../',
        VERSION:     '1.3.0',
        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>
    <script type="text/javascript" src="../../../../../_static/sidebar.js"></script>
    <link rel="shortcut icon" href="../../../../../_static/favicon.ico"/>
    <link rel="top" title="Bcfg2 1.3.0 documentation" href="../../../../../index.html" />
    <link rel="up" title="Bcfg2.Server.Plugins.Cfg" href="../Cfg.html" />
 
<link rel="stylesheet" href="../../../../../_static/bcfg2.css" type=""/>

  </head>
  <body>

<div style="text-align: left; padding: 10px 10px 15px 15px">
<a href="../../../../../index.html"><img src="../../../../../_static/bcfg2_logo.png" border="0" alt="sampledoc"/></a>
</div>

    <div class="related">
      <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><a href="../../../../../index.html">home</a> |&nbsp;</li>
	<!--<li><a href="../../../../../search.html">search</a> |&nbsp;</li>-->
	<li><a href="../../../../../help/index.html">help</a> |&nbsp;</li>
	<li><a href="../../../../../contents.html">documentation </a> &raquo;</li>

          <li><a href="../../../../index.html" >Module code</a> &raquo;</li>
          <li><a href="../../Plugins.html" >Bcfg2.Server.Plugins</a> &raquo;</li>
          <li><a href="../Cfg.html" accesskey="U">Bcfg2.Server.Plugins.Cfg</a> &raquo;</li> 
      </ul>
    </div>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <h1>Source code for Bcfg2.Server.Plugins.Cfg.CfgInfoXML</h1><div class="highlight"><pre>
<span class="sd">&quot;&quot;&quot; Handle info.xml files &quot;&quot;&quot;</span>

<span class="kn">from</span> <span class="nn">Bcfg2.Server.Plugin</span> <span class="kn">import</span> <span class="n">PluginExecutionError</span><span class="p">,</span> <span class="n">InfoXML</span>
<span class="kn">from</span> <span class="nn">Bcfg2.Server.Plugins.Cfg</span> <span class="kn">import</span> <span class="n">CfgInfo</span>


<div class="viewcode-block" id="CfgInfoXML"><a class="viewcode-back" href="../../../../../development/cfg.html#Bcfg2.Server.Plugins.Cfg.CfgInfoXML.CfgInfoXML">[docs]</a><span class="k">class</span> <span class="nc">CfgInfoXML</span><span class="p">(</span><span class="n">CfgInfo</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot; CfgInfoXML handles :file:`info.xml` files for</span>
<span class="sd">    :ref:`server-plugins-generators-cfg` &quot;&quot;&quot;</span>

    <span class="c">#: Handle :file:`info.xml` files</span>
    <span class="n">__basenames__</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;info.xml&#39;</span><span class="p">]</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">path</span><span class="p">):</span>
        <span class="n">CfgInfo</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">path</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">infoxml</span> <span class="o">=</span> <span class="n">InfoXML</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
    <span class="n">__init__</span><span class="o">.</span><span class="n">__doc__</span> <span class="o">=</span> <span class="n">CfgInfo</span><span class="o">.</span><span class="n">__init__</span><span class="o">.</span><span class="n">__doc__</span>

<div class="viewcode-block" id="CfgInfoXML.bind_info_to_entry"><a class="viewcode-back" href="../../../../../development/cfg.html#Bcfg2.Server.Plugins.Cfg.CfgInfoXML.CfgInfoXML.bind_info_to_entry">[docs]</a>    <span class="k">def</span> <span class="nf">bind_info_to_entry</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">entry</span><span class="p">,</span> <span class="n">metadata</span><span class="p">):</span>
        <span class="n">mdata</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">infoxml</span><span class="o">.</span><span class="n">pnode</span><span class="o">.</span><span class="n">Match</span><span class="p">(</span><span class="n">metadata</span><span class="p">,</span> <span class="n">mdata</span><span class="p">,</span> <span class="n">entry</span><span class="o">=</span><span class="n">entry</span><span class="p">)</span>
        <span class="k">if</span> <span class="s">&#39;Info&#39;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">mdata</span><span class="p">:</span>
            <span class="k">raise</span> <span class="n">PluginExecutionError</span><span class="p">(</span><span class="s">&quot;Failed to set metadata for file </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span>
                                       <span class="n">entry</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;name&#39;</span><span class="p">))</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">_set_info</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="n">mdata</span><span class="p">[</span><span class="s">&#39;Info&#39;</span><span class="p">][</span><span class="bp">None</span><span class="p">])</span></div>
    <span class="n">bind_info_to_entry</span><span class="o">.</span><span class="n">__doc__</span> <span class="o">=</span> <span class="n">CfgInfo</span><span class="o">.</span><span class="n">bind_info_to_entry</span><span class="o">.</span><span class="n">__doc__</span>

<div class="viewcode-block" id="CfgInfoXML.handle_event"><a class="viewcode-back" href="../../../../../development/cfg.html#Bcfg2.Server.Plugins.Cfg.CfgInfoXML.CfgInfoXML.handle_event">[docs]</a>    <span class="k">def</span> <span class="nf">handle_event</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">event</span><span class="p">):</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">infoxml</span><span class="o">.</span><span class="n">HandleEvent</span><span class="p">()</span></div>
    <span class="n">handle_event</span><span class="o">.</span><span class="n">__doc__</span> <span class="o">=</span> <span class="n">CfgInfo</span><span class="o">.</span><span class="n">handle_event</span><span class="o">.</span><span class="n">__doc__</span>

    <span class="k">def</span> <span class="nf">_set_info</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">entry</span><span class="p">,</span> <span class="n">info</span><span class="p">):</span>
        <span class="n">CfgInfo</span><span class="o">.</span><span class="n">_set_info</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">entry</span><span class="p">,</span> <span class="n">info</span><span class="p">)</span>
        <span class="k">if</span> <span class="s">&#39;__children__&#39;</span> <span class="ow">in</span> <span class="n">info</span><span class="p">:</span>
            <span class="k">for</span> <span class="n">child</span> <span class="ow">in</span> <span class="n">info</span><span class="p">[</span><span class="s">&#39;__children__&#39;</span><span class="p">]:</span>
                <span class="n">entry</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">child</span><span class="p">)</span>
    <span class="n">_set_info</span><span class="o">.</span><span class="n">__doc__</span> <span class="o">=</span> <span class="n">CfgInfo</span><span class="o">.</span><span class="n">_set_info</span><span class="o">.</span><span class="n">__doc__</span></div>
</pre></div>

          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <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>
    <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">
      <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="../../../../../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
	<li><a href="../../../../../index.html">home</a> |&nbsp;</li>
	<!--<li><a href="../../../../../search.html">search</a> |&nbsp;</li>-->
	<li><a href="../../../../../help/index.html">help</a> |&nbsp;</li>
	<li><a href="../../../../../contents.html">documentation </a> &raquo;</li>

          <li><a href="../../../../index.html" >Module code</a> &raquo;</li>
          <li><a href="../../Plugins.html" >Bcfg2.Server.Plugins</a> &raquo;</li>
          <li><a href="../Cfg.html" >Bcfg2.Server.Plugins.Cfg</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2009-2013, Narayan Desai.
      Last updated on Mar 20, 2013.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
    </div>
  </body>
</html>