Assets

NoteThe API detects each image’s format from its bytes.

typesafe_sdk.Asset

module-attribute An asset referenced from request content; currently only images are supported.

typesafe_sdk.Image

dataclass An image asset backed by image file bytes, or a path to an image file.

Reusing imagesAn Image is loaded once, on first use, and reused by every request that sends the same Image object.

Working with Buffer objectsImage also accepts Buffer objects: anything exposing its memory through the buffer protocol, such as bytearray, memoryview, mmap, or NumPy arrays. Buffers other than bytes are copied into memory once, on first use, so the original can change or be closed afterwards.

Examples: From a file path:

from pathlib import Path

image = Image(Path("photos/product.png"))

From bytes in memory:

def from_bytes(data: bytes) -> Image:
    return Image(data)

From base64 text, such as an upload:

def from_upload(data_base64: str) -> Image:
    return Image.from_base64(data_base64)

From a Pillow image (requires the pil extra):

import PIL.Image

image = Image.from_pil(PIL.Image.new("RGB", (64, 64)), format="jpeg")

From a slice of a larger buffer, without copying it into bytes first:

def embedded_photo(container: bytes, offset: int, length: int) -> Image:
    return Image(memoryview(container)[offset : offset + length])

From a memory-mapped file:

import mmap


def map_photo(path: Path) -> Image:
    with path.open("rb") as file:
        return Image(mmap.mmap(file.fileno(), 0, access=mmap.ACCESS_READ))

data

instance-attribute Image contents, represented as one of:

raw bytes (anything supporting the Buffer protocol)
path-like object pointing at the image on the filesystem

from_base64

classmethod Create an Image instance from a base64-encoded image bytes. Parameters:

data (str | Buffer) – The image file bytes, base64-encoded, as text or an ASCII buffer. Whitespace, such as the line breaks of wrapped base64, is ignored.

Raises:

TypeSafeError – The data isn’t valid base64 text.

from_pil

classmethod Create an Image instance from a Pillow image.

Encoder settingsThe image is saved with Pillow’s default encoder settings, except that JPEG uses quality 95. JPEG can’t store transparency or palettes, so pass format="png" for RGBA or P mode images. Encode it yourself if different settings are needed.

Parameters:

image (PIL.Image.Image) – The Pillow image to encode.
format (str, default: 'jpeg' ) – The image format to save as, by its Pillow name.

Raises:

TypeSafeError – Pillow can’t encode the image in this format.

Reference

Client SDKs

typesafe_sdk.Asset

typesafe_sdk.Image

data

from_base64

from_pil

​typesafe_sdk.Asset

​typesafe_sdk.Image

​data

​from_base64

​from_pil

typesafe_sdk.Asset

typesafe_sdk.Image

data

from_base64

from_pil