Class Image

src/pptx/parts/image.py:142–275

Immutable value object representing an image such as a JPEG, PNG, or GIF.

class Image(object):
    """Immutable value object representing an image such as a JPEG, PNG, or GIF."""

    def __init__(self, blob: bytes, filename: str | None):
        super(Image, self).__init__()
        self._blob = blob
        self._filename = filename

    @classmethod
    def from_blob(cls, blob: bytes, filename: str | None = None) -> Image:
        """Return a new |Image| object loaded from the image binary in `blob`."""
        return cls(blob, filename)

    @classmethod
    def from_file(cls, image_file: str | IO[bytes]) -> Image:
        """Return a new |Image| object loaded from `image_file`.

        `image_file` can be either a path (str) or a file-like object.
        """
        if isinstance(image_file, str):
            # treat image_file as a path
            with open(image_file, "rb") as f:
                blob = f.read()
            filename = os.path.basename(image_file)
        else:
            # assume image_file is a file-like object
            # ---reposition file cursor if it has one---
            if callable(getattr(image_file, "seek")):
                image_file.seek(0)
            blob = image_file.read()
            filename = None

        return cls.from_blob(blob, filename)

    @property
    def blob(self) -> bytes:
        """The binary image bytestream of this image."""
        return self._blob

    @lazyproperty
    def content_type(self) -> str:
        """MIME-type of this image, e.g. `"image/jpeg"`."""
        return image_content_types[self.ext]

    @lazyproperty
    def dpi(self) -> tuple[int, int]:
        """A (horz_dpi, vert_dpi) 2-tuple specifying the dots-per-inch resolution of this image.

        A default value of (72, 72) is used if the dpi is not specified in the image file.
        """

        def int_dpi(dpi: Any):
            """Return an integer dots-per-inch value corresponding to `dpi`.

            If `dpi` is |None|, a non-numeric type, less than 1 or greater than 2048, 72 is
            returned.
            """
            try: