<?xml version="1.0" encoding="ascii"?> <!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>Bio.config.SeqDBRegistry</title> <link rel="stylesheet" href="epydoc.css" type="text/css" /> <script type="text/javascript" src="epydoc.js"></script> </head> <body bgcolor="white" text="black" link="blue" vlink="#204080" alink="#204080"> <!-- ==================== NAVIGATION BAR ==================== --> <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> <tr valign="middle"> <!-- Tree link --> <th> <a href="module-tree.html">Trees</a> </th> <!-- Index link --> <th> <a href="identifier-index.html">Indices</a> </th> <!-- Help link --> <th> <a href="help.html">Help</a> </th> <th class="navbar" width="100%"></th> </tr> </table> <table width="100%" cellpadding="0" cellspacing="0"> <tr valign="top"> <td width="100%"> <span class="breadcrumbs"> <a href="Bio-module.html">Package Bio</a> :: <a href="Bio.config-module.html">Package config</a> :: Module SeqDBRegistry </span> </td> <td> <table cellpadding="0" cellspacing="0"> <!-- hide/show private --> <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" onclick="toggle_private();">hide private</a>]</span></td></tr> <tr><td align="right"><span class="options" >[<a href="frames.html" target="_top">frames</a >] | <a href="Bio.config.SeqDBRegistry-module.html" target="_top">no frames</a>]</span></td></tr> </table> </td> </tr> </table> <!-- ==================== MODULE DESCRIPTION ==================== --> <h1 class="epydoc">Module SeqDBRegistry</h1><p class="nomargin-top"><span class="codelink"><a href="Bio.config.SeqDBRegistry-pysrc.html">source code</a></span></p> <p>This module handles seqdatabase.INI file.</p> <p>Classes: SeqDBRegistry Holds databases from seqdatabase.INI.</p> <!-- ==================== CLASSES ==================== --> <a name="section-Classes"></a> <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td colspan="2" class="table-header"> <table border="0" cellpadding="0" cellspacing="0" width="100%"> <tr valign="top"> <td align="left"><span class="table-header">Classes</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-Classes" class="privatelink" onclick="toggle_private();" >hide private</a>]</span></td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="Bio.config.SeqDBRegistry.SeqDBRegistry-class.html" class="summary-name">SeqDBRegistry</a><br /> This object implements a dictionary-like interface to sequence databases. </td> </tr> </table> <!-- ==================== FUNCTIONS ==================== --> <a name="section-Functions"></a> <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td colspan="2" class="table-header"> <table border="0" cellpadding="0" cellspacing="0" width="100%"> <tr valign="top"> <td align="left"><span class="table-header">Functions</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-Functions" class="privatelink" onclick="toggle_private();" >hide private</a>]</span></td> </tr> </table> </td> </tr> <tr class="private"> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="_warn"></a><span class="summary-sig-name">_warn</span>(<span class="summary-sig-arg">message</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="Bio.config.SeqDBRegistry-pysrc.html#_warn">source code</a></span> </td> </tr> </table> </td> </tr> <tr class="private"> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="_load_registry_objects"></a><span class="summary-sig-name">_load_registry_objects</span>(<span class="summary-sig-arg">ini_file</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="Bio.config.SeqDBRegistry-pysrc.html#_load_registry_objects">source code</a></span> </td> </tr> </table> </td> </tr> <tr class="private"> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="_make_biofetch_db"></a><span class="summary-sig-name">_make_biofetch_db</span>(<span class="summary-sig-arg">name</span>, <span class="summary-sig-arg">tagvalue_dict</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="Bio.config.SeqDBRegistry-pysrc.html#_make_biofetch_db">source code</a></span> </td> </tr> </table> </td> </tr> <tr class="private"> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="_make_biosql_db"></a><span class="summary-sig-name">_make_biosql_db</span>(<span class="summary-sig-arg">name</span>, <span class="summary-sig-arg">tagvalue_dict</span>)</span><br /> Register a BioSQL database defined in the registry.</td> <td align="right" valign="top"> <span class="codelink"><a href="Bio.config.SeqDBRegistry-pysrc.html#_make_biosql_db">source code</a></span> </td> </tr> </table> </td> </tr> <tr class="private"> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="_make_flat_db"></a><span class="summary-sig-name">_make_flat_db</span>(<span class="summary-sig-arg">name</span>, <span class="summary-sig-arg">tagvalue_dict</span>)</span><br /> Register a Berkeley or Flat indexed file defined in the registry.</td> <td align="right" valign="top"> <span class="codelink"><a href="Bio.config.SeqDBRegistry-pysrc.html#_make_flat_db">source code</a></span> </td> </tr> </table> </td> </tr> <tr class="private"> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="_openfu"></a><span class="summary-sig-name">_openfu</span>(<span class="summary-sig-arg">file_or_url</span>)</span><br /> Guess whether this is a file or url and open it.</td> <td align="right" valign="top"> <span class="codelink"><a href="Bio.config.SeqDBRegistry-pysrc.html#_openfu">source code</a></span> </td> </tr> </table> </td> </tr> <tr class="private"> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">list of URL's or paths to search for files</span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="Bio.config.SeqDBRegistry-module.html#_list_ini_paths" class="summary-sig-name" onclick="show_private();">_list_ini_paths</a>()</span><br /> The default places to look for registry files are:</td> <td align="right" valign="top"> <span class="codelink"><a href="Bio.config.SeqDBRegistry-pysrc.html#_list_ini_paths">source code</a></span> </td> </tr> </table> </td> </tr> <tr class="private"> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">list of files to search (in order)</span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="_list_ini_files"></a><span class="summary-sig-name">_list_ini_files</span>(<span class="summary-sig-arg">filename</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="Bio.config.SeqDBRegistry-pysrc.html#_list_ini_files">source code</a></span> </td> </tr> </table> </td> </tr> </table> <!-- ==================== VARIABLES ==================== --> <a name="section-Variables"></a> <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td colspan="2" class="table-header"> <table border="0" cellpadding="0" cellspacing="0" width="100%"> <tr valign="top"> <td align="left"><span class="table-header">Variables</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-Variables" class="privatelink" onclick="toggle_private();" >hide private</a>]</span></td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a name="seqdb"></a><span class="summary-name">seqdb</span> = <code title="seqdb">seqdb</code> </td> </tr> </table> <!-- ==================== FUNCTION DETAILS ==================== --> <a name="section-FunctionDetails"></a> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td colspan="2" class="table-header"> <table border="0" cellpadding="0" cellspacing="0" width="100%"> <tr valign="top"> <td align="left"><span class="table-header">Function Details</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-FunctionDetails" class="privatelink" onclick="toggle_private();" >hide private</a>]</span></td> </tr> </table> </td> </tr> </table> <a name="_list_ini_paths"></a> <div class="private"> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">_list_ini_paths</span>()</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="Bio.config.SeqDBRegistry-pysrc.html#_list_ini_paths">source code</a></span> </td> </tr></table> <p>The default places to look for registry files are:</p> <ul> <li> ${HOME}/.bioinformatics </li> <li> /etc/bioinformatics </li> <li> http://www.open-bio.org/registry <p>The OBDA_SEARCH_PATH environment variable, if specified, overrides the default. This should be a "+" separated list of paths or URL's.</p> </li> </ul> <dl class="fields"> <dt>Returns: list of URL's or paths to search for files</dt> </dl> </td></tr></table> </div> <br /> <!-- ==================== NAVIGATION BAR ==================== --> <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> <tr valign="middle"> <!-- Tree link --> <th> <a href="module-tree.html">Trees</a> </th> <!-- Index link --> <th> <a href="identifier-index.html">Indices</a> </th> <!-- Help link --> <th> <a href="help.html">Help</a> </th> <th class="navbar" width="100%"></th> </tr> </table> <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> Generated by Epydoc 3.0.1 on Mon Sep 15 09:26:27 2008 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" >http://epydoc.sourceforge.net</a> </td> </tr> </table> <script type="text/javascript"> <!-- // Private objects are initially displayed (because if // javascript is turned off then we want them to be // visible); but by default, we want to hide them. So hide // them unless we have a cookie that says to show them. checkCookie(); // --> </script> </body> </html>