Commits

Jason R. Coombs  committed 8e56e12

Update doc strings

  • Participants
  • Parent commits 4c8cef4

Comments (0)

Files changed (1)

File cherrypy/lib/lockfile.py

 """
-Platform-independent file locking.
+Platform-independent file locking. Inspired by and modeled after zc.lockfile.
 """
 
 import os
 
 
 class SystemLockFile(object):
+    """
+    An abstract base class for platform-specific locking.
+    """
 
     def __init__(self, path):
         self.path = path
         self.fp.close()
         del self.fp
 
+    #@abc.abstract_method
+    #def _lock_file(self):
+    #    """Attempt to obtain the lock on self.fp. Raise LockError if not
+    #    acquired."""
+
     def _unlock_file(self):
-        pass
+        """Attempt to obtain the lock on self.fp. Raise UnlockError if not
+        released."""
 
 
 class WindowsLockFile(SystemLockFile):