Skip to content

Resolving Issue #8 #12

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.

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

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 12 additions & 6 deletions adafruit_display_notification/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# SPDX-FileCopyrightText: 2019 Scott Shawcroft for Adafruit Industries
#

# SPDX-License-Identifier: MIT

"""
Expand All @@ -11,11 +11,15 @@
"""

import displayio

from adafruit_display_text import label

import terminalio

# For older versions, typing may need to be imported
try:
from typing import List, Tuple, Optional, Union
except ImportError:
pass

__version__ = "0.0.0+auto.0"
__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Display_Notification.git"

Expand All @@ -27,7 +31,8 @@
class NotificationFree(displayio.Group):
"""Widget to show when no notifications are active."""

def __init__(self, width, height, *, dark_mode=True):
def __init__(self, width: Union[int, float], height: Union[int, float], *,
dark_mode: Union[bool, int]=True):
# pylint: disable=unused-argument
super().__init__()

Expand All @@ -46,7 +51,8 @@ def __init__(self, width, height, *, dark_mode=True):
class PlainNotification(displayio.Group):
"""Plain text widget with a title and message."""

def __init__(self, title, message, width, height, *, dark_mode=True):
def __init__(self, title: str, message: str, width: Union[int, float], height: Union[int, float],
*, dark_mode: Union[bool, int]=True):
super().__init__()

# Set text, font, and color
Expand All @@ -71,7 +77,7 @@ def __init__(self, title, message, width, height, *, dark_mode=True):

# cribbed from pyportal
@staticmethod
def _wrap_nicely(string, max_chars):
def _wrap_nicely(string: str, max_chars: int) -> List[str]:
"""A helper that will return a list of lines with word-break wrapping.
:param str string: The text to be wrapped.
:param int max_chars: The maximum number of characters on a line before wrapping.
Expand Down
18 changes: 15 additions & 3 deletions adafruit_display_notification/apple.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,26 @@

from . import PlainNotification

try:
from typing import Union
except ImportError:
pass

__version__ = "0.0.0+auto.0"
__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Display_Notification.git"


def create_notification_widget(
notification, max_width, max_height, *, color_count=2**16
):
"""Creates a notification widget for the given Apple notification."""
notification: object, max_width: Union[int, float], max_height: Union[int, float],
*, color_count: int=2**16):
"""
Creates a notification widget for the given Apple notification.
:param notification object: Object with attributes title and message
:param max_width int: Max Width of the notification
:param max_height int: Max Height of the Notication
:param color_count int: Number of colors, default is 2**16

"""
# pylint: disable=unused-argument
return PlainNotification(
notification.title, notification.message, max_width, max_height
Expand Down