Various ad hoc image related utility functions and classes. If you're using the SIXEL support (images in the terminal) I recommand also installing libsixel.

Short summary:

• sixel: Return the filesystem path of a cached SIXEL version of the image at imagepath.

• sixel_from_image_bytes: Return the filesystem path of a cached SIXEL version of the image data in image_bs.

• ThumbnailCache: A class to manage a collection of thumbnail images.

Functions

sixel(imagepath: str) -> str

Return the filesystem path of a cached SIXEL version of the image at imagepath.

sixel_from_image_bytes(image_bs: bytes) -> str

Return the filesystem path of a cached SIXEL version of the image data in image_bs.

Classes

class ThumbnailCache(cs.cache.ConvCache)

A class to manage a collection of thumbnail images.

ThumbnailCache.DEFAULT_CACHE_BASEPATH

'~/var/cache/im/thumbnails'

ThumbnailCache.DEFAULT_MIN_SIZE

16

ThumbnailCache.DEFAULT_SCALE_STEP

2.0

ThumbnailCache.create_thumbnail(self, imagepath: str, thumbpath: str, max_edge: int)

Write a thumbnail image no larger than max_edgexmax_edge of imagepath to thumbpath.

ThumbnailCache.thumb_for_path(self, dx, dy, imagepath)

Return the path to the thumbnail of at least (dx,dy) size for imagepath. Creates the thumbnail if necessary.

Parameters:

• dx, dy: the target display size for the thumbnail.
• image: the source image, an image file pathname or a PIL Image instance.

The generated thumbnail will have at least these dimensions unless either exceeds the size of the source image. In that case the original source image will be returned; this result can be recognised with an identity check.

Thumbnail paths are named after the SHA1 digest of their file content.

ThumbnailCache.thumb_scale(self, dx, dy)

Compute thumbnail size from target dimensions.