Skip to main content
  • Home
  • Development
  • Documentation
  • Donate
  • Operational login
  • Browse the archive

swh logo
SoftwareHeritage
Software
Heritage
Archive
Features
  • Search

  • Downloads

  • Save code now

  • Add forge now

  • Help

  • ec325a8
  • /
  • byceps
  • /
  • util
  • /
  • image
  • /
  • thumbnail.py
Raw File Download

To reference or cite the objects present in the Software Heritage archive, permalinks based on SoftWare Hash IDentifiers (SWHIDs) must be used.
Select below a type of object currently browsed in order to display its associated SWHID and permalink.

  • content
  • directory
content badge
swh:1:cnt:0e8dd0554b21c7c2b70aa17abc921a6728c7271f
directory badge
swh:1:dir:01e24b3029b5a3da1a0baba5cb47691131055a54

This interface enables to generate software citations, provided that the root directory of browsed objects contains a citation.cff or codemeta.json file.
Select below a type of object currently browsed in order to generate citations for them.

  • content
  • directory
(requires biblatex-software package)
Generating citation ...
(requires biblatex-software package)
Generating citation ...
thumbnail.py
"""
byceps.util.image.thumbnail
~~~~~~~~~~~~~~~~~~~~~~~~~~~

:Copyright: 2014-2025 Jochen Kupperschmidt
:License: Revised BSD (see `LICENSE` file for details)
"""

from io import BytesIO
from typing import BinaryIO

from PIL import Image, ImageFile

from .dimensions import Dimensions


FilenameOrStream = str | BinaryIO


def create_thumbnail(
    filename_or_stream: FilenameOrStream,
    image_type: str,
    maximum_dimensions: Dimensions,
    *,
    force_square: bool = False,
) -> BinaryIO:
    """Create a thumbnail from the given image and return the result stream."""
    output_stream = BytesIO()

    image = Image.open(filename_or_stream)

    if force_square:
        image = _crop_to_square(image)

    image.thumbnail(maximum_dimensions, resample=Image.Resampling.LANCZOS)

    image.save(output_stream, format=image_type)

    output_stream.seek(0)
    return output_stream


def _crop_to_square(image: ImageFile) -> ImageFile:
    """Crop image to be square."""
    dimensions = Dimensions(*image.size)

    if dimensions.is_square:
        return image

    edge_length = min(*dimensions)
    crop_box = (0, 0, edge_length, edge_length)

    return image.crop(crop_box)

back to top

Software Heritage — Copyright (C) 2015–2026, The Software Heritage developers. License: GNU AGPLv3+.
The source code of Software Heritage itself is available on our development forge.
The source code files archived by Software Heritage are available under their own copyright and licenses.
Terms of use: Archive access, API— Content policy— Contact— JavaScript license information— Web API