X-Git-Url: https://wannabe.guru.org/gitweb/?a=blobdiff_plain;f=docs%2Fpyutils.files.rst;h=40ced78404b77c97e9573c5aca7d85ed9db8bf80;hb=993b0992473c12294ed659e52b532e1c8cf9cd1e;hp=c1152d8e3ea17c8e9a9dbb803c3c34dfaa15ccd6;hpb=b38920f24d1ac948958480c540bc4b8436186765;p=pyutils.git diff --git a/docs/pyutils.files.rst b/docs/pyutils.files.rst index c1152d8..40ced78 100644 --- a/docs/pyutils.files.rst +++ b/docs/pyutils.files.rst @@ -1,21 +1,14 @@ pyutils.files package ===================== +This subpackage contains utilities for dealing with files on disk. + Submodules ---------- pyutils.files.directory\_filter module -------------------------------------- -This module contains two classes meant to help reduce unnecessary disk -I/O operations: - -The first determines when the contents of a file held in memory are -identical to the file copy already on disk. The second is basically -the same except for the caller need not indicate the name of the disk -file because it will check the memory file's signature against a set -of signatures of all files in a particular directory on disk. - .. automodule:: pyutils.files.directory_filter :members: :undoc-members: @@ -24,11 +17,6 @@ of signatures of all files in a particular directory on disk. pyutils.files.file\_utils module -------------------------------- -This is a grab bag of file-related utilities. It has code to, for example, -read files transforming the text as its read, normalize pathnames, strip -extensions, read and manipulate atimes/mtimes/ctimes, compute a signature -based on a file's contents, traverse the file system recursively, etc... - .. automodule:: pyutils.files.file_utils :members: :undoc-members: @@ -37,14 +25,6 @@ based on a file's contents, traverse the file system recursively, etc... pyutils.files.lockfile module ----------------------------- -This is a lockfile implementation I created for use with cronjobs on -my machine to prevent multiple copies of a job from running in -parallel. When one job is running this code keeps a file on disk to -indicate a lock is held. Other copies will fail to start if they -detect this lock until the lock is released. There are provisions in -the code for timing out locks, cleaning up a lock when a signal is -received, gracefully retrying lock acquisition on failure, etc... - .. automodule:: pyutils.files.lockfile :members: :undoc-members: @@ -53,8 +33,6 @@ received, gracefully retrying lock acquisition on failure, etc... Module contents --------------- -This module contains utilities for dealing with files on disk. - .. automodule:: pyutils.files :members: :undoc-members: