sam-t2/devtools/v9/html/python/lib/module-dircache.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="lib.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index' />
<link rel="first" href="lib.html" title='Python Library Reference' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="module-stat.html" />
<link rel="prev" href="module-os.path.html" />
<link rel="parent" href="allos.html" />
<link rel="next" href="module-stat.html" />
<meta name='aesop' content='information' />
<title>6.3 dircache -- Cached directory listings</title>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="6.2 os.path  "
  href="module-os.path.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="6. Generic Operating System"
  href="allos.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="6.4 stat  "
  href="module-stat.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-os.path.html">6.2 os.path  </A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="allos.html">6. Generic Operating System</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="module-stat.html">6.4 stat  </A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H1><A NAME="SECTION008300000000000000000">
6.3 <tt class="module">dircache</tt> --
         Cached directory listings</A>
</H1>

<P>
<A NAME="module-dircache"></A>

<P>
The <tt class="module">dircache</tt> module defines a function for reading directory listing
using a cache, and cache invalidation using the <var>mtime</var> of the directory.
Additionally, it defines a function to annotate directories by appending
a slash.

<P>
The <tt class="module">dircache</tt> module defines the following functions:

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-1772' xml:id='l2h-1772' class="function">listdir</tt></b>(</nobr></td>
  <td><var>path</var>)</td></tr></table></dt>
<dd>
Return a directory listing of <var>path</var>, as gotten from
<tt class="function">os.listdir()</tt>. Note that unless <var>path</var> changes, further call
to <tt class="function">listdir()</tt> will not re-read the directory structure.

<P>
Note that the list returned should be regarded as read-only. (Perhaps
a future version should change it to return a tuple?)
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-1773' xml:id='l2h-1773' class="function">opendir</tt></b>(</nobr></td>
  <td><var>path</var>)</td></tr></table></dt>
<dd>
Same as <tt class="function">listdir()</tt>. Defined for backwards compatibility.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-1774' xml:id='l2h-1774' class="function">annotate</tt></b>(</nobr></td>
  <td><var>head, list</var>)</td></tr></table></dt>
<dd>
Assume <var>list</var> is a list of paths relative to <var>head</var>, and append,
in place, a "<tt class="character">/</tt>" to each path which points to a directory.
</dl>

<P>
<div class="verbatim"><pre>
&gt;&gt;&gt; import dircache
&gt;&gt;&gt; a = dircache.listdir('/')
&gt;&gt;&gt; a = a[:] # Copy the return value so we can change 'a'
&gt;&gt;&gt; a
['bin', 'boot', 'cdrom', 'dev', 'etc', 'floppy', 'home', 'initrd', 'lib', 'lost+
found', 'mnt', 'proc', 'root', 'sbin', 'tmp', 'usr', 'var', 'vmlinuz']
&gt;&gt;&gt; dircache.annotate('/', a)
&gt;&gt;&gt; a
['bin/', 'boot/', 'cdrom/', 'dev/', 'etc/', 'floppy/', 'home/', 'initrd/', 'lib/
', 'lost+found/', 'mnt/', 'proc/', 'root/', 'sbin/', 'tmp/', 'usr/', 'var/', 'vm
linuz']
</pre></div>

<DIV CLASS="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="6.2 os.path  "
  href="module-os.path.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="6. Generic Operating System"
  href="allos.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="6.4 stat  "
  href="module-stat.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-os.path.html">6.2 os.path  </A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="allos.html">6. Generic Operating System</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="module-stat.html">6.4 stat  </A>
</div>
</div>
<hr />
<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
</DIV>
<!--End of Navigation Panel-->
<ADDRESS>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</ADDRESS>
</BODY>
</HTML>