Print what package should be installed when suitable writer is missing

[ytl0623]

Fixes #7980

Description

To implement these changes:

1. Add the from typing import Dict, List import.
2. Add the WRITER_PACKAGE_MAP dictionary after the existing imports.
3. Replace the existing OptionalImportError class with the new version provided above.

For example, if you try to save a PNG file without Pillow installed, you'll now get an error message like:

# Before
monai.utils.module.OptionalImportError: No ImageWriter backend found for png.

# Now
monai.utils.module.OptionalImportError: No ImageWriter backend found for png. Please install one of the following packages: pillow

Types of changes

• Non-breaking change (fix or new feature that would not break existing functionality).
• Breaking change (fix or new feature that would cause existing functionality to change).
• New tests added to cover the changes.
• Integration tests passed locally by running ./runtests.sh -f -u --net --coverage.
• Quick tests passed locally by running ./runtests.sh --quick --unittests --disttests.
• In-line docstrings updated.
• Documentation updated, tested make html command in the docs/ folder.

[dzenanz]

Who is supposed to add the rest of the entries on this list? ITK supports quite a few, including all of the ones you listed above.

[ericspod]

We can add ITK for a number of these types though the listed libraries are the primary ones used. If you can identify what other libraries load each of these types (and other types that can be loaded) please add them here as well.

[KumoLiu]

Hi @ytl0623, thanks for the pr!

Given that we already have a resolve_writer function to determine the appropriate writer based on the suffix, do you think it would be feasible to extend this function by adding a required_pkg list which can also resolve @dzenanz's concern here.

def resolve_writer():
    ...
    requried_pkg = []
        default_writers = SUPPORTED_WRITERS.get(EXT_WILDCARD, ())
        for _writer in look_up_option(fmt, SUPPORTED_WRITERS, default=default_writers):
            try:
                _writer()  # this triggers `monai.utils.module.require_pkg` to check the system availability
                avail_writers.append(_writer)
            except OptionalImportError as e:
                requried_pkg.append(re.search(r'`(.*?)`', str(e)).group(1))
                continue
            except Exception:  # other writer init errors indicating it exists
                avail_writers.append(_writer)
        if not avail_writers and error_if_not_found:
            raise OptionalImportError(f"No ImageWriter backend found for {fmt}, install one of the required packages in {requried_pkg}.")
    ...

[KumoLiu]

Hi @ytl0623, Do you plan to address the comments on the PR? If not, I’d be happy to assist with it. I’m hoping we can get this merged into version 1.4, but we only have about one or two weeks left to add new features.

[ytl0623]

Hi @KumoLiu, I apologize for the delay in responding. I’m willing to assist it. It might take me a little time, but I’ll make sure to work on it and keep you updated.

[vectorvp]

@KumoLiu, hello, I want to help with merging this PR. How can I do so? Make a new PR with changes you requested?

[KumoLiu]

@KumoLiu, hello, I want to help with merging this PR. How can I do so? Make a new PR with changes you requested?

Sure. @ytl0623, if you’re short on time to make the update, perhaps @vectorvp could assist with it. Thanks!

[vectorvp]

@KumoLiu, do we want to keep modifications in module.py?

[KumoLiu]

resolve_writer

No, we can just extend the existing resolve_writer as well.