MIN Add deprecation error if FreeImage is used

luispedro · May 2, 2024 · ae25704 · ae25704
1 parent 558a39b
commit ae25704
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/ChangeLog b/ChangeLog
@@ -1,3 +1,6 @@
+Unreleased
+	* io: Add deprecated warning for freeimage
+
 Version 1.4.15 2024-04-17 by luispedro
 	* Update build system (thanks to @Czaki, see #147)
 

diff --git a/mahotas/io/__init__.py b/mahotas/io/__init__.py
@@ -62,6 +62,11 @@ def error_imsave(*args, **kwargs):
             from .pil import imread, imsave
         except ImportError:
             from .freeimage import imread, imsave
+            from os import environ
+            if 'MAHOTAS_NO_FREEIMAGE_DEPRECATION' not in environ:
+                import warnings
+                warnings.warn('mahotas.freeimage is deprecated. Please install the `imread` package')
+                warnings.warn('To suppress this warning, set the environment variable MAHOTAS_NO_FREEIMAGE_DEPRECATION')
 # Importing freeimage can throw both ImportError and OSError, so check for both
 except (OSError, ImportError): # pragma: no cover
     import sys