MNT: Remove support for keep_file_open=="auto"

Author: effigies

nibabel/analyze.py

@@ -939,7 +939,7 @@ def from_file_map(klass, file_map, mmap=True, keep_file_open=None):
 
         .. deprecated:: 2.4.1
             ``keep_file_open='auto'`` is redundant with `False` and has
-            been deprecated. It will raise an error in nibabel 3.0.
+            been deprecated. It raises an error as of nibabel 3.0.
 
         Parameters
         ----------

nibabel/arrayproxy.py

@@ -48,15 +48,13 @@
 
 If this flag is set to ``True``, a single file handle is created and used. If
 ``False``, a new file handle is created every time the image is accessed.
-If this flag is set to ``'auto'``, a ``DeprecationWarning`` will be raised, which
-will become a ``ValueError`` in nibabel 3.0.0.
 
 If this is set to any other value, attempts to create an ``ArrayProxy`` without
 specifying the ``keep_file_open`` flag will result in a ``ValueError`` being
 raised.
 
 .. warning:: Setting this flag to a value of ``'auto'`` became deprecated
-             behaviour in version 2.4.1. Support for ``'auto'`` will be removed
+             behaviour in version 2.4.1. Support for ``'auto'`` was removed
              in version 3.0.0.
 """
 KEEP_FILE_OPEN_DEFAULT = False
@@ -102,7 +100,7 @@ def __init__(self, file_like, spec, mmap=True, keep_file_open=None):
 
         .. deprecated:: 2.4.1
             ``keep_file_open='auto'`` is redundant with `False` and has
-            been deprecated. It will raise an error in nibabel 3.0.
+            been deprecated. It raises an error as of nibabel 3.0.
 
         Parameters
         ----------
@@ -239,14 +237,14 @@ def _should_keep_file_open(self, file_like, keep_file_open):
 
         .. deprecated:: 2.4.1
             ``keep_file_open='auto'`` is redundant with `False` and has
-            been deprecated. It will be removed in nibabel 3.0.
+            been deprecated. It raises an error as of nibabel 3.0.
 
         Parameters
         ----------
 
         file_like : object
             File-like object or filename, as passed to ``__init__``.
-        keep_file_open : { 'auto', True, False }
+        keep_file_open : { True, False }
             Flag as passed to ``__init__``.
 
         Returns
@@ -259,23 +257,17 @@ def _should_keep_file_open(self, file_like, keep_file_open):
         """
         if keep_file_open is None:
             keep_file_open = KEEP_FILE_OPEN_DEFAULT
-            if keep_file_open == 'auto':
-                warnings.warn("Setting nibabel.arrayproxy.KEEP_FILE_OPEN_DEFAULT to 'auto' is "
-                              "deprecated and will become an error in v3.0.", DeprecationWarning)
-        if keep_file_open == 'auto':
-            warnings.warn("A value of 'auto' for keep_file_open is deprecated and will become an "
-                          "error in v3.0. You probably want False.", DeprecationWarning)
+            if keep_file_open not in (True, False):
+                raise ValueError("nibabel.arrayproxy.KEEP_FILE_OPEN_DEFAULT must be boolean. "
+                                 "Found: {}".format(keep_file_open))
         elif keep_file_open not in (True, False):
-            raise ValueError('keep_file_open should be one of {None, True, False}')
+            raise ValueError('keep_file_open must be one of {None, True, False}')
 
         # file_like is a handle - keep_file_open is irrelevant
         if hasattr(file_like, 'read') and hasattr(file_like, 'seek'):
             return False, False
         # if the file is a gzip file, and we have_indexed_gzip,
         have_igzip = openers.HAVE_INDEXED_GZIP and file_like.endswith('.gz')
-        # XXX Remove in v3.0
-        if keep_file_open == 'auto':
-            return have_igzip, have_igzip
 
         persist_opener = keep_file_open or have_igzip
         return keep_file_open, persist_opener

nibabel/brikhead.py

@@ -227,7 +227,7 @@ def __init__(self, file_like, header, mmap=True, keep_file_open=None):
 
         .. deprecated:: 2.4.1
             ``keep_file_open='auto'`` is redundant with `False` and has
-            been deprecated. It will raise an error in nibabel 3.0.
+            been deprecated. It raises an error as of nibabel 3.0.
 
         Parameters
         ----------
@@ -511,7 +511,7 @@ def from_file_map(klass, file_map, mmap=True, keep_file_open=None):
 
         .. deprecated:: 2.4.1
             ``keep_file_open='auto'`` is redundant with `False` and has
-            been deprecated. It will raise an error in nibabel 3.0.
+            been deprecated. It raises an error as of nibabel 3.0.
 
         Parameters
         ----------

nibabel/dataobj_images.py

@@ -421,7 +421,7 @@ def from_file_map(klass, file_map, mmap=True, keep_file_open=None):
 
         .. deprecated:: 2.4.1
             ``keep_file_open='auto'`` is redundant with `False` and has
-            been deprecated. It will raise an error in nibabel 3.0.
+            been deprecated. It raises an error as of nibabel 3.0.
 
         Parameters
         ----------
@@ -459,7 +459,7 @@ def from_filename(klass, filename, mmap=True, keep_file_open=None):
 
         .. deprecated:: 2.4.1
             ``keep_file_open='auto'`` is redundant with `False` and has
-            been deprecated. It will raise an error in nibabel 3.0.
+            been deprecated. It raises an error as of nibabel 3.0.
 
         Parameters
         ----------

nibabel/freesurfer/mghformat.py

@@ -543,7 +543,7 @@ def from_file_map(klass, file_map, mmap=True, keep_file_open=None):
 
         .. deprecated:: 2.4.1
             ``keep_file_open='auto'`` is redundant with `False` and has
-            been deprecated. It will raise an error in nibabel 3.0.
+            been deprecated. It raises an error as of nibabel 3.0.
 
         Parameters
         ----------

nibabel/spm99analyze.py

@@ -250,7 +250,7 @@ def from_file_map(klass, file_map, mmap=True, keep_file_open=None):
 
         .. deprecated:: 2.4.1
             ``keep_file_open='auto'`` is redundant with `False` and has
-            been deprecated. It will raise an error in nibabel 3.0.
+            been deprecated. It raises an error as of nibabel 3.0.
 
         Parameters
         ----------

nibabel/tests/test_arrayproxy.py

@@ -372,8 +372,6 @@ def test_keep_file_open_true_false_invalid():
     # False     | True             | True                | True
     # True      | False            | True                | n/a
     # True      | True             | True                | False
-    # 'auto'    | False            | False               | n/a
-    # 'auto'    | True             | True                | False
     #
     # Each test tuple contains:
     #  - file type - gzipped ('gz') or not ('bin'), or an open file handle
@@ -388,26 +386,18 @@ def test_keep_file_open_true_false_invalid():
         ('open', False,  True,  False, False),
         ('open', True,   False, False, False),
         ('open', True,   True,  False, False),
-        ('open', 'auto', False, False, False),
-        ('open', 'auto', True,  False, False),
         # non-gzip file - have_igzip is irrelevant, decision should be made
         # solely from kfo flag
         ('bin', False,  False, False, False),
         ('bin', False,  True,  False, False),
         ('bin', True,   False, True,  True),
         ('bin', True,   True,  True,  True),
-        ('bin', 'auto', False, False, False),
-        ('bin', 'auto', True,  False, False),
-        # gzip file. If igzip is present, we persist the ImageOpener. If kfo
-        # is 'auto':
-        #  - if igzip is present, kfo -> True
-        #  - otherwise, kfo -> False
+        # gzip file. If igzip is present, we persist the ImageOpener.
         ('gz', False,  False, False, False),
         ('gz', False,  True,  True,  False),
         ('gz', True,   False, True,  True),
         ('gz', True,   True,  True,  True),
-        ('gz', 'auto', False, False, False),
-        ('gz', 'auto', True,  True,  True)]
+        ]
 
     dtype = np.float32
     data  = np.arange(1000, dtype=dtype).reshape((10, 10, 10))
@@ -480,7 +470,7 @@ def test_keep_file_open_true_false_invalid():
         with assert_raises(ValueError):
             ArrayProxy(fname, ((10, 10, 10), dtype), keep_file_open=55)
         with assert_raises(ValueError):
-            ArrayProxy(fname, ((10, 10, 10), dtype), keep_file_open='autob')
+            ArrayProxy(fname, ((10, 10, 10), dtype), keep_file_open='auto')
         with assert_raises(ValueError):
             ArrayProxy(fname, ((10, 10, 10), dtype), keep_file_open='cauto')