2
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3
"DTD/xhtml1-strict.dtd">
6
<title>API docs for “elisa.core.plugin_registry”</title>
7
<meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
8
<link href="apidocs.css" type="text/css" rel="stylesheet" />
9
<script src="sorttable.js" type="text/javascript"></script>
13
<h1 class="module">Module e.c.plugin_registry</h1>
15
<span id="part">Part of <a href="elisa.html">elisa</a>.<a href="elisa.core.html">core</a></span>
22
<div class="undocumented">No module docstring</div>
26
<div id="splitTables">
27
<table class="children sortable" id="id169">
37
<td class="lineno">66</td>
39
<td><a href="elisa.core.plugin_registry.html#is_development_egg">is_development_egg</a></td>
40
<td><span>Check if the distribution is a development egg.</span></td>
41
</tr><tr class="function">
43
<td class="lineno">79</td>
45
<td><a href="elisa.core.plugin_registry.html#get_plugin_toplevel_directory">get_plugin_toplevel_directory</a></td>
46
<td><span>Get the top level directory of a plugin distribution.</span></td>
47
</tr><tr class="class">
49
<td class="lineno">107</td>
51
<td><a href="elisa.core.plugin_registry.InvalidComponentPath.html">InvalidComponentPath</a></td>
52
<td><span class="undocumented">Undocumented</span></td>
53
</tr><tr class="class">
55
<td class="lineno">114</td>
57
<td><a href="elisa.core.plugin_registry.ComponentNotFound.html">ComponentNotFound</a></td>
58
<td><span class="undocumented">Undocumented</span></td>
59
</tr><tr class="class">
61
<td class="lineno">121</td>
63
<td><a href="elisa.core.plugin_registry.PluginNotFound.html">PluginNotFound</a></td>
64
<td><span class="undocumented">Undocumented</span></td>
65
</tr><tr class="class">
67
<td class="lineno">124</td>
69
<td><a href="elisa.core.plugin_registry.PluginAlreadyEnabled.html">PluginAlreadyEnabled</a></td>
70
<td><span class="undocumented">Undocumented</span></td>
71
</tr><tr class="class">
73
<td class="lineno">127</td>
75
<td><a href="elisa.core.plugin_registry.PluginAlreadyDisabled.html">PluginAlreadyDisabled</a></td>
76
<td><span class="undocumented">Undocumented</span></td>
77
</tr><tr class="class">
79
<td class="lineno">130</td>
81
<td><a href="elisa.core.plugin_registry.DeserializationError.html">DeserializationError</a></td>
82
<td><span class="undocumented">Undocumented</span></td>
83
</tr><tr class="class">
85
<td class="lineno">133</td>
87
<td><a href="elisa.core.plugin_registry.PluginStatusMessage.html">PluginStatusMessage</a></td>
88
<td><span>A plugin has been enabled or disabled.</span></td>
89
</tr><tr class="class">
91
<td class="lineno">151</td>
93
<td><a href="elisa.core.plugin_registry.PluginRegistry.html">PluginRegistry</a></td>
94
<td><span>The plugin registry handles plugins in Elisa as long as it is
106
<div class="function">
107
<a name="elisa.core.plugin_registry.is_development_egg">
110
<a name="is_development_egg">
113
<div class="functionHeader">
116
is_development_egg(dist):
119
<div class="functionBody">
121
<div>Check if the distribution is a development egg.</p>
122
<p>Development eggs store egg-info and python code in the same toplevel
123
directory.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">dist</td><td>plugin distribution
124
(type: <code>Distribution</code>
125
)</td></tr></table></div>
127
</div><div class="function">
128
<a name="elisa.core.plugin_registry.get_plugin_toplevel_directory">
131
<a name="get_plugin_toplevel_directory">
134
<div class="functionHeader">
137
get_plugin_toplevel_directory(dist):
140
<div class="functionBody">
142
<div><p>Get the top level directory of a plugin distribution.</p>
143
<p>Regular eggs and development eggs store files in different locations.
144
Use this function to access the top level directory of a plugin eg:</p>
145
<pre class="literalblock">
146
toplevel_directory = get_plugin_toplevel_directory(dist)
147
sub_directory = '%s/%s' % (toplevel_directory, 'sub')
148
requirement = pkg_resources.Requirement.parse(dist.project_name)
149
if pkg_resources.resource_isdir(requirement, sub_directory):
150
real_sub_path = pkg_resources.resource_filename(requirement,
153
<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">dist</td><td>plugin distribution
154
(type: <code>Distribution</code>
155
)</td></tr></table></div>
159
<a href="index.html">API Documentation</a> for <a href="http://elisa.fluendo.com">Elisa Media Center</a>, generated by <a href="http://codespeak.net/~mwh/pydoctor/">pydoctor</a> at 2009-05-25 19:09:45.
b'\\ No newline at end of file'