<!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>PluginInfo — 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="next" title="Built-in Extensions" href="Extensions.html" />
<link rel="prev" title="PluginManager" href="PluginManager.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="Extensions.html" title="Built-in Extensions"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="PluginManager.html" title="PluginManager"
accesskey="P">previous</a> |</li>
<li><a href="index.html">Yapsy 1.10.2 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-yapsy.PluginInfo">
<span id="plugininfo"></span><h1>PluginInfo<a class="headerlink" href="#module-yapsy.PluginInfo" 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>Encapsulate a plugin instance as well as some metadata.</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.PluginInfo.PluginInfo">
<em class="property">class </em><tt class="descclassname">yapsy.PluginInfo.</tt><tt class="descname">PluginInfo</tt><big>(</big><em>plugin_name</em>, <em>plugin_path</em><big>)</big><a class="headerlink" href="#yapsy.PluginInfo.PluginInfo" title="Permalink to this definition">¶</a></dt>
<dd><p>Representation of the most basic set of information related to a
given plugin such as its name, author, description...</p>
<p>Any additional information can be stored ad retrieved in a
PluginInfo, when this one is created with a
<tt class="docutils literal"><span class="pre">ConfigParser.ConfigParser</span></tt> instance.</p>
<p>This typically means that when metadata is read from a text file
(the original way for yapsy to describe plugins), all info that is
not part of the basic variables (name, path, version etc), can
still be accessed though the <tt class="docutils literal"><span class="pre">details</span></tt> member variables that
behaves like Python’s <tt class="docutils literal"><span class="pre">ConfigParser.ConfigParser</span></tt>.</p>
<dl class="attribute">
<dt id="yapsy.PluginInfo.PluginInfo.author">
<tt class="descname">author</tt><a class="headerlink" href="#yapsy.PluginInfo.PluginInfo.author" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="yapsy.PluginInfo.PluginInfo.category">
<tt class="descname">category</tt><a class="headerlink" href="#yapsy.PluginInfo.PluginInfo.category" title="Permalink to this definition">¶</a></dt>
<dd><p>DEPRECATED (>1.9): Mimic former behaviour when what is
noz the first category was considered as the only one the
plugin belonged to.</p>
</dd></dl>
<dl class="attribute">
<dt id="yapsy.PluginInfo.PluginInfo.copyright">
<tt class="descname">copyright</tt><a class="headerlink" href="#yapsy.PluginInfo.PluginInfo.copyright" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="yapsy.PluginInfo.PluginInfo.description">
<tt class="descname">description</tt><a class="headerlink" href="#yapsy.PluginInfo.PluginInfo.description" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="yapsy.PluginInfo.PluginInfo.details">
<tt class="descname">details</tt><a class="headerlink" href="#yapsy.PluginInfo.PluginInfo.details" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="yapsy.PluginInfo.PluginInfo.is_activated">
<tt class="descname">is_activated</tt><a class="headerlink" href="#yapsy.PluginInfo.PluginInfo.is_activated" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the activated state of the plugin object.
Makes it possible to define a property.</p>
</dd></dl>
<dl class="attribute">
<dt id="yapsy.PluginInfo.PluginInfo.name">
<tt class="descname">name</tt><a class="headerlink" href="#yapsy.PluginInfo.PluginInfo.name" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="yapsy.PluginInfo.PluginInfo.path">
<tt class="descname">path</tt><a class="headerlink" href="#yapsy.PluginInfo.PluginInfo.path" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="yapsy.PluginInfo.PluginInfo.setVersion">
<tt class="descname">setVersion</tt><big>(</big><em>vstring</em><big>)</big><a class="headerlink" href="#yapsy.PluginInfo.PluginInfo.setVersion" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the version of the plugin.</p>
<p>Used by subclasses to provide different handling of the
version number.</p>
</dd></dl>
<dl class="attribute">
<dt id="yapsy.PluginInfo.PluginInfo.version">
<tt class="descname">version</tt><a class="headerlink" href="#yapsy.PluginInfo.PluginInfo.version" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="yapsy.PluginInfo.PluginInfo.website">
<tt class="descname">website</tt><a class="headerlink" href="#yapsy.PluginInfo.PluginInfo.website" title="Permalink to this definition">¶</a></dt>
<dd></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="#">PluginInfo</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="PluginManager.html"
title="previous chapter">PluginManager</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="Extensions.html"
title="next chapter">Built-in Extensions</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/PluginInfo.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="Extensions.html" title="Built-in Extensions"
>next</a> |</li>
<li class="right" >
<a href="PluginManager.html" title="PluginManager"
>previous</a> |</li>
<li><a href="index.html">Yapsy 1.10.2 documentation</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>
