summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorBrett Cannon <bcannon@gmail.com>2008-05-10 21:11:46 (GMT)
committerBrett Cannon <bcannon@gmail.com>2008-05-10 21:11:46 (GMT)
commitf4fd99344a9c18c1aaee2f1840907e4a38576edd (patch)
tree1226807b9e4bf901a4d19819cef15b9bfadb21fa /Doc
parent7ecf3dcaeec4c0561fa2a952b08c259f3a542587 (diff)
downloadcpython-f4fd99344a9c18c1aaee2f1840907e4a38576edd.zip
cpython-f4fd99344a9c18c1aaee2f1840907e4a38576edd.tar.gz
cpython-f4fd99344a9c18c1aaee2f1840907e4a38576edd.tar.bz2
Remove the dircache module.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/dircache.rst56
-rw-r--r--Doc/library/filesys.rst1
2 files changed, 0 insertions, 57 deletions
diff --git a/Doc/library/dircache.rst b/Doc/library/dircache.rst
deleted file mode 100644
index 28aa667..0000000
--- a/Doc/library/dircache.rst
+++ /dev/null
@@ -1,56 +0,0 @@
-
-:mod:`dircache` --- Cached directory listings
-=============================================
-
-.. module:: dircache
- :synopsis: Return directory listing, with cache mechanism.
-.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
-
-
-The :mod:`dircache` module defines a function for reading directory listing
-using a cache, and cache invalidation using the *mtime* of the directory.
-Additionally, it defines a function to annotate directories by appending a
-slash.
-
-The :mod:`dircache` module defines the following functions:
-
-
-.. function:: reset()
-
- Resets the directory cache.
-
-
-.. function:: listdir(path)
-
- Return a directory listing of *path*, as gotten from :func:`os.listdir`. Note
- that unless *path* changes, further call to :func:`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?)
-
-
-.. function:: opendir(path)
-
- Same as :func:`listdir`. Defined for backwards compatibility.
-
-
-.. function:: annotate(head, list)
-
- Assume *list* is a list of paths relative to *head*, and append, in place, a
- ``'/'`` to each path which points to a directory.
-
-::
-
- >>> 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']
-
diff --git a/Doc/library/filesys.rst b/Doc/library/filesys.rst
index e5b5e44..c3d9df0 100644
--- a/Doc/library/filesys.rst
+++ b/Doc/library/filesys.rst
@@ -23,7 +23,6 @@ in this chapter is:
fnmatch.rst
linecache.rst
shutil.rst
- dircache.rst
macpath.rst