Jason R. Coombs avatar Jason R. Coombs committed 8e56e12

Update doc strings

Comments (0)

Files changed (1)

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):
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.