<!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>VersionedPluginManager — 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="ConfigurablePluginManager" href="ConfigurablePluginManager.html" />
<link rel="prev" title="Built-in Extensions" href="Extensions.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="ConfigurablePluginManager.html" title="ConfigurablePluginManager"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="Extensions.html" title="Built-in Extensions"
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.VersionedPluginManager">
<span id="versionedpluginmanager"></span><h1>VersionedPluginManager<a class="headerlink" href="#module-yapsy.VersionedPluginManager" 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 interface for a plugin manager that also keeps track
of versions of plugins</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.VersionedPluginManager.VersionedPluginInfo">
<em class="property">class </em><tt class="descclassname">yapsy.VersionedPluginManager.</tt><tt class="descname">VersionedPluginInfo</tt><big>(</big><em>plugin_name</em>, <em>plugin_path</em><big>)</big><a class="headerlink" href="#yapsy.VersionedPluginManager.VersionedPluginInfo" title="Permalink to this definition">¶</a></dt>
<dd><p>Gather some info about a plugin such as its name, author,
description...</p>
<dl class="method">
<dt id="yapsy.VersionedPluginManager.VersionedPluginInfo.setVersion">
<tt class="descname">setVersion</tt><big>(</big><em>vstring</em><big>)</big><a class="headerlink" href="#yapsy.VersionedPluginManager.VersionedPluginInfo.setVersion" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="yapsy.VersionedPluginManager.VersionedPluginManager">
<em class="property">class </em><tt class="descclassname">yapsy.VersionedPluginManager.</tt><tt class="descname">VersionedPluginManager</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.VersionedPluginManager.VersionedPluginManager" title="Permalink to this definition">¶</a></dt>
<dd><p>Handle plugin versioning by making sure that when several
versions are present for a same plugin, only the latest version is
manipulated via the standard methods (eg for activation and
deactivation)</p>
<p>More precisely, for operations that must be applied on a single
named plugin at a time (<tt class="docutils literal"><span class="pre">getPluginByName</span></tt>,
<tt class="docutils literal"><span class="pre">activatePluginByName</span></tt>, <tt class="docutils literal"><span class="pre">deactivatePluginByName</span></tt> etc) the
targetted plugin will always be the one with the latest version.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The older versions of a given plugin are still reachable
via the <tt class="docutils literal"><span class="pre">getPluginsOfCategoryFromAttic</span></tt> method.</p>
</div>
<dl class="method">
<dt id="yapsy.VersionedPluginManager.VersionedPluginManager.getLatestPluginsOfCategory">
<tt class="descname">getLatestPluginsOfCategory</tt><big>(</big><em>category_name</em><big>)</big><a class="headerlink" href="#yapsy.VersionedPluginManager.VersionedPluginManager.getLatestPluginsOfCategory" title="Permalink to this definition">¶</a></dt>
<dd><p>DEPRECATED(>1.8): Please consider using getPluginsOfCategory
instead.</p>
<p>Return the list of all plugins belonging to a category.</p>
</dd></dl>
<dl class="method">
<dt id="yapsy.VersionedPluginManager.VersionedPluginManager.getPluginsOfCategoryFromAttic">
<tt class="descname">getPluginsOfCategoryFromAttic</tt><big>(</big><em>categ</em><big>)</big><a class="headerlink" href="#yapsy.VersionedPluginManager.VersionedPluginManager.getPluginsOfCategoryFromAttic" title="Permalink to this definition">¶</a></dt>
<dd><p>Access the older version of plugins for which only the latest
version is available through standard methods.</p>
</dd></dl>
<dl class="method">
<dt id="yapsy.VersionedPluginManager.VersionedPluginManager.loadPlugins">
<tt class="descname">loadPlugins</tt><big>(</big><em>callback=None</em><big>)</big><a class="headerlink" href="#yapsy.VersionedPluginManager.VersionedPluginManager.loadPlugins" title="Permalink to this definition">¶</a></dt>
<dd><p>Load the candidate plugins that have been identified through a
previous call to locatePlugins.</p>
<p>In addition to the baseclass functionality, this subclass also
needs to find the latest version of each plugin.</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="#">VersionedPluginManager</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="Extensions.html"
title="previous chapter">Built-in Extensions</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="ConfigurablePluginManager.html"
title="next chapter">ConfigurablePluginManager</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/VersionedPluginManager.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="ConfigurablePluginManager.html" title="ConfigurablePluginManager"
>next</a> |</li>
<li class="right" >
<a href="Extensions.html" title="Built-in Extensions"
>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>
