Skip to content

imageio 2.37.3

Version history | Download JSON

  • PyPI https://pypi.org/project/imageio/
    Repository https://github.com/imageio/imageio

  • py.typed

  • Coverage

    %%{init: {"pie": {"textPosition": 0.85}, "theme": "neutral", "themeVariables": {"pieStrokeWidth": "1px"}}}%%
pie title
    "Typed" : 428
    "Any" : 2
    "Untyped" : 623
    • 40.8% coverage
    • 40.6% coverage (strict)
    • 1053 typable
      • 428 typed
      • 623 untyped
      • 2 Any

  • Typables

    %%{init: {"pie": {"textPosition": 0.85}, "theme": "neutral", "themeVariables": {"pieStrokeWidth": "1px"}}}%%
pie title
    "functions" : 174
    "classes" : 818
    "other" : 22
    • 56 functions (+13 overloads)
      • 118 parameters
    • 97 classes
      • 352 methods (+0 overloads)
        • 442 parameters
      • 23 properties
    • 41 modules
      • 22 attrs

Modules

Module Coverage Coverage (strict) Typables Ignores
imageio 0.0% 0.0% 5 0
imageio.config.extensions 100.0% 100.0% 16 0
imageio.config.plugins 100.0% 94.4% 18 0
imageio.core.fetching 0.0% 0.0% 5 0
imageio.core.findlib 0.0% 0.0% 10 0
imageio.core.format 95.8% 95.8% 71 0
imageio.core.imopen 77.8% 77.8% 9 0
imageio.core.legacy_plugin_wrapper 79.2% 79.2% 24 0
imageio.core.request 97.6% 95.2% 42 0
imageio.core.util 0.0% 0.0% 67 0
imageio.core.v3_plugin_api 85.0% 85.0% 20 0
imageio.freeze 0.0% 0.0% 2 0
imageio.plugins 0.0% 0.0% 1 0
imageio.plugins.bsdf 0.0% 0.0% 29 0
imageio.plugins.dicom 0.0% 0.0% 20 0
imageio.plugins.example 0.0% 0.0% 22 0
imageio.plugins.feisem 0.0% 0.0% 8 0
imageio.plugins.ffmpeg 0.0% 0.0% 62 0
imageio.plugins.fits 0.0% 0.0% 14 0
imageio.plugins.freeimage 0.0% 0.0% 27 0
imageio.plugins.freeimagemulti 0.0% 0.0% 23 0
imageio.plugins.gdal 0.0% 0.0% 12 0
imageio.plugins.grab 0.0% 0.0% 18 0
imageio.plugins.lytro 0.0% 0.0% 31 0
imageio.plugins.npz 0.0% 0.0% 18 0
imageio.plugins.opencv 90.9% 90.9% 22 0
imageio.plugins.pillow 75.0% 75.0% 40 1
imageio.plugins.pillow_info 0.0% 0.0% 1 0
imageio.plugins.pillow_legacy 2.3% 2.3% 44 0
imageio.plugins.pillowmulti 0.0% 0.0% 57 0
imageio.plugins.pyav 89.7% 89.7% 58 0
imageio.plugins.rawpy 92.9% 92.9% 14 0
imageio.plugins.simpleitk 0.0% 0.0% 22 0
imageio.plugins.spe 87.5% 87.5% 48 0
imageio.plugins.swf 0.0% 0.0% 32 0
imageio.plugins.tifffile 0.0% 0.0% 24 0
imageio.plugins.tifffile_v3 70.8% 70.8% 24 0
imageio.testing 0.0% 0.0% 4 0
imageio.typing 100.0% 100.0% 1 0
imageio.v2 76.4% 76.4% 55 0
imageio.v3 78.8% 78.8% 33 0

Incomplete Annotations

imageio (5 missing, 0 any)

Symbol Typable Typed Any
func imread 4 0 0
attr formats 1 0 0

imageio.config.plugins (0 missing, 1 any)

Symbol Typable Typed Any
prop PluginConfig.format 1 1 1

imageio.core.fetching (5 missing, 0 any)

Symbol Typable Typed Any
func get_remote_file 5 0 0

imageio.core.findlib (10 missing, 0 any)

Symbol Typable Typed Any
func generate_candidate_libs 3 0 0
attr LOCALDIR 1 0 0
func looks_lib 2 0 0
func load_lib 4 0 0

imageio.core.format (3 missing, 0 any)

Symbol Typable Typed Any
meth Reader.get_data 3 2 0
meth Reader.get_next_data 2 1 0
meth Reader.set_image_index 3 2 0

imageio.core.imopen (2 missing, 0 any)

Symbol Typable Typed Any
func imopen 9 7 0

imageio.core.legacy_plugin_wrapper (5 missing, 0 any)

Symbol Typable Typed Any
meth LegacyPlugin.legacy_get_reader 2 1 0
meth LegacyPlugin.read 3 2 0
meth LegacyPlugin.legacy_get_writer 2 1 0
meth LegacyPlugin.write 4 3 0
meth LegacyPlugin.iter 2 1 0

imageio.core.request (1 missing, 1 any)

Symbol Typable Typed Any
meth Mode.missing 2 2 1
meth Request.init 6 5 0

imageio.core.util (67 missing, 0 any)

Symbol Typable Typed Any
meth BaseProgressIndicator.init 2 0 0
meth BaseProgressIndicator.start 4 0 0
meth BaseProgressIndicator.status 1 0 0
meth BaseProgressIndicator.set_progress 3 0 0
meth BaseProgressIndicator.increase_progress 2 0 0
meth BaseProgressIndicator.finish 2 0 0
meth BaseProgressIndicator.fail 2 0 0
meth BaseProgressIndicator.write 2 0 0
meth BaseProgressIndicator._start 1 0 0
meth BaseProgressIndicator._stop 1 0 0
meth BaseProgressIndicator._update_progress 2 0 0
meth BaseProgressIndicator._write 2 0 0
meth Array.new 3 0 0
meth Array._copy_meta 2 0 0
meth Array.array_finalize 2 0 0
meth Array.array_wrap 3 0 0
prop Array.meta 1 0 0
meth StdoutProgressIndicator._start 1 0 0
meth StdoutProgressIndicator._update_progress 2 0 0
meth StdoutProgressIndicator._stop 1 0 0
meth StdoutProgressIndicator._write 2 0 0
meth Dict.getattribute 2 0 0
meth Dict.setattr 3 0 0
meth Dict.dir 1 0 0
attr Dict.reserved_names 1 0 0
attr Dict.pure_names 1 0 0
func get_platform 1 0 0
func resource_package_dir 1 0 0
func image_as_uint 3 0 0
func appdata_dir 3 0 0
func asarray 2 0 0
func has_module 2 0 0
attr THIS_DIR 1 0 0
attr logger 1 0 0
func resource_dirs 1 0 0
func urlopen 3 0 0

imageio.core.v3_plugin_api (3 missing, 0 any)

Symbol Typable Typed Any
meth PluginV3.exit 4 1 0

imageio.freeze (2 missing, 0 any)

Symbol Typable Typed Any
func get_excludes 1 0 0
func get_includes 1 0 0

imageio.plugins (1 missing, 0 any)

Symbol Typable Typed Any
attr env_plugin_order 1 0 0

imageio.plugins.bsdf (29 missing, 0 any)

Symbol Typable Typed Any
func get_bsdf_serializer 2 0 0
meth Writer._open 2 0 0
meth Writer._close 1 0 0
meth Writer._append_data 3 0 0
meth Writer.set_meta_data 2 0 0
meth Reader._open 2 0 0
meth Reader._close 1 0 0
meth Reader._get_length 1 0 0
meth Reader._get_data 2 0 0
meth Reader._get_meta_data 2 0 0
meth BsdfFormat._can_read 2 0 0
meth BsdfFormat._can_write 2 0 0
meth Image.init 3 0 0
meth Image.get_array 1 0 0
meth Image.get_meta 1 0 0
attr Image.array 1 0 0
attr Image.meta 1 0 0

imageio.plugins.dicom (20 missing, 0 any)

Symbol Typable Typed Any
attr logger 1 0 0
meth DicomFormat._can_read 2 0 0
meth DicomFormat._can_write 2 0 0
func get_gdcmconv_exe 1 0 0
meth Reader._open 2 0 0
meth Reader._close 1 0 0
meth Reader._get_length 1 0 0
meth Reader._get_slice_data 2 0 0
meth Reader._get_data 2 0 0
meth Reader._get_meta_data 2 0 0
prop Reader.series 1 0 0
attr Reader._compressed_warning_dirs 1 0 0
func load_lib 1 0 0
func get_dcmdjpeg_exe 1 0 0

imageio.plugins.example (22 missing, 0 any)

Symbol Typable Typed Any
meth Writer._open 2 0 0
meth Writer._close 1 0 0
meth Writer._append_data 3 0 0
meth Writer.set_meta_data 2 0 0
meth DummyFormat._can_read 2 0 0
meth DummyFormat._can_write 2 0 0
meth Reader._open 3 0 0
meth Reader._close 1 0 0
meth Reader._get_length 1 0 0
meth Reader._get_data 2 0 0
meth Reader._get_meta_data 2 0 0
attr format 1 0 0

imageio.plugins.feisem (8 missing, 0 any)

Symbol Typable Typed Any
meth Reader._get_data 4 0 0
meth Reader._get_meta_data 2 0 0
meth FEISEMFormat._can_write 2 0 0

imageio.plugins.ffmpeg (62 missing, 0 any)

Symbol Typable Typed Any
func parse_device_names 2 0 0
meth FrameCatcher.init 2 0 0
meth FrameCatcher.stop_me 1 0 0
meth FrameCatcher.get_frame 1 0 0
meth FrameCatcher.run 1 0 0
attr FrameCatcher.daemon 1 0 0
meth FfmpegFormat._can_read 2 0 0
meth FfmpegFormat._can_write 2 0 0
meth Writer._open 13 0 0
meth Writer._close 1 0 0
meth Writer._append_data 3 0 0
meth Writer.set_meta_data 2 0 0
meth Writer._initialize 1 0 0
func download 3 0 0
meth Reader._get_cam_inputname 2 0 0
meth Reader._open 10 0 0
meth Reader._close 1 0 0
meth Reader.count_frames 1 0 0
meth Reader._get_length 1 0 0
meth Reader._get_data 2 0 0
meth Reader._get_meta_data 2 0 0
meth Reader._initialize 2 0 0
meth Reader._skip_frames 2 0 0
meth Reader._read_frame 1 0 0
func get_exe 1 0 0
func get_version 1 0 0
attr logger 1 0 0

imageio.plugins.fits (14 missing, 0 any)

Symbol Typable Typed Any
func load_lib 1 0 0
meth Reader._open 3 0 0
meth Reader._close 1 0 0
meth Reader._get_length 1 0 0
meth Reader._get_data 2 0 0
meth Reader._get_meta_data 2 0 0
meth FitsFormat._can_read 2 0 0
meth FitsFormat._can_write 2 0 0

imageio.plugins.freeimage (27 missing, 0 any)

Symbol Typable Typed Any
meth FreeimageFormat.init 6 0 0
meth FreeimageFormat._can_read 2 0 0
meth FreeimageFormat._can_write 2 0 0
prop FreeimageFormat.fif 1 0 0
meth Writer._open 2 0 0
meth Writer._close 1 0 0
meth Writer._append_data 3 0 0
meth Writer._set_meta_data 2 0 0
meth Reader._get_length 1 0 0
meth Reader._open 2 0 0
meth Reader._close 1 0 0
meth Reader._get_data 2 0 0
meth Reader._get_meta_data 2 0 0

imageio.plugins.freeimagemulti (23 missing, 0 any)

Symbol Typable Typed Any
meth MngFormat._can_write 2 0 0
meth Writer._open 2 0 0
meth Writer._close 1 0 0
meth Writer._append_data 3 0 0
meth Writer._append_bitmap 4 0 0
meth Writer._set_meta_data 2 0 0
meth Reader._open 2 0 0
meth Reader._close 1 0 0
meth Reader._get_length 1 0 0
meth Reader._get_data 2 0 0
meth Reader._get_meta_data 2 0 0
attr logger 1 0 0

imageio.plugins.gdal (12 missing, 0 any)

Symbol Typable Typed Any
func load_lib 1 0 0
meth Reader._open 1 0 0
meth Reader._close 1 0 0
meth Reader._get_length 1 0 0
meth Reader._get_data 2 0 0
meth Reader._get_meta_data 2 0 0
meth GdalFormat._can_read 2 0 0
meth GdalFormat._can_write 2 0 0

imageio.plugins.grab (18 missing, 0 any)

Symbol Typable Typed Any
meth ClipboardGrabFormat._can_read 2 0 0
meth ClipboardGrabFormat._get_data 2 0 0
meth BaseGrabFormat.init 3 0 0
meth BaseGrabFormat._can_write 2 0 0
meth BaseGrabFormat._init_pillow 1 0 0
meth Reader._open 1 0 0
meth Reader._close 1 0 0
meth Reader._get_data 2 0 0
meth ScreenGrabFormat._can_read 2 0 0
meth ScreenGrabFormat._get_data 2 0 0

imageio.plugins.lytro (31 missing, 0 any)

Symbol Typable Typed Any
meth LytroFormat._can_write 2 0 0
attr logger 1 0 0
meth Writer._open 2 0 0
meth Writer._close 1 0 0
meth Writer._append_data 3 0 0
meth Writer._set_meta_data 2 0 0
meth Reader._open 2 0 0
meth Reader._close 1 0 0
meth Reader._get_length 1 0 0
meth Reader._get_data 2 0 0
meth Reader._get_meta_data 2 0 0
meth LytroF01RawFormat._can_read 2 0 0
meth LytroF01RawFormat.rearrange_bits 2 0 0
meth LytroIllumRawFormat._can_read 2 0 0
meth LytroIllumRawFormat.rearrange_bits 2 0 0
meth LytroLfpFormat._can_read 2 0 0
meth LytroLfrFormat._can_read 2 0 0

imageio.plugins.npz (18 missing, 0 any)

Symbol Typable Typed Any
meth Writer._open 1 0 0
meth Writer._close 1 0 0
meth Writer._append_data 3 0 0
meth Writer.set_meta_data 2 0 0
meth Reader._open 1 0 0
meth Reader._close 1 0 0
meth Reader._get_length 1 0 0
meth Reader._get_data 2 0 0
meth Reader._get_meta_data 2 0 0
meth NpzFormat._can_read 2 0 0
meth NpzFormat._can_write 2 0 0

imageio.plugins.opencv (2 missing, 0 any)

Symbol Typable Typed Any
attr OpenCVPlugin.file_handle 1 0 0
attr OpenCVPlugin.filename 1 0 0

imageio.plugins.pillow (10 missing, 0 any)

Symbol Typable Typed Any
meth PillowPlugin._apply_transforms 6 1 0
meth PillowPlugin.write 6 5 0
meth PillowPlugin._flush_writer 1 0 0
meth PillowPlugin.get_meta 2 1 0
attr PillowPlugin.images_to_write 1 0 0
attr PillowPlugin.save_args 1 0 0

imageio.plugins.pillow_info (1 missing, 0 any)

Symbol Typable Typed Any
func generate_info 1 0 0

imageio.plugins.pillow_legacy (43 missing, 0 any)

Symbol Typable Typed Any
meth Writer._open 1 0 0
meth Writer._close 1 0 0
meth Writer._append_data 3 0 0
meth Writer.set_meta_data 2 0 0
func pil_try_read 2 0 0
meth Reader._open 3 0 0
meth Reader._get_file 1 0 0
meth Reader._close 1 0 0
meth Reader._get_length 1 0 0
meth Reader._seek 2 0 0
meth Reader._get_data 2 0 0
meth Reader._get_meta_data 2 0 0
func ndarray_to_pil 4 0 0
meth PillowFormat.init 4 1 0
meth PillowFormat._init_pillow 1 0 0
meth PillowFormat._can_read 2 0 0
meth PillowFormat._can_write 2 0 0
prop PillowFormat.plugin_id 1 0 0
func save_pillow_close 2 0 0
attr logger 1 0 0
func pil_get_frame 6 0 0

imageio.plugins.pillowmulti (57 missing, 0 any)

Symbol Typable Typed Any
func intToBin 2 0 0
meth Writer._open 7 0 0
meth Writer._close 1 0 0
meth Writer._append_data 3 0 0
attr logger 1 0 0
meth GifWriter.init 6 0 0
meth GifWriter.add_image 4 0 0
meth GifWriter.write_header 4 0 0
meth GifWriter.close 1 0 0
meth GifWriter.write_image 6 0 0
meth GifWriter.getheaderAnim 2 0 0
meth GifWriter.getImageDescriptor 3 0 0
meth GifWriter.getAppExt 2 0 0
meth GifWriter.getGraphicsControlExt 3 0 0
meth GifWriter.getSubRectangle 2 0 0
meth GifWriter.converToPIL 4 0 0
attr GifWriter.fp 1 0 0
attr GifWriter.opt_subrectangle 1 0 0
attr GifWriter.opt_loop 1 0 0
attr GifWriter.opt_quantizer 1 0 0
attr GifWriter.opt_palette_size 1 0 0
attr GifWriter.getdata 1 0 0

imageio.plugins.pyav (6 missing, 0 any)

Symbol Typable Typed Any
meth PyAVPlugin.init 4 3 0
meth PyAVPlugin._seek 3 2 0
meth PyAVPlugin._flush_writer 1 0 0
prop PyAVPlugin.container_metadata 1 0 0
prop PyAVPlugin.video_stream_metadata 1 0 0
attr PyAVPlugin.frames_written 1 0 0

imageio.plugins.rawpy (1 missing, 0 any)

Symbol Typable Typed Any
meth RawPyPlugin.read 3 2 0

imageio.plugins.simpleitk (22 missing, 0 any)

Symbol Typable Typed Any
meth ItkFormat._can_read 2 0 0
meth ItkFormat._can_write 2 0 0
meth Writer._open 1 0 0
meth Writer._close 1 0 0
meth Writer._append_data 3 0 0
meth Writer.set_meta_data 2 0 0
meth Reader._open 4 0 0
meth Reader._get_length 1 0 0
meth Reader._close 1 0 0
meth Reader._get_data 2 0 0
meth Reader._get_meta_data 2 0 0
func load_lib 1 0 0

imageio.plugins.spe (6 missing, 0 any)

Symbol Typable Typed Any
meth CommentDesc.init 5 4 0
meth SDTControlSpec.extract_metadata 3 2 0
attr SDTControlSpec.comment_fields 1 0 0
attr Spec.metadata 1 0 0
attr Spec.dtypes 1 0 0
attr logger 1 0 0

imageio.plugins.swf (32 missing, 0 any)

Symbol Typable Typed Any
meth Writer._open 5 0 0
meth Writer._close 1 0 0
meth Writer._write_header 3 0 0
meth Writer._complete 1 0 0
meth Writer._append_data 3 0 0
meth Writer.set_meta_data 2 0 0
meth Reader._open 2 0 0
meth Reader._fp_read 2 0 0
meth Reader._close 1 0 0
meth Reader._get_length 1 0 0
meth Reader._get_data 2 0 0
meth Reader._read_one_tag 1 0 0
meth Reader._get_meta_data 2 0 0
func load_lib 1 0 0
attr logger 1 0 0
meth SWFFormat._can_read 2 0 0
meth SWFFormat._can_write 2 0 0

imageio.plugins.tifffile (24 missing, 0 any)

Symbol Typable Typed Any
meth TiffFormat._can_read 2 0 0
meth TiffFormat._can_write 2 0 0
meth Writer._open 4 0 0
meth Writer._close 1 0 0
meth Writer._append_data 3 0 0
meth Writer._sanitize_meta 2 0 0
meth Writer.set_meta_data 2 0 0
meth Reader._open 2 0 0
meth Reader._close 1 0 0
meth Reader._get_length 1 0 0
meth Reader._get_data 2 0 0
meth Reader._get_meta_data 2 0 0

imageio.plugins.tifffile_v3 (7 missing, 0 any)

Symbol Typable Typed Any
meth TifffilePlugin.init 3 2 0
meth TifffilePlugin.read 4 3 0
meth TifffilePlugin.iter 2 1 0
meth TifffilePlugin.write 4 3 0
meth TifffilePlugin.iter_pages 3 0 0

imageio.testing (4 missing, 0 any)

Symbol Typable Typed Any
func test_unit 2 0 0
attr ROOT_DIR 1 0 0
attr THIS_DIR 1 0 0

imageio.v2 (13 missing, 0 any)

Symbol Typable Typed Any
func mimwrite 5 4 0
func mvolwrite 5 4 0
func get_writer 5 4 0
func help 2 1 0
func mimread 5 3 0
func volwrite 5 4 0
func get_reader 5 4 0
func mvolread 5 4 0
func imwrite 5 4 0
func volread 4 3 0
func imread 4 3 0
func to_nbytes 3 2 0

imageio.v3 (7 missing, 0 any)

Symbol Typable Typed Any
func imiter 6 5 0
func imread 7 6 0
func imwrite 7 6 0
func improps 6 4 0
func immeta 7 5 0

Type-Ignore Comments

Flavor Count
type: ignore 1