Skip to content

Colorconvert in docstring #90

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
merged 2 commits into from
Nov 7, 2024
Merged

Colorconvert in docstring #90

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7936be3
show ColorConverter in type annotation
FoamyGuy Nov 7, 2024
04bdc7d
show ColorConverter in docstring
FoamyGuy Nov 7, 2024
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: 2 additions & 2 deletions adafruit_imageload/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
Union,
)

from displayio import Bitmap, Palette
from displayio import Bitmap, ColorConverter, Palette

from .displayio_types import BitmapConstructor, PaletteConstructor
except ImportError:
Expand All @@ -39,7 +39,7 @@ def load(
*,
bitmap: Optional[BitmapConstructor] = None,
palette: Optional[PaletteConstructor] = None,
) -> Tuple[Bitmap, Optional[Palette]]:
) -> Tuple[Bitmap, Optional[Union[Palette, ColorConverter]]]:
"""Load pixel values (indices or colors) into a bitmap and colors into a palette.

bitmap is the desired type. It must take width, height and color_depth in the constructor. It
Expand Down
9 changes: 5 additions & 4 deletions adafruit_imageload/bmp/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@

try:
from io import BufferedReader
from typing import List, Optional, Set, Tuple
from typing import List, Optional, Set, Tuple, Union

from displayio import Bitmap, Palette
from displayio import Bitmap, ColorConverter, Palette

from ..displayio_types import BitmapConstructor, PaletteConstructor
except ImportError:
Expand All @@ -32,10 +32,11 @@ def load(
*,
bitmap: Optional[BitmapConstructor] = None,
palette: Optional[PaletteConstructor] = None,
) -> Tuple[Optional[Bitmap], Optional[Palette]]:
) -> Tuple[Optional[Bitmap], Optional[Union[Palette, ColorConverter]]]:
"""Loads a bmp image from the open ``file``.

Returns tuple of bitmap object and palette object.
Returns tuple of `displayio.Bitmap` object and
`displayio.Palette` object, or `displayio.ColorConverter` object.

:param io.BufferedReader file: Open file handle or compatible (like `io.BytesIO`)
with the data of a BMP file.
Expand Down