Desktop Notifier v7.0

.github/workflows/lint.yml

@@ -25,7 +25,7 @@ jobs:
         flake8 src tests examples
     - name: isort
       run: |
-        isort src tests examples
+        isort --check --diff src tests examples
 
   mypy:
     runs-on: ${{ matrix.os }}

.gitignore

@@ -51,6 +51,10 @@ venv/
 .installed.cfg
 *.egg
 
+# pytest / coverage
+.coverage
+coverage.xml
+
 # IntelliJ Idea family of suites
 .idea
 *.iml

CHANGES.md

@@ -1,3 +1,34 @@
+# v7.0.0
+
+## Added:
+
+* New `DispatchedNotification` class with the platform native notification identifier
+  and runtime-updated status information about that notification
+* New cross-platform implementation for `timeout`
+* New `on_dispatched` event that is triggered when a notification was sent to the
+  notifications server.
+* New `on_cleared` event that is triggered when a notification is closed without
+  user interaction (e.g. because it expired).
+* Add class-level callbacks to `DesktopNotifierSync` as well
+
+## Changed:
+
+* `send` methods now return `DispatchedNotification` instances.
+* `send` methods now also accept `DispatchedNotification` instances, allowing one to
+  replace existing notifications with updated information; to do so simply create a
+  new `DispatchedNotification` instance with the same `identifier`, but a different
+  `Notification` instance
+* `Notification` now accepts floats as `timeout`
+* `Notification` and `Button` instances can now be initialized with `identifier=None`
+* Interaction callbacks at the `DesktopNotifier` level now truly receive all events
+  the notifications server signals; depending on the platform this might include
+  interactions with notifications of other applications as well
+
+## Fixed:
+
+* Fixed sending notifications with a named sound resource on Linux
+  (given that the notifications server has that capability)
+
 # v6.0.0
 
 ## Added:

README.md

@@ -73,10 +73,7 @@ from desktop_notifier import DesktopNotifier, Urgency, Button, ReplyField, DEFAU
 
 
 async def main() -> None:
-    notifier = DesktopNotifier(
-        app_name="Sample App",
-        notification_limit=10,
-    )
+    notifier = DesktopNotifier(app_name="Sample App")
 
     await notifier.send(
         title="Julius Caesar",
@@ -91,9 +88,12 @@ async def main() -> None:
         reply_field=ReplyField(
             on_replied=lambda text: print("Brutus replied:", text),
         ),
+        on_dispatched=lambda: print("Notification showing"),
+        on_cleared=lambda: print("Notification timed out"),
         on_clicked=lambda: print("Notification clicked"),
         on_dismissed=lambda: print("Notification dismissed"),
         sound=DEFAULT_SOUND,
+        timeout=10,
     )
 
     # Run the event loop forever to respond to user interactions with the notification.

docs/background/platform_support.rst

@@ -29,7 +29,7 @@ Please refer to the platform documentation for more detailed information:
    "sound", "Play a sound with the notification", "✓ [#f2]_", "✓ [#f5]_", "✓"
    "thread", "An identifier to group notifications together", "--", "✓", "✓"
    "attachment", "File attachment, e.g., an image", "✓ [#f2]_ [#f6]_", "✓ [#f6]_", "✓ [#f6]_"
-   "timeout", "Duration in seconds until notification auto-dismissal", "✓", "--", "--"
+   "timeout", "Duration in seconds until notification auto-dismissal", "✓", "✓", "✓"
 
 .. [#f1] App name and icon on macOS and Windows are automatically determined by the
          calling application.

examples/eventloop.py

@@ -27,9 +27,12 @@ async def main() -> None:
             button_title="Send",
             on_replied=lambda text: print("Brutus replied:", text),
         ),
+        on_dispatched=lambda: print("Notification showing"),
+        on_cleared=lambda: print("Notification timed out"),
         on_clicked=lambda: print("Notification clicked"),
         on_dismissed=lambda: print("Notification dismissed"),
         sound=DEFAULT_SOUND,
+        timeout=10,
     )
 
     # Run the event loop forever to respond to user interactions with the notification.

examples/eventloop_handlers.py

@@ -11,6 +11,14 @@
     asyncio.set_event_loop_policy(EventLoopPolicy())
 
 
+def on_dispatched(identifier: str) -> None:
+    print(f"Notification '{identifier}' is showing now")
+
+
+def on_cleared(identifier: str) -> None:
+    print(f"Notification '{identifier}' was cleared without user interaction")
+
+
 def on_clicked(identifier: str) -> None:
     print(f"Notification '{identifier}' was clicked")
 
@@ -29,6 +37,8 @@ def on_replied(identifier: str, reply: str) -> None:
 
 async def main() -> None:
     notifier = DesktopNotifier(app_name="Sample App")
+    notifier.on_dispatched = on_dispatched
+    notifier.on_cleared = on_cleared
     notifier.on_clicked = on_clicked
     notifier.on_dismissed = on_dismissed
     notifier.on_button_pressed = on_button_pressed
@@ -47,6 +57,7 @@ async def main() -> None:
             button_title="Send",
         ),
         sound=DEFAULT_SOUND,
+        timeout=10,
     )
 
     # Run the event loop forever to respond to user interactions with the notification.

examples/synchronous.py

@@ -23,7 +23,10 @@
         button_title="Send",
         on_replied=lambda text: print("Brutus replied:", text),
     ),
+    on_dispatched=lambda: print("Notification showing"),
+    on_cleared=lambda: print("Notification timed out"),
     on_clicked=lambda: print("Notification clicked"),
     on_dismissed=lambda: print("Notification dismissed"),
     sound=DEFAULT_SOUND,
+    timeout=10,
 )

pyproject.toml

@@ -39,8 +39,8 @@ classifiers = [
 ]
 requires-python = ">=3.9"
 dependencies = [
-    "bidict",
     "packaging",
+    "immutabledict",
     "dbus-fast;sys_platform=='linux'",
     "rubicon-objc;sys_platform=='darwin'",
     "winrt-windows.applicationmodel.core;sys_platform=='win32'",
@@ -81,9 +81,7 @@ docs = [
 desktop_notifier = ["**/*.png"]
 
 [tool.flake8]
-ignore = "E203,E501,W503,H306"
-per-file-ignores = """
-__init__.py: F401"""
+ignore = "E501,W503"
 statistics = "True"
 
 [tool.mypy]

src/desktop_notifier/__init__.py

@@ -9,6 +9,7 @@
     Button,
     Capability,
     DesktopNotifier,
+    DispatchedNotification,
     Icon,
     Notification,
     ReplyField,
@@ -37,4 +38,5 @@
     "Capability",
     "DEFAULT_SOUND",
     "DEFAULT_ICON",
+    "DispatchedNotification",
 ]