Skip to content

Latest commit

 

History

161 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

imagesize

PyPI version Supported Python versions License

This module analyzes JPEG/JPEG 2000/PNG/GIF/TIFF/SVG/Netpbm/WebP/BMP/AVIF/HEIC/HEIF image headers and returns image size, DPI, and related metadata.

import imagesize

width, height = imagesize.get("test.png")
print(width, height)

xdpi, ydpi = imagesize.getDPI("test.png")
print(xdpi, ydpi)

info = imagesize.get_info("test.png")
print(info.width, info.height, info.rotation, info.xdpi, info.ydpi, info.colors, info.channels)

This module is a pure Python module. You can use file like object like file or something like io.BytesIO.

Supported Python versions: 3.10-3.15

Installation

pip install imagesize

For local development setup:

python -m venv .venv
source .venv/bin/activate
pip install -e .

Version 2.0 migration notes

Version 2.0 includes the following updates:

  • Added/expanded support for BMP.
  • Added support for AVIF.
  • Added support for HEIC/HEIF.
  • imagesize.get_info() now returns richer metadata including color depth, channel count, and rotation information.
  • Improved EXIF orientation handling so JPEG, TIFF, AVIF, and HEIC/HEIF return sizes that correctly reflect EXIF rotation metadata.
  • Added type hints for the public API and related input/output types.

Backward incompatible behavior in 2.0:

  • imagesize.get() now returns (-1, -1) when parsing fails.
  • imagesize.getDPI() now returns (-1, -1) when parsing fails.

If your existing code relied on exceptions during parse failures, update it to explicitly check return values.

API

  • imagesize.get(filepath: FileInput, *, exif_rotation: bool = True) -> tuple[int, int]

    Returns image size as (width, height). By default, orientation metadata is applied for rotated JPEG/TIFF/AVIF/HEIF images; pass exif_rotation=False to get the stored size as-is. On parsing errors it returns (-1, -1).

  • imagesize.getDPI(filepath: FileInput) -> tuple[int, int]

    Returns image DPI as (xdpi, ydpi). On parsing errors it returns (-1, -1).

  • imagesize.get_info(filepath: FileInput, *, size: bool = True, dpi: bool = True, colors: bool = True, exif_rotation: bool = True, channels: bool = True) -> ImageInfo

    Returns an ImageInfo named tuple with width, height, rotation, xdpi, ydpi, colors and channels fields. rotation contains orientation metadata (e.g. EXIF Orientation tag, or -1 when unavailable).

HTTP and HTTPS URLs are accepted as input. The library uses HTTP byte-range requests automatically so that pixel data does not need to be downloaded. If a server does not support range requests, it transparently falls back to one full download for compatibility. The first request is limited to 8 KiB; later random access expands cached regions in 64 KiB blocks only when more metadata is needed.

Benchmark

Only headers and the metadata needed for the requested result are read. Pixel payloads are skipped with seek() locally and HTTP Range requests remotely. Run the included benchmark with:

python bench.py --number 10000

The report includes elapsed time and the number of bytes read for PNG, JPEG, TIFF, GIF, JPEG2000, AVIF, and HEIF. It also simulates an 8 MiB remote AVIF and reports the number of Range requests and transferred bytes.

Development

Run test with the following command:

python -m unittest

License

MIT License

Thanks

I referred to the following code:

I use sample image from here:

Thank you for feedback:

About

No description, website, or topics provided.

Resources

Stars

253 stars

Watchers

7 watching

Forks

Releases

Packages

Used by

Contributors

Languages