Deprecate skimage.io plugin infrastructure
#7353
Conversation
| use_plugin = ( | ||
| plugin is not DEPRECATED | ||
| or plugin_args | ||
| or plugin_order()["imread"][0] != "imageio" | ||
| ) | ||
| if use_plugin: |
There was a problem hiding this comment.
It's been proven quite tricky to preserve imread and imsave while deprecating the underlying plugin infrastructure. Honestly, I feel like it's not worth the deprecation headache to keep simple wrappers around but for now I've attempted the following approach:
- Deprecate usage of the parameters
pluginandplugin_args.pluginis also a parameter of imageio which we are planning to wrap. So keeping them around while not silently changing the behavior of user code seems impossible without changing the namespace. - If
pluginorplugin_argsare given or "imageiois not the default plugin (e.g.use_plugin("tifffile")` was used before), use the old plugin infra path. Otherwise simply wrap imageio.
There was a problem hiding this comment.
Why not just pop the imageio plugin imread and imwrite into the main module? We do not need to maintain the underlying plugin infrastructure.
There was a problem hiding this comment.
Because we want a deprecation period during which we support both APIs (our old one and imageio), right?
I'm probably overthinking this. Let me look into this again and try for a simpler approach.
|
|
||
|
|
||
| @_deprecate_plugin_function | ||
| def imshow(arr, plugin=None, **plugin_args): |
There was a problem hiding this comment.
imshow and similar don't have to be deprecated. I could try to wrap matplotlib in a similar manner to wrapping imageio in im{save,read}. However, before investing the work, I'll first wait if we decide that it's worth keeping them around...
|
|
||
|
|
||
| if __doc__ is not None: | ||
| __doc__ = _update_doc(__doc__) | ||
| __all__ = [ |
There was a problem hiding this comment.
Probably want to hide items from __all__ that are deprecated.
| use_plugin = ( | ||
| plugin is not DEPRECATED | ||
| or plugin_args | ||
| or plugin_order()["imread"][0] != "imageio" | ||
| ) | ||
| if use_plugin: |
There was a problem hiding this comment.
Why not just pop the imageio plugin imread and imwrite into the main module? We do not need to maintain the underlying plugin infrastructure.
Description
Still very much a work in progress and trying to understand the problem better. See inline comments below.
See also
Checklist
./doc/examplesfor new featuresRelease note
We use changelist to
compile each pull request into an item of the release notes. Please refer to
the instructions
and past release notes
for guidance and examples.