fileutil: docstrings for non-obvious usage restrictions on methods of EncryptedTempor...
authordavid-sarah <david-sarah@jacaranda.org>
Sat, 17 Jul 2010 05:46:47 +0000 (22:46 -0700)
committerdavid-sarah <david-sarah@jacaranda.org>
Sat, 17 Jul 2010 05:46:47 +0000 (22:46 -0700)
src/allmydata/util/fileutil.py

index f671f7eade61ada89cbdf9785e0eb1b1a0d6c0cc..cf0cb66a836912ff4ddb62233f17474e9356258b 100644 (file)
@@ -144,17 +144,23 @@ class EncryptedTemporaryFile:
         return offset
 
     def read(self, size=-1):
+        """A read must not follow a write, or vice-versa, without an intervening seek."""
         index = self.file.tell()
         ciphertext = self.file.read(size)
         plaintext = self._crypt(index, ciphertext)
         return plaintext
 
     def write(self, plaintext):
+        """A read must not follow a write, or vice-versa, without an intervening seek.
+        If seeking and then writing causes a 'hole' in the file, the contents of the
+        hole are unspecified."""
         index = self.file.tell()
         ciphertext = self._crypt(index, plaintext)
         self.file.write(ciphertext)
 
     def truncate(self, newsize):
+        """Truncate or extend the file to 'newsize'. If it is extended, the contents after the
+        old end-of-file are unspecified. The file position after this operation is unspecified."""
         self.file.truncate(newsize)