From 255882a3f615c7727d2cc2f18f692513dc0a75e9 Mon Sep 17 00:00:00 2001
From: "Richard W.M. Jones" <rjones@redhat.com>
Date: Tue, 17 Apr 2012 17:41:43 +0100
Subject: python: Remove 'del g' from the docs, replace with 'g.close ()'.

'del g' is a trap for the unwary.  If the handle has any other
references, it does nothing (in fact, it can be actively dangerous if
the user was expecting the appliance to go away).  In non-CPython it
can be delayed arbitrarily long.

Using 'g.close()' on the other hand is always safe.
---
 python/examples/create_disk.py | 2 +-
 python/t/010-basic.py          | 2 +-
 python/t/060-optargs.py        | 2 +-
 python/t/400-events.py         | 2 +-
 4 files changed, 4 insertions(+), 4 deletions(-)

(limited to 'python')

diff --git a/python/examples/create_disk.py b/python/examples/create_disk.py
index 9d4e8d9b..c80fc6d9 100644
--- a/python/examples/create_disk.py
+++ b/python/examples/create_disk.py
@@ -58,4 +58,4 @@ g.upload ("/etc/resolv.conf", "/foo/resolv.conf")
 # Because 'autosync' was set (above) we can just close the handle
 # and the disk contents will be synchronized.  You can also do
 # this manually by calling g.umount_all and g.sync.
-del g
+g.close ()
diff --git a/python/t/010-basic.py b/python/t/010-basic.py
index 63bd6172..a97f3d24 100644
--- a/python/t/010-basic.py
+++ b/python/t/010-basic.py
@@ -31,6 +31,6 @@ g.lvcreate ("LV1", "VG", 200)
 g.lvcreate ("LV2", "VG", 200)
 if (g.lvs () != ["/dev/VG/LV1", "/dev/VG/LV2"]):
     raise "Error: g.lvs() returned incorrect result"
-del g
+g.close ()
 
 os.unlink ("test.img")
diff --git a/python/t/060-optargs.py b/python/t/060-optargs.py
index aae343dc..75ea06f3 100644
--- a/python/t/060-optargs.py
+++ b/python/t/060-optargs.py
@@ -22,4 +22,4 @@ g = guestfs.GuestFS()
 g.add_drive_opts ("/dev/null")
 g.add_drive_opts ("/dev/null", readonly = 1)
 g.add_drive_opts ("/dev/null", iface = "virtio", format = "qcow2")
-del g
+g.close ()
diff --git a/python/t/400-events.py b/python/t/400-events.py
index 9f96fb01..7e0fbc3b 100644
--- a/python/t/400-events.py
+++ b/python/t/400-events.py
@@ -53,6 +53,6 @@ g.set_autosync (1)
 # Close the handle.  The close callback should be invoked.
 if close_invoked != 0:
     raise "Error: close_invoked should be 0"
-del g
+g.close ()
 if close_invoked != 1:
     raise "Error: close_invoked should be 1"
-- 
cgit