Mercurial > p > roundup > code
diff roundup/backends/portalocker.py @ 2005:fc52d57c6c3e
documentation cleanup
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Wed, 11 Feb 2004 23:55:10 +0000 |
| parents | 0e123e7c6ddc |
| children | c648bebf021e |
line wrap: on
line diff
--- a/roundup/backends/portalocker.py Wed Feb 11 21:34:31 2004 +0000 +++ b/roundup/backends/portalocker.py Wed Feb 11 23:55:10 2004 +0000 @@ -2,11 +2,11 @@ # Requires python 1.5.2 or better. # ID line added by richard for Roundup file tracking -# $Id: portalocker.py,v 1.7 2003-08-26 00:29:20 richard Exp $ +# $Id: portalocker.py,v 1.8 2004-02-11 23:55:09 richard Exp $ -""" Cross-platform (posix/nt) API for flock-style file locking. +"""Cross-platform (posix/nt) API for flock-style file locking. -Synopsis: +Synopsis:: import portalocker file = open("somefile", "r+") @@ -15,18 +15,18 @@ file.write("foo") file.close() -If you know what you're doing, you may choose to +If you know what you're doing, you may choose to:: portalocker.unlock(file) before closing the file, but why? -Methods: +Methods:: lock( file, flags ) unlock( file ) -Constants: +Constants:: LOCK_EX LOCK_SH @@ -36,10 +36,12 @@ provided by John Nielsen <nielsenjf@my-deja.com> in the documentation that accompanies the win32 modules. -Author: Jonathan Feinberg <jdf@pobox.com> -Version: Id: portalocker.py,v 1.3 2001/05/29 18:47:55 Administrator Exp - **un-cvsified by richard so the version doesn't change** +:Author: Jonathan Feinberg <jdf@pobox.com> +:Version: Id: portalocker.py,v 1.3 2001/05/29 18:47:55 Administrator Exp + **un-cvsified by richard so the version doesn't change** """ +__docformat__ = 'restructuredtext' + import os if os.name == 'nt':
