<!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>ConfigurablePluginManager — Yapsy 1.10.2 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.10.2',
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="shortcut icon" href="_static/yapsy-favicon.ico"/>
<link rel="top" title="Yapsy 1.10.2 documentation" href="index.html" />
<link rel="up" title="Built-in Extensions" href="Extensions.html" />
<link rel="next" title="AutoInstallPluginManager" href="AutoInstallPluginManager.html" />
<link rel="prev" title="VersionedPluginManager" href="VersionedPluginManager.html" />
</head>
<body>
<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 class="right" >
<a href="AutoInstallPluginManager.html" title="AutoInstallPluginManager"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="VersionedPluginManager.html" title="VersionedPluginManager"
accesskey="P">previous</a> |</li>
<li><a href="index.html">Yapsy 1.10.2 documentation</a> »</li>
<li><a href="Extensions.html" accesskey="U">Built-in Extensions</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-yapsy.ConfigurablePluginManager">
<span id="configurablepluginmanager"></span><h1>ConfigurablePluginManager<a class="headerlink" href="#module-yapsy.ConfigurablePluginManager" title="Permalink to this headline">¶</a></h1>
<div class="section" id="role">
<h2>Role<a class="headerlink" href="#role" title="Permalink to this headline">¶</a></h2>
<p>Defines plugin managers that can handle configuration files similar to
the ini files manipulated by Python’s ConfigParser module.</p>
</div>
<div class="section" id="api">
<h2>API<a class="headerlink" href="#api" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="yapsy.ConfigurablePluginManager.ConfigurablePluginManager">
<em class="property">class </em><tt class="descclassname">yapsy.ConfigurablePluginManager.</tt><tt class="descname">ConfigurablePluginManager</tt><big>(</big><em>configparser_instance=None</em>, <em>config_change_trigger=<function <lambda> at 0x225e578></em>, <em>decorated_manager=None</em>, <em>categories_filter={'Default': <class 'yapsy.IPlugin.IPlugin'>}</em>, <em>directories_list=None</em>, <em>plugin_info_ext='yapsy-plugin'</em><big>)</big><a class="headerlink" href="#yapsy.ConfigurablePluginManager.ConfigurablePluginManager" title="Permalink to this definition">¶</a></dt>
<dd><p>A plugin manager that also manages a configuration file.</p>
<p>The configuration file will be accessed through a <tt class="docutils literal"><span class="pre">ConfigParser</span></tt>
derivated object. The file can be used for other purpose by the
application using this plugin manager as it will only add a new
specific section <tt class="docutils literal"><span class="pre">[Plugin</span> <span class="pre">Management]</span></tt> for itself and also new
sections for some plugins that will start with <tt class="docutils literal"><span class="pre">[Plugin:...]</span></tt>
(only the plugins that explicitly requires to save configuration
options will have this kind of section).</p>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">when giving/building the list of plugins to activate
by default, there must not be any space in the list
(neither in the names nor in between)</p>
</div>
<dl class="attribute">
<dt id="yapsy.ConfigurablePluginManager.ConfigurablePluginManager.CONFIG_SECTION_NAME">
<tt class="descname">CONFIG_SECTION_NAME</tt><em class="property"> = 'Plugin Management'</em><a class="headerlink" href="#yapsy.ConfigurablePluginManager.ConfigurablePluginManager.CONFIG_SECTION_NAME" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="yapsy.ConfigurablePluginManager.ConfigurablePluginManager.activatePluginByName">
<tt class="descname">activatePluginByName</tt><big>(</big><em>plugin_name</em>, <em>category_name='Default'</em>, <em>save_state=True</em><big>)</big><a class="headerlink" href="#yapsy.ConfigurablePluginManager.ConfigurablePluginManager.activatePluginByName" title="Permalink to this definition">¶</a></dt>
<dd><p>Activate a plugin, , and remember it (in the config file).</p>
<p>If you want the plugin to benefit from the configuration
utility defined by this manager, it is crucial to use this
method to activate a plugin and not call the plugin object’s
<tt class="docutils literal"><span class="pre">activate</span></tt> method. In fact, this method will also “decorate”
the plugin object so that it can use this class’s methods to
register its own options.</p>
<p>By default, the plugin’s activation is registered in the
config file but if you d’ont want this set the ‘save_state’
argument to False.</p>
</dd></dl>
<dl class="method">
<dt id="yapsy.ConfigurablePluginManager.ConfigurablePluginManager.deactivatePluginByName">
<tt class="descname">deactivatePluginByName</tt><big>(</big><em>plugin_name</em>, <em>category_name='Default'</em>, <em>save_state=True</em><big>)</big><a class="headerlink" href="#yapsy.ConfigurablePluginManager.ConfigurablePluginManager.deactivatePluginByName" title="Permalink to this definition">¶</a></dt>
<dd><p>Deactivate a plugin, and remember it (in the config file).</p>
<p>By default, the plugin’s deactivation is registered in the
config file but if you d’ont want this set the <tt class="docutils literal"><span class="pre">save_state</span></tt>
argument to False.</p>
</dd></dl>
<dl class="method">
<dt id="yapsy.ConfigurablePluginManager.ConfigurablePluginManager.hasOptionFromPlugin">
<tt class="descname">hasOptionFromPlugin</tt><big>(</big><em>category_name</em>, <em>plugin_name</em>, <em>option_name</em><big>)</big><a class="headerlink" href="#yapsy.ConfigurablePluginManager.ConfigurablePluginManager.hasOptionFromPlugin" title="Permalink to this definition">¶</a></dt>
<dd><p>To be called from a plugin object, return True if the option
has already been registered.</p>
</dd></dl>
<dl class="method">
<dt id="yapsy.ConfigurablePluginManager.ConfigurablePluginManager.loadPlugins">
<tt class="descname">loadPlugins</tt><big>(</big><em>callback=None</em><big>)</big><a class="headerlink" href="#yapsy.ConfigurablePluginManager.ConfigurablePluginManager.loadPlugins" title="Permalink to this definition">¶</a></dt>
<dd><p>Walk through the plugins’ places and look for plugins. Then
for each plugin candidate look for its category, load it and
stores it in the appropriate slot of the <tt class="docutils literal"><span class="pre">category_mapping</span></tt>.</p>
</dd></dl>
<dl class="method">
<dt id="yapsy.ConfigurablePluginManager.ConfigurablePluginManager.readOptionFromPlugin">
<tt class="descname">readOptionFromPlugin</tt><big>(</big><em>category_name</em>, <em>plugin_name</em>, <em>option_name</em><big>)</big><a class="headerlink" href="#yapsy.ConfigurablePluginManager.ConfigurablePluginManager.readOptionFromPlugin" title="Permalink to this definition">¶</a></dt>
<dd><p>To be called from a plugin object, read a given option in
the name of a given plugin.</p>
</dd></dl>
<dl class="method">
<dt id="yapsy.ConfigurablePluginManager.ConfigurablePluginManager.registerOptionFromPlugin">
<tt class="descname">registerOptionFromPlugin</tt><big>(</big><em>category_name</em>, <em>plugin_name</em>, <em>option_name</em>, <em>option_value</em><big>)</big><a class="headerlink" href="#yapsy.ConfigurablePluginManager.ConfigurablePluginManager.registerOptionFromPlugin" title="Permalink to this definition">¶</a></dt>
<dd><p>To be called from a plugin object, register a given option in
the name of a given plugin.</p>
</dd></dl>
<dl class="method">
<dt id="yapsy.ConfigurablePluginManager.ConfigurablePluginManager.setConfigParser">
<tt class="descname">setConfigParser</tt><big>(</big><em>configparser_instance</em>, <em>config_change_trigger</em><big>)</big><a class="headerlink" href="#yapsy.ConfigurablePluginManager.ConfigurablePluginManager.setConfigParser" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the ConfigParser instance.</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="index.html">
<img class="logo" src="_static/yapsy-big.png" alt="Logo"/>
</a></p>
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">ConfigurablePluginManager</a><ul>
<li><a class="reference internal" href="#role">Role</a></li>
<li><a class="reference internal" href="#api">API</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="VersionedPluginManager.html"
title="previous chapter">VersionedPluginManager</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="AutoInstallPluginManager.html"
title="next chapter">AutoInstallPluginManager</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/ConfigurablePluginManager.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" />
<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 class="right" >
<a href="AutoInstallPluginManager.html" title="AutoInstallPluginManager"
>next</a> |</li>
<li class="right" >
<a href="VersionedPluginManager.html" title="VersionedPluginManager"
>previous</a> |</li>
<li><a href="index.html">Yapsy 1.10.2 documentation</a> »</li>
<li><a href="Extensions.html" >Built-in Extensions</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2010-2013, Thibauld Nion.
Last updated on Oct 05, 2013.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
