<!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>FilteredPluginManager — 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="PluginFileLocator" href="PluginFileLocator.html" />
<link rel="prev" title="AutoInstallPluginManager" href="AutoInstallPluginManager.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="PluginFileLocator.html" title="PluginFileLocator"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="AutoInstallPluginManager.html" title="AutoInstallPluginManager"
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.FilteredPluginManager">
<span id="filteredpluginmanager"></span><h1>FilteredPluginManager<a class="headerlink" href="#module-yapsy.FilteredPluginManager" 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 the basic mechanisms to have a plugin manager filter the
available list of plugins after locating them and before loading them.</p>
<p>One use fo this would be to prevent untrusted plugins from entering
the system.</p>
<p>To use it properly you must reimplement or monkey patch the
<tt class="docutils literal"><span class="pre">IsPluginOk</span></tt> method, as in the following example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="c"># define a plugin manager (with you prefered options)</span>
<span class="n">pm</span> <span class="o">=</span> <span class="n">PluginManager</span><span class="p">(</span><span class="o">...</span><span class="p">)</span>
<span class="c"># decorate it with the Filtering mechanics</span>
<span class="n">pm</span> <span class="o">=</span> <span class="n">FilteredPluginManager</span><span class="p">(</span><span class="n">pm</span><span class="p">)</span>
<span class="c"># define a custom predicate that filters out plugins without descriptions</span>
<span class="n">pm</span><span class="o">.</span><span class="n">isPluginOk</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span><span class="o">.</span><span class="n">description</span><span class="o">!=</span><span class="s">""</span>
</pre></div>
</div>
</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.FilteredPluginManager.FilteredPluginManager">
<em class="property">class </em><tt class="descclassname">yapsy.FilteredPluginManager.</tt><tt class="descname">FilteredPluginManager</tt><big>(</big><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.FilteredPluginManager.FilteredPluginManager" title="Permalink to this definition">¶</a></dt>
<dd><p>Base class for decorators which filter the plugins list
before they are loaded.</p>
<dl class="method">
<dt id="yapsy.FilteredPluginManager.FilteredPluginManager.appendPluginCandidate">
<tt class="descname">appendPluginCandidate</tt><big>(</big><em>pluginTuple</em><big>)</big><a class="headerlink" href="#yapsy.FilteredPluginManager.FilteredPluginManager.appendPluginCandidate" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a new candidate.</p>
</dd></dl>
<dl class="method">
<dt id="yapsy.FilteredPluginManager.FilteredPluginManager.filterPlugins">
<tt class="descname">filterPlugins</tt><big>(</big><big>)</big><a class="headerlink" href="#yapsy.FilteredPluginManager.FilteredPluginManager.filterPlugins" title="Permalink to this definition">¶</a></dt>
<dd><p>Go through the currently available candidates, and and either
leaves them, or moves them into the list of rejected Plugins.</p>
<p>Can be overridden if overriding <tt class="docutils literal"><span class="pre">isPluginOk</span></tt> sentinel is not
powerful enough.</p>
</dd></dl>
<dl class="method">
<dt id="yapsy.FilteredPluginManager.FilteredPluginManager.getRejectedPlugins">
<tt class="descname">getRejectedPlugins</tt><big>(</big><big>)</big><a class="headerlink" href="#yapsy.FilteredPluginManager.FilteredPluginManager.getRejectedPlugins" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the list of rejected plugins.</p>
</dd></dl>
<dl class="method">
<dt id="yapsy.FilteredPluginManager.FilteredPluginManager.isPluginOk">
<tt class="descname">isPluginOk</tt><big>(</big><em>info</em><big>)</big><a class="headerlink" href="#yapsy.FilteredPluginManager.FilteredPluginManager.isPluginOk" title="Permalink to this definition">¶</a></dt>
<dd><p>Sentinel function to detect if a plugin should be filtered.</p>
<p><tt class="docutils literal"><span class="pre">info</span></tt> is an instance of a <tt class="docutils literal"><span class="pre">PluginInfo</span></tt> and this method is
expected to return True if the corresponding plugin can be
accepted, and False if it must be filtered out.</p>
<p>Subclasses should override this function and return false for
any plugin which they do not want to be loadable.</p>
</dd></dl>
<dl class="method">
<dt id="yapsy.FilteredPluginManager.FilteredPluginManager.locatePlugins">
<tt class="descname">locatePlugins</tt><big>(</big><big>)</big><a class="headerlink" href="#yapsy.FilteredPluginManager.FilteredPluginManager.locatePlugins" title="Permalink to this definition">¶</a></dt>
<dd><p>locate and filter plugins.</p>
</dd></dl>
<dl class="method">
<dt id="yapsy.FilteredPluginManager.FilteredPluginManager.rejectPluginCandidate">
<tt class="descname">rejectPluginCandidate</tt><big>(</big><em>pluginTuple</em><big>)</big><a class="headerlink" href="#yapsy.FilteredPluginManager.FilteredPluginManager.rejectPluginCandidate" title="Permalink to this definition">¶</a></dt>
<dd><p>Move a plugin from the candidates list to the rejected List.</p>
</dd></dl>
<dl class="method">
<dt id="yapsy.FilteredPluginManager.FilteredPluginManager.removePluginCandidate">
<tt class="descname">removePluginCandidate</tt><big>(</big><em>pluginTuple</em><big>)</big><a class="headerlink" href="#yapsy.FilteredPluginManager.FilteredPluginManager.removePluginCandidate" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove a plugin from the list of candidates.</p>
</dd></dl>
<dl class="method">
<dt id="yapsy.FilteredPluginManager.FilteredPluginManager.unrejectPluginCandidate">
<tt class="descname">unrejectPluginCandidate</tt><big>(</big><em>pluginTuple</em><big>)</big><a class="headerlink" href="#yapsy.FilteredPluginManager.FilteredPluginManager.unrejectPluginCandidate" title="Permalink to this definition">¶</a></dt>
<dd><p>Move a plugin from the rejected list to into the candidates
list.</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="#">FilteredPluginManager</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="AutoInstallPluginManager.html"
title="previous chapter">AutoInstallPluginManager</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="PluginFileLocator.html"
title="next chapter">PluginFileLocator</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/FilteredPluginManager.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="PluginFileLocator.html" title="PluginFileLocator"
>next</a> |</li>
<li class="right" >
<a href="AutoInstallPluginManager.html" title="AutoInstallPluginManager"
>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>
