quickmacapp 2023.2.21__tar.gz → 2023.4.24__tar.gz

{quickmacapp-2023.2.21 → quickmacapp-2023.4.24}/LICENSE

@@ -1,7 +1,8 @@
 MIT License
 
-Copyright (c) 2023 Palo Alto Networks
-Portions Copyright (c) 2021 Glyph
+Copyright
+(c) 2023 Glyph
+(c) 2023 Palo Alto Networks
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{quickmacapp-2023.2.21 → quickmacapp-2023.4.24}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: quickmacapp
-Version: 2023.2.21
+Version: 2023.4.24
 Summary: Make it easier to write Mac apps in Python
 Description-Content-Type: text/x-rst
 License-File: LICENSE
@@ -15,19 +15,22 @@ QuickMacApp
     rapidly and if you want to use this to ship an app you probably will want
     to contribute to it as well.
 
-Make it easier to write small applications for macOS (that use Twisted).
+Make it easier to write small applications for macOS in Python, using Twisted.
 
 To get a very basic status menu API:
 
 .. code::
    python
 
-    from quickmacapp import mainpoint, Status, quit
+    from quickmacapp import mainpoint, Status, answer, quit
+    from twisted.internet.defer import Deferred
 
     @mainpoint()
-    def app(reactor: IReactorTime):
-        Status("☀️ 💣").menu([("Do Something", lambda: print("something")),
-                             ("Quit", quit)])
+    def app(reactor):
+        s = Status("☀️ 💣")
+        s.menu([("Do Something", lambda: Deferred.fromCoroutine(answer("something"))),
+                ("Quit", quit)])
+    app.runMain()
 
 Packaging this into a working app bundle is currently left as an exercise for
 the reader.

{quickmacapp-2023.2.21 → quickmacapp-2023.4.24}/README.rst

@@ -8,19 +8,22 @@ QuickMacApp
     rapidly and if you want to use this to ship an app you probably will want
     to contribute to it as well.
 
-Make it easier to write small applications for macOS (that use Twisted).
+Make it easier to write small applications for macOS in Python, using Twisted.
 
 To get a very basic status menu API:
 
 .. code::
    python
 
-    from quickmacapp import mainpoint, Status, quit
+    from quickmacapp import mainpoint, Status, answer, quit
+    from twisted.internet.defer import Deferred
 
     @mainpoint()
-    def app(reactor: IReactorTime):
-        Status("☀️ 💣").menu([("Do Something", lambda: print("something")),
-                             ("Quit", quit)])
+    def app(reactor):
+        s = Status("☀️ 💣")
+        s.menu([("Do Something", lambda: Deferred.fromCoroutine(answer("something"))),
+                ("Quit", quit)])
+    app.runMain()
 
 Packaging this into a working app bundle is currently left as an exercise for
 the reader.

{quickmacapp-2023.2.21 → quickmacapp-2023.4.24}/pyproject.toml

@@ -9,7 +9,7 @@ build-backend = "setuptools.build_meta"
 name = "quickmacapp"
 description = "Make it easier to write Mac apps in Python"
 readme = "README.rst"
-version = "2023.02.21"
+version = "2023.04.24"
 dependencies = [
     "pyobjc-framework-Cocoa",
     "pyobjc-framework-ExceptionHandling",

{quickmacapp-2023.2.21 → quickmacapp-2023.4.24}/src/quickmacapp/__init__.py

@@ -1,4 +1,5 @@
 from ._quickapp import Actionable, Status, mainpoint, menu, quit
+from ._interactions import ask, choose, answer
 
 __all__ = [
     "Actionable",
@@ -6,4 +7,7 @@ __all__ = [
     "mainpoint",
     "menu",
     "quit",
+    "ask",
+    "choose",
+    "answer",
 ]

quickmacapp-2023.4.24/src/quickmacapp/_interactions.py

@@ -0,0 +1,107 @@
+from typing import Iterable, Iterator, TypeVar
+
+from AppKit import (
+    NSAlertFirstButtonReturn,
+    NSAlertSecondButtonReturn,
+    NSAlertThirdButtonReturn,
+    NSAlert,
+    NSApp,
+)
+from Foundation import (
+    NSRunLoop,
+    NSTextField,
+    NSRect,
+)
+from twisted.internet.defer import Deferred
+
+
+NSModalResponse = int
+T = TypeVar("T")
+
+
+def asyncModal(alert: NSAlert) -> Deferred[NSModalResponse]:
+    """
+    Run an NSAlert asynchronously.
+    """
+    d: Deferred[NSModalResponse] = Deferred()
+
+    def runAndReport() -> None:
+        try:
+            NSApp().activateIgnoringOtherApps_(True)
+            result = alert.runModal()
+        except:
+            d.errback()
+        else:
+            d.callback(result)
+
+    NSRunLoop.currentRunLoop().performBlock_(runAndReport)
+    return d
+
+
+def _alertReturns() -> Iterator[NSModalResponse]:
+    """
+    Enumerate the values used by NSAlert for return values in the order of the
+    buttons that occur.
+    """
+    yield NSAlertFirstButtonReturn
+    yield NSAlertSecondButtonReturn
+    yield NSAlertThirdButtonReturn
+    i = 1
+    while True:
+        yield NSAlertThirdButtonReturn + i
+        i += 1
+
+
+async def choose(values: Iterable[tuple[T, str]], question: str, description: str="") -> T:
+    """
+    Prompt the user to choose between the given values, on buttons labeled in
+    the given way.
+    """
+    msg = NSAlert.alloc().init()
+    msg.setMessageText_(question)
+    msg.setInformativeText_(description)
+    potentialResults = {}
+    for (value, label), alertReturn in zip(values, _alertReturns()):
+        msg.addButtonWithTitle_(label)
+        potentialResults[alertReturn] = value
+    msg.layout()
+    return potentialResults[await asyncModal(msg)]
+
+
+async def ask(question: str, description: str="", defaultValue: str="") -> str | None:
+    """
+    Prompt the user for a short string of text.
+    """
+    msg = NSAlert.alloc().init()
+    msg.addButtonWithTitle_("OK")
+    msg.addButtonWithTitle_("Cancel")
+    msg.setMessageText_(question)
+    msg.setInformativeText_(description)
+
+    txt = NSTextField.alloc().initWithFrame_(NSRect((0, 0), (200, 100)))
+    txt.setMaximumNumberOfLines_(5)
+    txt.setStringValue_(defaultValue)
+    msg.setAccessoryView_(txt)
+    msg.window().setInitialFirstResponder_(txt)
+    msg.layout()
+
+    response: NSModalResponse = await asyncModal(msg)
+
+    if response == NSAlertFirstButtonReturn:
+        result: str = txt.stringValue()
+        return result
+
+    return None
+
+
+async def answer(message: str, description: str="") -> None:
+    """
+    Give the user a message.
+    """
+    msg = NSAlert.alloc().init()
+    msg.setMessageText_(message)
+    msg.setInformativeText_(description)
+    # msg.addButtonWithTitle("OK")
+    msg.layout()
+
+    await asyncModal(msg)

{quickmacapp-2023.2.21 → quickmacapp-2023.4.24}/src/quickmacapp/_quickapp.py

@@ -5,7 +5,7 @@ import sys
 import traceback
 from typing import Callable, Protocol, Any
 
-from objc import ivar, IBAction
+from objc import ivar, IBAction, super
 
 from Foundation import (
     NSObject,

{quickmacapp-2023.2.21 → quickmacapp-2023.4.24}/src/quickmacapp.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: quickmacapp
-Version: 2023.2.21
+Version: 2023.4.24
 Summary: Make it easier to write Mac apps in Python
 Description-Content-Type: text/x-rst
 License-File: LICENSE
@@ -15,19 +15,22 @@ QuickMacApp
     rapidly and if you want to use this to ship an app you probably will want
     to contribute to it as well.
 
-Make it easier to write small applications for macOS (that use Twisted).
+Make it easier to write small applications for macOS in Python, using Twisted.
 
 To get a very basic status menu API:
 
 .. code::
    python
 
-    from quickmacapp import mainpoint, Status, quit
+    from quickmacapp import mainpoint, Status, answer, quit
+    from twisted.internet.defer import Deferred
 
     @mainpoint()
-    def app(reactor: IReactorTime):
-        Status("☀️ 💣").menu([("Do Something", lambda: print("something")),
-                             ("Quit", quit)])
+    def app(reactor):
+        s = Status("☀️ 💣")
+        s.menu([("Do Something", lambda: Deferred.fromCoroutine(answer("something"))),
+                ("Quit", quit)])
+    app.runMain()
 
 Packaging this into a working app bundle is currently left as an exercise for
 the reader.

{quickmacapp-2023.2.21 → quickmacapp-2023.4.24}/src/quickmacapp.egg-info/SOURCES.txt

@@ -2,6 +2,7 @@ LICENSE
 README.rst
 pyproject.toml
 src/quickmacapp/__init__.py
+src/quickmacapp/_interactions.py
 src/quickmacapp/_quickapp.py
 src/quickmacapp/py.typed
 src/quickmacapp.egg-info/PKG-INFO