From: Zooko O'Whielacronx Date: Mon, 4 Jun 2007 11:44:44 +0000 (-0700) Subject: zfec: update doc strings in fileutil X-Git-Tag: allmydata-tahoe-0.5.0~109 X-Git-Url: https://git.rkrishnan.org/zeppelin?a=commitdiff_plain;h=5643ef81a145ad06ec80d1a86d2a7d166cdf862e;p=tahoe-lafs%2Ftahoe-lafs.git zfec: update doc strings in fileutil --- diff --git a/src/zfec/zfec/util/fileutil.py b/src/zfec/zfec/util/fileutil.py index 79d98592..147ecbf8 100644 --- a/src/zfec/zfec/util/fileutil.py +++ b/src/zfec/zfec/util/fileutil.py @@ -96,7 +96,7 @@ class _Dir(object): Create a subdirectory in the tempdir and remember it so as to call shutdown() on it before attempting to clean up. - @rtype: NamedTemporaryDirectory instance + @rtype: _Dir instance """ ffn = os.path.join(self.name, dirname) sd = _Dir(ffn, self.cleanup) @@ -143,12 +143,12 @@ class NamedTemporaryDirectory(_Dir): Call tempfile.mkdtemp(), store the name of the dir in self.name, and rm_dir() when it gets garbage collected or "shutdown()". - Also optionally keep track of file objects for files within the tempdir - and call close() on them before rm_dir(). This is a convenient way to - open temp files within the directory, and it is very helpful on Windows - because you can't delete a directory which contains a file which is - currently open. + Also keep track of file objects for files within the tempdir and call + close() on them before rm_dir(). This is a convenient way to open temp + files within the directory, and it is very helpful on Windows because you + can't delete a directory which contains a file which is currently open. """ + def __init__(self, cleanup=True, *args, **kwargs): """ If cleanup, then the directory will be rmrf'ed when the object is shutdown. """ name = tempfile.mkdtemp(*args, **kwargs)