<!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>IPluginLocator — 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="PluginManagerDecorator" href="PluginManagerDecorator.html" />
<link rel="prev" title="PluginFileLocator" href="PluginFileLocator.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="PluginManagerDecorator.html" title="PluginManagerDecorator"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="PluginFileLocator.html" title="PluginFileLocator"
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.IPluginLocator">
<span id="ipluginlocator"></span><h1>IPluginLocator<a class="headerlink" href="#module-yapsy.IPluginLocator" 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><tt class="docutils literal"><span class="pre">IPluginLocator</span></tt> defines the basic interface expected by a
<tt class="docutils literal"><span class="pre">PluginManager</span></tt> to be able to locate plugins and get basic info
about each discovered plugin (name, version etc).</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.IPluginLocator.IPluginLocator">
<em class="property">class </em><tt class="descclassname">yapsy.IPluginLocator.</tt><tt class="descname">IPluginLocator</tt><a class="headerlink" href="#yapsy.IPluginLocator.IPluginLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Plugin Locator interface with some methods already implemented to
manage the awkward backward compatible stuff.</p>
<dl class="method">
<dt id="yapsy.IPluginLocator.IPluginLocator.gatherCorePluginInfo">
<tt class="descname">gatherCorePluginInfo</tt><big>(</big><em>directory</em>, <em>filename</em><big>)</big><a class="headerlink" href="#yapsy.IPluginLocator.IPluginLocator.gatherCorePluginInfo" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a <tt class="docutils literal"><span class="pre">PluginInfo</span></tt> as well as the <tt class="docutils literal"><span class="pre">ConfigParser</span></tt> used to build it.</p>
<p>If filename is a valid plugin discovered by any of the known
strategy in use. Returns None,None otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="yapsy.IPluginLocator.IPluginLocator.getPluginInfoClass">
<tt class="descname">getPluginInfoClass</tt><big>(</big><big>)</big><a class="headerlink" href="#yapsy.IPluginLocator.IPluginLocator.getPluginInfoClass" title="Permalink to this definition">¶</a></dt>
<dd><p>DEPRECATED(>1.9): kept for backward compatibility
with existing PluginManager child classes.</p>
<p>Get the class that holds PluginInfo.</p>
</dd></dl>
<dl class="method">
<dt id="yapsy.IPluginLocator.IPluginLocator.getPluginNameAndModuleFromStream">
<tt class="descname">getPluginNameAndModuleFromStream</tt><big>(</big><em>fileobj</em><big>)</big><a class="headerlink" href="#yapsy.IPluginLocator.IPluginLocator.getPluginNameAndModuleFromStream" title="Permalink to this definition">¶</a></dt>
<dd><p>DEPRECATED(>1.9): kept for backward compatibility
with existing PluginManager child classes.</p>
<p>Return a 3-uple with the name of the plugin, its
module and the config_parser used to gather the core
data <em>in a tuple</em>, if the required info could be
localised, else return <tt class="docutils literal"><span class="pre">(None,None,None)</span></tt>.</p>
</dd></dl>
<dl class="method">
<dt id="yapsy.IPluginLocator.IPluginLocator.locatePlugins">
<tt class="descname">locatePlugins</tt><big>(</big><big>)</big><a class="headerlink" href="#yapsy.IPluginLocator.IPluginLocator.locatePlugins" title="Permalink to this definition">¶</a></dt>
<dd><p>Walk through the plugins’ places and look for plugins.</p>
<p>Return the discovered plugins as a list of
<tt class="docutils literal"><span class="pre">(candidate_infofile_path,</span> <span class="pre">candidate_file_path,plugin_info_instance)</span></tt>
and their number.</p>
</dd></dl>
<dl class="method">
<dt id="yapsy.IPluginLocator.IPluginLocator.setPluginInfoClass">
<tt class="descname">setPluginInfoClass</tt><big>(</big><em>picls</em>, <em>names=None</em><big>)</big><a class="headerlink" href="#yapsy.IPluginLocator.IPluginLocator.setPluginInfoClass" title="Permalink to this definition">¶</a></dt>
<dd><p>DEPRECATED(>1.9): kept for backward compatibility
with existing PluginManager child classes.</p>
<p>Set the class that holds PluginInfo. The class should inherit
from <tt class="docutils literal"><span class="pre">PluginInfo</span></tt>.</p>
</dd></dl>
<dl class="method">
<dt id="yapsy.IPluginLocator.IPluginLocator.setPluginPlaces">
<tt class="descname">setPluginPlaces</tt><big>(</big><em>directories_list</em><big>)</big><a class="headerlink" href="#yapsy.IPluginLocator.IPluginLocator.setPluginPlaces" title="Permalink to this definition">¶</a></dt>
<dd><p>DEPRECATED(>1.9): kept for backward compatibility
with existing PluginManager child classes.</p>
<p>Set the list of directories where to look for plugin places.</p>
</dd></dl>
<dl class="method">
<dt id="yapsy.IPluginLocator.IPluginLocator.updatePluginPlaces">
<tt class="descname">updatePluginPlaces</tt><big>(</big><em>directories_list</em><big>)</big><a class="headerlink" href="#yapsy.IPluginLocator.IPluginLocator.updatePluginPlaces" title="Permalink to this definition">¶</a></dt>
<dd><p>DEPRECATED(>1.9): kept for backward compatibility
with existing PluginManager child classes.</p>
<p>Updates the list of directories where to look for plugin places.</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="#">IPluginLocator</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="PluginFileLocator.html"
title="previous chapter">PluginFileLocator</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="PluginManagerDecorator.html"
title="next chapter">PluginManagerDecorator</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/IPluginLocator.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="PluginManagerDecorator.html" title="PluginManagerDecorator"
>next</a> |</li>
<li class="right" >
<a href="PluginFileLocator.html" title="PluginFileLocator"
>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>
