Skip to content

Commit 94f317a

Browse files
Improve missing image writer dependency hints
Signed-off-by: NiketGirdhar22 <[email protected]>
1 parent fd12fdc commit 94f317a

4 files changed

Lines changed: 62 additions & 5 deletions

File tree

‎monai/data/image_writer.py‎

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,9 @@
6363

6464
SUPPORTED_WRITERS: dict = {}
6565

66+
# Map import names to their corresponding Python distribution names where they differ.
67+
_PACKAGE_INSTALL_NAMES = {"PIL": "pillow"}
68+
6669

6770
def register_writer(ext_name, *im_writers):
6871
"""
@@ -99,24 +102,39 @@ def resolve_writer(ext_name, error_if_not_found=True) -> Sequence:
99102
As an indexing key it will be converted to a lower case string.
100103
error_if_not_found: whether to raise an error if no suitable image writer is found.
101104
if True , raise an ``OptionalImportError``, otherwise return an empty tuple. Default is ``True``.
105+
106+
Raises:
107+
OptionalImportError: When no registered writer is available. If candidate writers require missing optional
108+
dependencies, the error includes commands for installing them.
102109
"""
103110
if not SUPPORTED_WRITERS:
104111
init()
105112
fmt = f"{ext_name}".lower()
106113
if fmt.startswith("."):
107114
fmt = fmt[1:]
108115
avail_writers = []
116+
missing_packages: set[str] = set()
109117
default_writers = SUPPORTED_WRITERS.get(EXT_WILDCARD, ())
110118
for _writer in look_up_option(fmt, SUPPORTED_WRITERS, default=default_writers):
111119
try:
112120
_writer() # this triggers `monai.utils.module.require_pkg` to check the system availability
113121
avail_writers.append(_writer)
114-
except OptionalImportError:
122+
except OptionalImportError as error:
123+
if error.name:
124+
missing_packages.add(_PACKAGE_INSTALL_NAMES.get(error.name, error.name))
115125
continue
116126
except Exception: # other writer init errors indicating it exists
117127
avail_writers.append(_writer)
118128
if not avail_writers and error_if_not_found:
119-
raise OptionalImportError(f"No ImageWriter backend found for {fmt}.")
129+
message = f"No ImageWriter backend found for {fmt}."
130+
packages = sorted(missing_packages)
131+
if len(packages) == 1:
132+
package = packages[0]
133+
message += f" Install `{package}` with `pip install {package}`."
134+
elif packages:
135+
hints = ", ".join(f"`{package}` (`pip install {package}`)" for package in packages)
136+
message += f" Install one of the following packages: {hints}."
137+
raise OptionalImportError(message)
120138
writer_tuple = ensure_tuple(avail_writers)
121139
SUPPORTED_WRITERS[fmt] = writer_tuple
122140
return writer_tuple

‎monai/utils/module.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -476,7 +476,7 @@ def _wrapper(*args, **kwargs):
476476
if not has:
477477
err_msg = f"required package `{pkg_name}` is not installed or the version doesn't match requirement."
478478
if raise_error:
479-
raise OptionalImportError(err_msg)
479+
raise OptionalImportError(err_msg, name=pkg_name)
480480
else:
481481
warnings.warn(err_msg)
482482

‎tests/data/test_image_rw.py‎

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,21 @@
1616
import shutil
1717
import tempfile
1818
import unittest
19+
from unittest.mock import patch
1920

2021
import numpy as np
2122
import torch
2223
from parameterized import parameterized
2324

2425
from monai.data.image_reader import ITKReader, NibabelReader, NrrdReader, PILReader
25-
from monai.data.image_writer import ITKWriter, NibabelWriter, PILWriter, register_writer, resolve_writer
26+
from monai.data.image_writer import (
27+
SUPPORTED_WRITERS,
28+
ITKWriter,
29+
NibabelWriter,
30+
PILWriter,
31+
register_writer,
32+
resolve_writer,
33+
)
2634
from monai.data.meta_tensor import MetaTensor
2735
from monai.transforms import LoadImage, SaveImage, moveaxis
2836
from monai.utils import MetaKeys, OptionalImportError, optional_import
@@ -150,6 +158,36 @@ def test_1_new(self):
150158
register_writer("new2", lambda x: x + 1)
151159
self.assertEqual(resolve_writer("new")[0](0), 1)
152160

161+
def test_missing_writer_install_hint(self):
162+
def missing_pillow():
163+
raise OptionalImportError("PIL is unavailable", name="PIL")
164+
165+
with patch.dict(SUPPORTED_WRITERS, {"png": (missing_pillow,)}, clear=True):
166+
with self.assertRaisesRegex(OptionalImportError, r"Install `pillow` with `pip install pillow`"):
167+
resolve_writer(".PNG")
168+
169+
def test_multiple_missing_writer_install_hints(self):
170+
def missing_itk():
171+
raise OptionalImportError("ITK is unavailable", name="itk")
172+
173+
def missing_nibabel():
174+
raise OptionalImportError("Nibabel is unavailable", name="nibabel")
175+
176+
with patch.dict(SUPPORTED_WRITERS, {"nii": (missing_nibabel, missing_itk)}, clear=True):
177+
with self.assertRaises(OptionalImportError) as context:
178+
resolve_writer("nii")
179+
self.assertIn("Install one of the following packages", str(context.exception))
180+
self.assertIn("`itk` (`pip install itk`)", str(context.exception))
181+
self.assertIn("`nibabel` (`pip install nibabel`)", str(context.exception))
182+
183+
def test_missing_writer_without_package_name(self):
184+
def missing_unknown():
185+
raise OptionalImportError("Unknown dependency")
186+
187+
with patch.dict(SUPPORTED_WRITERS, {"unknown": (missing_unknown,)}, clear=True):
188+
with self.assertRaisesRegex(OptionalImportError, r"^No ImageWriter backend found for unknown\.$"):
189+
resolve_writer("unknown")
190+
153191

154192
@unittest.skipUnless(has_itk, "itk not installed")
155193
class TestLoadSaveNrrd(unittest.TestCase):

‎tests/utils/test_require_pkg.py‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,13 +43,14 @@ def test_func(x):
4343
test_func(x=None)
4444

4545
def test_class_exception(self):
46-
with self.assertRaises(OptionalImportError):
46+
with self.assertRaises(OptionalImportError) as context:
4747

4848
@require_pkg(pkg_name="test123")
4949
class TestClass:
5050
pass
5151

5252
TestClass()
53+
self.assertEqual(context.exception.name, "test123")
5354

5455
def test_class_version_exception(self):
5556
with self.assertRaises(OptionalImportError):

0 commit comments

Comments
 (0)