--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/api/python/pathaddition.relative-module.html Fri Sep 11 11:54:49 2009 +0100
@@ -0,0 +1,337 @@
+<?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>pathaddition.relative</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="pathaddition-module.html">Package pathaddition</a> ::
+ Module relative
+ </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="pathaddition.relative-module.html"
+ target="_top">no frames</a>]</span></td></tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<!-- ==================== MODULE DESCRIPTION ==================== -->
+<h1 class="epydoc">Module relative</h1><span class="codelink"><a href="pathaddition.relative-pysrc.html">source code</a></span><br /><br />
+Additional path functionnality.
+abs2rel
+rel2abs<br /><br />
+
+<!-- ==================== 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>
+ <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="isabs"></a><span class="summary-sig-name">isabs</span>(<span class="summary-sig-arg">string</span>)</span><br />
+ @return true if string is an absolute path or protocoladdress
+for addresses beginning in <a class="rst-reference external" href="http://" target="_top">http://</a> or <a class="rst-reference external" href="ftp://" target="_top">ftp://</a> or <a class="rst-reference external" href="ldap://" target="_top">ldap://</a> -
+they are considered "absolute" paths.</td>
+ <td align="right" valign="top">
+ <span class="codelink"><a href="pathaddition.relative-pysrc.html#isabs">source code</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">
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td><span class="summary-sig"><a href="pathaddition.relative-module.html#rel2abs" class="summary-sig-name">rel2abs</a>(<span class="summary-sig-arg">path</span>,
+ <span class="summary-sig-arg">base</span>=<span class="summary-sig-default">None</span>)</span><br />
+ converts a relative path to an absolute path.</td>
+ <td align="right" valign="top">
+ <span class="codelink"><a href="pathaddition.relative-pysrc.html#rel2abs">source code</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">
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td><span class="summary-sig"><a name="pathsplit"></a><span class="summary-sig-name">pathsplit</span>(<span class="summary-sig-arg">p</span>,
+ <span class="summary-sig-arg">rest</span>=<span class="summary-sig-default">None</span>)</span><br />
+ Split path to pieces</td>
+ <td align="right" valign="top">
+ <span class="codelink"><a href="pathaddition.relative-pysrc.html#pathsplit">source code</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">
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td><span class="summary-sig"><a name="commonpath"></a><span class="summary-sig-name">commonpath</span>(<span class="summary-sig-arg">l1</span>,
+ <span class="summary-sig-arg">l2</span>,
+ <span class="summary-sig-arg">common</span>=<span class="summary-sig-default">None</span>)</span><br />
+ return the common path</td>
+ <td align="right" valign="top">
+ <span class="codelink"><a href="pathaddition.relative-pysrc.html#commonpath">source code</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">
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td><span class="summary-sig"><a name="relpath"></a><span class="summary-sig-name">relpath</span>(<span class="summary-sig-arg">p1</span>,
+ <span class="summary-sig-arg">p2</span>)</span></td>
+ <td align="right" valign="top">
+ <span class="codelink"><a href="pathaddition.relative-pysrc.html#relpath">source code</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">
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td><span class="summary-sig"><a href="pathaddition.relative-module.html#abs2rel" class="summary-sig-name">abs2rel</a>(<span class="summary-sig-arg">path</span>,
+ <span class="summary-sig-arg">base</span>=<span class="summary-sig-default">None</span>)</span><br />
+ @return a relative path from base to path.</td>
+ <td align="right" valign="top">
+ <span class="codelink"><a href="pathaddition.relative-pysrc.html#abs2rel">source code</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">
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td><span class="summary-sig"><a name="commonprefix"></a><span class="summary-sig-name">commonprefix</span>(<span class="summary-sig-arg">paths</span>)</span><br />
+ Returns the common prefix base on the path components.</td>
+ <td align="right" valign="top">
+ <span class="codelink"><a href="pathaddition.relative-pysrc.html#commonprefix">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="protocolPattern"></a><span class="summary-name">protocolPattern</span> = <code title="re.compile(r'^\w+://')">re.compile(r'^\w+://')</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="rel2abs"></a>
+<div>
+<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">rel2abs</span>(<span class="sig-arg">path</span>,
+ <span class="sig-arg">base</span>=<span class="sig-default">None</span>)</span>
+ </h3>
+ </td><td align="right" valign="top"
+ ><span class="codelink"><a href="pathaddition.relative-pysrc.html#rel2abs">source code</a></span>
+ </td>
+ </table>
+
+ <p>converts a relative path to an absolute path.</p>
+<p>@param path the path to convert - if already absolute, is returned
+without conversion.
+@param base - optional. Defaults to the current directory.
+The base is intelligently concatenated to the given relative path.
+@return the relative path of path from base</p>
+ <dl class="fields">
+ </dl>
+</td></tr></table>
+</div>
+<a name="abs2rel"></a>
+<div>
+<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">abs2rel</span>(<span class="sig-arg">path</span>,
+ <span class="sig-arg">base</span>=<span class="sig-default">None</span>)</span>
+ </h3>
+ </td><td align="right" valign="top"
+ ><span class="codelink"><a href="pathaddition.relative-pysrc.html#abs2rel">source code</a></span>
+ </td>
+ </table>
+
+ <p>@return a relative path from base to path.</p>
+<p>base can be absolute, or relative to curdir, or defaults
+to curdir.</p>
+ <dl class="fields">
+ </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.0beta1 on Wed Sep 09 13:44:16 2009
+ </td>
+ <td align="right" class="footer">
+ <a 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>