Page Menu
Home
c4science
Search
Configure Global Search
Log In
Files
F120517141
Pyblio.Registry-module.html
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Mute Notifications
Award Token
Subscribers
None
File Metadata
Details
File Info
Storage
Attached
Created
Fri, Jul 4, 23:01
Size
10 KB
Mime Type
text/xml
Expires
Sun, Jul 6, 23:01 (1 d, 23 h)
Engine
blob
Format
Raw Data
Handle
27182415
Attached To
R3596 pybliographer
Pyblio.Registry-module.html
View Options
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Pyblio.Registry</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="Pyblio-module.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
pybliographer 1.3.3
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="Pyblio-module.html">Package Pyblio</a> ::
Module Registry
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="../private/Pyblio.Registry-module.html">show private</a> | hide private]</font></td></tr>
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="Pyblio.Registry-module.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF MODULE DESCRIPTION =========== -->
<h2 class="module">Module Pyblio.Registry</h2>
<p>Support for RIP files.</p>
<p>RIP files are files containing registering information for schemas,
and extension classes customized for these schemas (like importers,
exporters, citation formatters,...)</p>
First, you need to parse a few RIP repositories with <a
href="Pyblio.Registry-module.html#parse"
class="link"><code>parse</code></a>, then you can browse the results with
<a href="Pyblio.Registry-module.html#schemas"
class="link"><code>schemas</code></a>, <a
href="Pyblio.Registry-module.html#getSchema"
class="link"><code>getSchema</code></a> and <a
href="Pyblio.Registry-module.html#get"
class="link"><code>get</code></a>.
<hr/>
<!-- =========== START OF CLASSES =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Classes</th></tr>
<tr><td width="15%">
<b><a href="Pyblio.Registry.AdapterRIP-class.html"><code>AdapterRIP</code></a></b></td>
<td>A special RIP that keeps the description of an Adapter.</td></tr>
<tr><td width="15%">
<b><a href="Pyblio.Registry.RIP-class.html"><code>RIP</code></a></b></td>
<td>A RIP object represents a dynamic class that can be loaded on demand,
and that has been registered via the Registry system.</td></tr>
</table><br />
<!-- =========== START OF FUNCTION SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Function Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="Pyblio.Registry-module.html#get" class="summary-sig-name"><code>get</code></a>(<span class=summary-sig-arg>schema</span>,
<span class=summary-sig-arg>category</span>)</span></code>
<br />
Return the extensions in a given category, for a given schema.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="Pyblio.Registry-module.html#getSchema" class="summary-sig-name"><code>getSchema</code></a>(<span class=summary-sig-arg>schema</span>)</span></code>
<br />
Return the <a href="Pyblio.Schema.Schema-class.html"
class="link"><code>Pyblio.Schema.Schema</code></a> corresponding to an
identifier returned by <a href="Pyblio.Registry-module.html#schemas"
class="link"><code>schemas</code></a>.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="Pyblio.Registry-module.html#parse" class="summary-sig-name"><code>parse</code></a>(<span class=summary-sig-arg>directory</span>)</span></code>
<br />
Parse the specified directory, and load all the .rip files it
contains.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="parse_default"></a><span class="summary-sig"><span class="summary-sig-name">parse_default</span>()</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="Pyblio.Registry-module.html#reset" class="summary-sig-name"><code>reset</code></a>()</span></code>
<br />
Forget all the schemas and extensions previously parsed with <a
href="Pyblio.Registry-module.html#parse"
class="link"><code>parse</code></a>.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="Pyblio.Registry-module.html#schemas" class="summary-sig-name"><code>schemas</code></a>()</span></code>
<br />
Return the list of known schemas.</td></tr>
</table><br />
<!-- =========== START OF VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td>
<td><b><a href="Pyblio.Registry-module.html#RIP_dirs"><code>RIP_dirs</code></a></b> = <span title="{'system': '/home/fred/devel/pyblio/1.3/Pyblio/RIP', 'user': '/home/fred/.pyblio'}"><code>{'system': '/home/fred/devel/pyblio/1.3/Pybli<span class="variable-ellipsis">...</span></code>
</span></td></tr>
</table><br />
<!-- =========== START OF FUNCTION DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Function Details</th></tr>
</table>
<a name="get"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">get</span>(<span class=sig-arg>schema</span>,
<span class=sig-arg>category</span>)</span>
</h3>
Return the extensions in a given category, for a given schema.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="getSchema"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getSchema</span>(<span class=sig-arg>schema</span>)</span>
</h3>
Return the <a href="Pyblio.Schema.Schema-class.html"
class="link"><code>Pyblio.Schema.Schema</code></a> corresponding to an
identifier returned by <a href="Pyblio.Registry-module.html#schemas"
class="link"><code>schemas</code></a>.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="parse"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">parse</span>(<span class=sig-arg>directory</span>)</span>
</h3>
Parse the specified directory, and load all the .rip files it
contains.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="reset"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">reset</span>()</span>
</h3>
Forget all the schemas and extensions previously parsed with <a
href="Pyblio.Registry-module.html#parse"
class="link"><code>parse</code></a>.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="schemas"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">schemas</span>()</span>
</h3>
Return the list of known schemas.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="RIP_dirs"></a>
<h3>RIP_dirs</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>dict</code>
</dd>
<span title="{'system': '/home/fred/devel/pyblio/1.3/Pyblio/RIP', 'user': '/home/fred/.pyblio'}"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
{'system': '/home/fred/devel/pyblio/1.3/Pyblio/RIP',
'user': '/home/fred/.pyblio'} </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="Pyblio-module.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
pybliographer 1.3.3
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Sep 24 23:52:44 2006</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>
Event Timeline
Log In to Comment