expand with_* docstrings in invirt.common

[invirt/packages/invirt-base.git] / files / usr / share / python-support / sipb-xen-base / invirt / common.py

diff --git a/files/usr/share/python-support/sipb-xen-base/invirt/common.py b/files/usr/share/python-support/sipb-xen-base/invirt/common.py
index ca90714..b193ecc 100644 (file)
--- a/files/usr/share/python-support/sipb-xen-base/invirt/common.py
+++ b/files/usr/share/python-support/sipb-xen-base/invirt/common.py
@@ -26,7 +26,15 @@ def dicts2struct(x):
 #
 
 def with_closing(rsrc):
-    "Utility to emulate Python 2.5's `with closing(rsrc)` context manager."
+    """
+    Utility to emulate Python 2.5's `with closing(rsrc)` context manager.
+
+    E.g.,
+    @with_closing(file('/tmp/foo'))
+    def contents(f):
+        return f.read()
+    # now 'contents' is the contents of /tmp/foo
+    """
     def wrapper(func):
         try: return func(rsrc)
         finally: rsrc.close()
@@ -40,8 +48,8 @@ def with_lock_file(path):
     def input():
         print 'locked'
         return raw_input()
-    # decorator is executed immediately
-    print input # prints the input text
+    # prints 'locked'
+    print input # prints what raw_input() returned
     """
     def wrapper(func):
         @with_closing(file(path, 'w'))