TEST: Adjusted keep_file_open tests, and test changes to the

KEEP_FILE_OPEN_DEFAULT attribute.

Author: pauldmccarthy

nibabel/tests/test_arrayproxy.py

@@ -19,7 +19,8 @@
 
 import numpy as np
 
-from ..arrayproxy import ArrayProxy, is_proxy, reshape_dataobj
+from ..arrayproxy import (ArrayProxy, KEEP_FILE_OPEN_DEFAULT, is_proxy,
+                          reshape_dataobj)
 from ..openers import ImageOpener
 from ..nifti1 import Nifti1Header
 
@@ -409,9 +410,9 @@ def test_keep_file_open_true_false_invalid():
             ArrayProxy(fname, ((10, 10, 10), dtype), keep_file_open='cauto')
 
 
-def test_keep_file_open_default():
+def test_keep_file_open_auto():
     # Test the behaviour of the keep_file_open __init__ flag, when it is set to
-    # its default value
+    # 'auto'
     dtype = np.float32
     data  = np.arange(1000, dtype=dtype).reshape((10, 10, 10))
     with InTemporaryDirectory():
@@ -423,18 +424,75 @@ def test_keep_file_open_default():
          mock.patch('nibabel.arrayproxy.HAVE_INDEXED_GZIP', True), \
          mock.patch('nibabel.openers.SafeIndexedGzipFile', gzip.GzipFile,
                     create=True):
-        proxy = ArrayProxy(fname, ((10, 10, 10), dtype))
-        assert proxy._keep_file_open
         proxy = ArrayProxy(fname, ((10, 10, 10), dtype), keep_file_open='auto')
         assert proxy._keep_file_open
     # If no have_indexed_gzip, then keep_file_open should be False
+    with mock.patch('nibabel.openers.HAVE_INDEXED_GZIP', False), \
+         mock.patch('nibabel.arrayproxy.HAVE_INDEXED_GZIP', False), \
+         mock.patch('nibabel.openers.SafeIndexedGzipFile', None, create=True):
+        proxy = ArrayProxy(fname, ((10, 10, 10), dtype), keep_file_open='auto')
+        assert not proxy._keep_file_open
+
+
+def test_keep_file_open_default():
+    # Test the behaviour of the keep_file_open __init__ flag, when the
+    # arrayproxy.KEEP_FILE_OPEN_DEFAULT value is changed
+    dtype = np.float32
+    data  = np.arange(1000, dtype=dtype).reshape((10, 10, 10))
+    with InTemporaryDirectory():
+        fname  = 'testdata.gz'
+        with gzip.open(fname, 'wb') as fobj:
+            fobj.write(data.tostring(order='F'))
+    # The default value of KEEP_FILE_OPEN_DEFAULT should cause keep_file_open
+    # to be False, regardless of whether or not indexed_gzip is present
+    assert KEEP_FILE_OPEN_DEFAULT is False
     with mock.patch('nibabel.openers.HAVE_INDEXED_GZIP', False), \
          mock.patch('nibabel.arrayproxy.HAVE_INDEXED_GZIP', False), \
          mock.patch('nibabel.openers.SafeIndexedGzipFile', None, create=True):
         proxy = ArrayProxy(fname, ((10, 10, 10), dtype))
         assert not proxy._keep_file_open
-        proxy = ArrayProxy(fname, ((10, 10, 10), dtype), keep_file_open='auto')
+    with mock.patch('nibabel.openers.HAVE_INDEXED_GZIP', True), \
+         mock.patch('nibabel.arrayproxy.HAVE_INDEXED_GZIP', True), \
+         mock.patch('nibabel.openers.SafeIndexedGzipFile', gzip.GzipFile,
+                    create=True):
+        proxy = ArrayProxy(fname, ((10, 10, 10), dtype))
+        assert not proxy._keep_file_open
+    # KEEP_FILE_OPEN_DEFAULT=True should cause keep_file_open to be True,
+    # regardless of whether or not indexed_gzip is present
+    with mock.patch('nibabel.arrayproxy.KEEP_FILE_OPEN_DEFAULT', True), \
+         mock.patch('nibabel.openers.HAVE_INDEXED_GZIP', True), \
+         mock.patch('nibabel.arrayproxy.HAVE_INDEXED_GZIP', True), \
+         mock.patch('nibabel.openers.SafeIndexedGzipFile', gzip.GzipFile,
+                    create=True):
+        proxy = ArrayProxy(fname, ((10, 10, 10), dtype))
+        assert proxy._keep_file_open
+    with mock.patch('nibabel.arrayproxy.KEEP_FILE_OPEN_DEFAULT', True), \
+         mock.patch('nibabel.openers.HAVE_INDEXED_GZIP', False), \
+         mock.patch('nibabel.arrayproxy.HAVE_INDEXED_GZIP', False), \
+         mock.patch('nibabel.openers.SafeIndexedGzipFile', None, create=True):
+        proxy = ArrayProxy(fname, ((10, 10, 10), dtype))
+        assert proxy._keep_file_open
+    # KEEP_FILE_OPEN_DEFAULT=auto should cause keep_file_open to be True
+    # or False, depending on whether indeed_gzip is present,
+    with mock.patch('nibabel.arrayproxy.KEEP_FILE_OPEN_DEFAULT', 'auto'), \
+         mock.patch('nibabel.openers.HAVE_INDEXED_GZIP', True), \
+         mock.patch('nibabel.arrayproxy.HAVE_INDEXED_GZIP', True), \
+         mock.patch('nibabel.openers.SafeIndexedGzipFile', gzip.GzipFile,
+                    create=True):
+        proxy = ArrayProxy(fname, ((10, 10, 10), dtype))
+        assert proxy._keep_file_open
+    with mock.patch('nibabel.arrayproxy.KEEP_FILE_OPEN_DEFAULT', 'auto'), \
+         mock.patch('nibabel.openers.HAVE_INDEXED_GZIP', False), \
+         mock.patch('nibabel.arrayproxy.HAVE_INDEXED_GZIP', False), \
+         mock.patch('nibabel.openers.SafeIndexedGzipFile', None, create=True):
+        proxy = ArrayProxy(fname, ((10, 10, 10), dtype))
         assert not proxy._keep_file_open
+    # KEEP_FILE_OPEN_DEFAULT=any other value should cuse an error to be raised
+    with mock.patch('nibabel.arrayproxy.KEEP_FILE_OPEN_DEFAULT', 'badvalue'):
+        assert_raises(ValueError,  ArrayProxy, fname, ((10, 10, 10), dtype))
+    with mock.patch('nibabel.arrayproxy.KEEP_FILE_OPEN_DEFAULT', None):
+        assert_raises(ValueError,  ArrayProxy, fname, ((10, 10, 10), dtype))
+
 
 def test_pickle_lock():
     # Test that ArrayProxy can be pickled, and that thread lock is created