New module documentation sections from Moshe Zadka <moshez@math.huji.ac.il>!

1 files changed, 45 insertions, 0 deletions

diff --git a/Doc/lib/libdircache.tex b/Doc/lib/libdircache.tex
new file mode 100644
index 0000000..cb26d51
--- /dev/null
+++ b/Doc/lib/libdircache.tex
@@ -0,0 +1,45 @@
+\section{\module{dircache} ---
+         Cached directory listings}
+
+\declaremodule{standard}{dircache}
+\sectionauthor{Moshe Zadka}{mzadka@geocities.com}
+\modulesynopsis{Return directory listing, with cache mechanism.}
+
+The \module{dircache} module defines a function for reading directory listing
+using a cache, and cache invalidation using the \var{mtime} of the directory.
+Additionally, it defines a function to annotate directories by appending
+a slash.
+
+The \module{dircache} module defines the following functions:
+
+\begin{funcdesc}{listdir}{path}
+Return a directory listing of \var{path}, as gotten from
+\function{os.listdir()}. Note that unless \var{path} changes, further call
+to \function{listdir()} will not re-read the directory structure.
+
+Note that the list returned should be regarded as read-only. (Perhaps
+a future version should change it to return a tuple?)
+\end{funcdesc}
+
+\begin{funcdesc}{opendir}{path}
+Same as \function{listdir()}. Defined for backwards compatability.
+\end{funcdesc}
+
+\begin{funcdesc}{annotate}{head, list}
+Assume \var{list} is a list of pathes relative to \var{head}, and append,
+in place, a \character{/} to each path which points to a directory.
+\end{funcdesc}
+
+\begin{verbatim}
+>>> import dircache
+>>> a=dircache.listdir('/')
+>>> a=a[:] # Copy the return value so we can change 'a'
+>>> a
+['bin', 'boot', 'cdrom', 'dev', 'etc', 'floppy', 'home', 'initrd', 'lib', 'lost+
+found', 'mnt', 'proc', 'root', 'sbin', 'tmp', 'usr', 'var', 'vmlinuz']
+>>> dircache.annotate('/', a)
+>>> a
+['bin/', 'boot/', 'cdrom/', 'dev/', 'etc/', 'floppy/', 'home/', 'initrd/', 'lib/
+', 'lost+found/', 'mnt/', 'proc/', 'root/', 'sbin/', 'tmp/', 'usr/', 'var/', 'vm
+linuz']
+\end{verbatim}