Skip to content

Add proper typing @overload to zimscraperlib.image.optimize_xxx methods #273

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
benoit74 merged 1 commit into from
Dec 2, 2025
+41 −0
Merged

Add proper typing @overload to zimscraperlib.image.optimize_xxx methods #273

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Fixed

- Add proper typing @overload to `zimscraperlib.image.optimize_xxx` methods (#273)

## [5.3.0] - 2025-11-14

### Changed
Expand Down
37 changes: 37 additions & 0 deletions src/zimscraperlib/image/optimization.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import pathlib
import subprocess
from dataclasses import dataclass
from typing import overload

import piexif # pyright: ignore[reportMissingTypeStubs]
from optimize_images.img_aux_processing import ( # pyright: ignore[reportMissingTypeStubs]
Expand Down Expand Up @@ -78,6 +79,18 @@ class OptimizePngOptions:
remove_transparency: bool | None = False


@overload
def optimize_png(
src: pathlib.Path | io.BytesIO,
dst: io.BytesIO | None = None,
options: OptimizePngOptions | None = None,
) -> io.BytesIO: ...
@overload
def optimize_png(
src: pathlib.Path | io.BytesIO,
dst: pathlib.Path,
options: OptimizePngOptions | None = None,
) -> pathlib.Path: ...
def optimize_png(
src: pathlib.Path | io.BytesIO,
dst: pathlib.Path | io.BytesIO | None = None,
Expand Down Expand Up @@ -128,6 +141,18 @@ class OptimizeJpgOptions:
keep_exif: bool | None = True


@overload
def optimize_jpeg(
src: pathlib.Path | io.BytesIO,
dst: io.BytesIO | None = None,
options: OptimizeJpgOptions | None = None,
) -> io.BytesIO: ...
@overload
def optimize_jpeg(
src: pathlib.Path | io.BytesIO,
dst: pathlib.Path,
options: OptimizeJpgOptions | None = None,
) -> pathlib.Path: ...
def optimize_jpeg(
src: pathlib.Path | io.BytesIO,
dst: pathlib.Path | io.BytesIO | None = None,
Expand Down Expand Up @@ -218,6 +243,18 @@ class OptimizeWebpOptions:
lossless: bool | None = False


@overload
def optimize_webp(
src: pathlib.Path | io.BytesIO,
dst: io.BytesIO | None = None,
options: OptimizeWebpOptions | None = None,
) -> io.BytesIO: ...
@overload
def optimize_webp(
src: pathlib.Path | io.BytesIO,
dst: pathlib.Path,
options: OptimizeWebpOptions | None = None,
) -> pathlib.Path: ...
def optimize_webp(
src: pathlib.Path | io.BytesIO,
dst: pathlib.Path | io.BytesIO | None = None,
Expand Down