twisted.python.filepath.FilePath.html [plain text]
<?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>twisted.python.filepath.FilePath</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="twisted.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">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</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="twisted.html">Package twisted</a> ::
<a href="twisted.python.html">Package python</a> ::
<a href="twisted.python.filepath.html">Module filepath</a> ::
Class FilePath
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.python.filepath.FilePath.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class FilePath</h2>
<dl><dt><b>Known Subclasses:</b></dt>
<dd>
<a href="twisted.web.twcgi.CGIDirectory.html"><code>CGIDirectory</code></a>,
<a href="twisted.web.static.File.html"><code>File</code></a></dd></dl>
<hr/>
<p>I am a path on the filesystem that only permits 'downwards'
access.</p>
<p>Instantiate me with a pathname (for example,
FilePath('/home/myuser/public_html')) and I will attempt to only provide
access to files which reside insidpe that path. I may be a path to a
file, a directory, or a file which does not exist.</p>
<p>The correct way to use me is to instantiate me, and then do ALL
filesystem access through me. In other words, do not import the 'os'
module; if you need to open a file, call my 'open' method. If you need to
list a directory, call my 'path' method.</p>
Even if you pass me a relative path, I will convert that to an
absolute path internally.
<hr/>
<!-- =========== START OF METHOD SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Method Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>path</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__getstate__"></a><span class="summary-sig"><span class="summary-sig-name">__getstate__</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__repr__"></a><span class="summary-sig"><span class="summary-sig-name">__repr__</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="basename"></a><span class="summary-sig"><span class="summary-sig-name">basename</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="child"></a><span class="summary-sig"><span class="summary-sig-name">child</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>path</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="twisted.python.filepath.FilePath.html#childSearchPreauth" class="summary-sig-name"><code>childSearchPreauth</code></a>(<span class=summary-sig-arg>self</span>,
<span class="summary-sig-vararg">*paths</span>)</span></code>
<br />
Return my first existing child with a name in 'paths'.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="exists"></a><span class="summary-sig"><span class="summary-sig-name">exists</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="getatime"></a><span class="summary-sig"><span class="summary-sig-name">getatime</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="getContent"></a><span class="summary-sig"><span class="summary-sig-name">getContent</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="getctime"></a><span class="summary-sig"><span class="summary-sig-name">getctime</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="getmtime"></a><span class="summary-sig"><span class="summary-sig-name">getmtime</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="getsize"></a><span class="summary-sig"><span class="summary-sig-name">getsize</span>(<span class=summary-sig-arg>self</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="twisted.python.filepath.FilePath.html#globChildren" class="summary-sig-name"><code>globChildren</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>pattern</span>)</span></code>
<br />
Assuming I am representing a directory, return a list of FilePaths
representing my children that match the given pattern.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="isabs"></a><span class="summary-sig"><span class="summary-sig-name">isabs</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="isdir"></a><span class="summary-sig"><span class="summary-sig-name">isdir</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="isfile"></a><span class="summary-sig"><span class="summary-sig-name">isfile</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="islink"></a><span class="summary-sig"><span class="summary-sig-name">islink</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="listdir"></a><span class="summary-sig"><span class="summary-sig-name">listdir</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="makedirs"></a><span class="summary-sig"><span class="summary-sig-name">makedirs</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="open"></a><span class="summary-sig"><span class="summary-sig-name">open</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>mode</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="twisted.python.filepath.FilePath.html#preauthChild" class="summary-sig-name"><code>preauthChild</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>path</span>)</span></code>
<br />
Use me if `path' might have slashes in it, but you know they're
safe.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="remove"></a><span class="summary-sig"><span class="summary-sig-name">remove</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="restat"></a><span class="summary-sig"><span class="summary-sig-name">restat</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>reraise</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="setContent"></a><span class="summary-sig"><span class="summary-sig-name">setContent</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>content</span>,
<span class=summary-sig-arg>ext</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="siblingExtension"></a><span class="summary-sig"><span class="summary-sig-name">siblingExtension</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>ext</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="twisted.python.filepath.FilePath.html#siblingExtensionSearch" class="summary-sig-name"><code>siblingExtensionSearch</code></a>(<span class=summary-sig-arg>self</span>,
<span class="summary-sig-vararg">*exts</span>)</span></code>
<br />
Attempt to return a path with my name, given multiple possible
extensions.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="splitext"></a><span class="summary-sig"><span class="summary-sig-name">splitext</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="touch"></a><span class="summary-sig"><span class="summary-sig-name">touch</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
</table><br />
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Class Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>class</code></font></td>
<td><a name="clonePath"></a><b><code>clonePath</code></b> = <a href="twisted.python.filepath.FilePath.html"><code>twisted.python.filepath.FilePath</code></a></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
<td><b><a href="twisted.python.filepath.FilePath.html#statinfo"><code>statinfo</code></a></b> = <span title="None">None </span></td></tr>
</table><br />
<!-- =========== START OF METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Method Details</th></tr>
</table>
<a name="childSearchPreauth"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">childSearchPreauth</span>(<span class=sig-arg>self</span>,
<span class="sig-vararg">*paths</span>)</span>
</h3>
<p>Return my first existing child with a name in 'paths'.</p>
<p>paths is expected to be a list of *pre-secured* path fragments; in
most cases this will be specified by a system administrator and not an
arbitrary user.</p>
If no appropriately-named children exist, this will return None.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="globChildren"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">globChildren</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>pattern</span>)</span>
</h3>
Assuming I am representing a directory, return a list of FilePaths
representing my children that match the given pattern.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="preauthChild"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">preauthChild</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>path</span>)</span>
</h3>
<p>Use me if `path' might have slashes in it, but you know they're
safe.</p>
(NOT slashes at the beginning. It still needs to be a _child_).
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="siblingExtensionSearch"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">siblingExtensionSearch</span>(<span class=sig-arg>self</span>,
<span class="sig-vararg">*exts</span>)</span>
</h3>
<p>Attempt to return a path with my name, given multiple possible
extensions.</p>
<p>Each extension in exts will be tested and the first path which
exists will be returned. If no path exists, None will be returned. If
'' is in exts, then if the file referred to by this path exists, 'self'
will be returned.</p>
The extension '*' has a magic meaning, which means "any path
that begins with self.path+'.' is acceptable".
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Class Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="statinfo"></a>
<h3>statinfo</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>NoneType</code>
</dd>
<span title="None"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
None </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="twisted.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">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</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.0 on Sat May 15 20:08:51 2004</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>