Merge pull request beeware#737 from beeware/phildini-background-task

Add a background task interface for Toga

src/android/toga_android/app.py

@@ -62,3 +62,6 @@ def exit(self):
 
     def set_on_exit(self, value):
         pass
+
+    def add_background_task(self, handler):
+        self.interface.factory.not_implemented('App.add_background_task()')

src/cocoa/toga_cocoa/app.py

@@ -4,15 +4,15 @@
 from urllib.parse import unquote, urlparse
 
 import toga
-from rubicon.objc import objc_method, NSMutableArray, NSMutableDictionary, NSObject, SEL
-from rubicon.objc.eventloop import EventLoopPolicy, CocoaLifecycle
+from rubicon.objc import (SEL, NSMutableArray, NSMutableDictionary, NSObject,
+                          objc_method)
+from rubicon.objc.eventloop import CocoaLifecycle, EventLoopPolicy
+from toga.handlers import wrapped_handler
 
 from .keys import cocoa_key
-from .libs import (
-    NSURL, NSBundle, NSOpenPanel, NSDocumentController, NSString, NSApplication,
-    NSApplicationActivationPolicyRegular, NSNumber, NSMenu, NSMenuItem, NSScreen,
-    NSCursor
-)
+from .libs import (NSURL, NSApplication, NSApplicationActivationPolicyRegular,
+                   NSBundle, NSCursor, NSDocumentController, NSMenu,
+                   NSMenuItem, NSNumber, NSOpenPanel, NSScreen, NSString)
 from .window import Window
 
 
@@ -223,6 +223,9 @@ def hide_cursor(self):
 
         self._cursor_visible = False
 
+    def add_background_task(self, handler):
+        self.loop.call_soon(wrapped_handler(self, handler), self)
+
 
 class DocumentApp(App):
     def _create_app_commands(self):

src/core/toga/app.py

@@ -211,6 +211,9 @@ def on_exit(self, handler):
         self._on_exit = wrapped_handler(self, handler)
         self._impl.set_on_exit(self._on_exit)
 
+    def add_background_task(self, handler):
+        self._impl.add_background_task(handler)
+
 
 class DocumentApp(App):
     """
@@ -222,6 +225,7 @@ class DocumentApp(App):
         document_types (:obj:`list` of :obj:`str`): Document types.
 
     """
+
     def __init__(self, name, app_id,
                  id=None, icon=None, startup=None, document_types=None, on_exit=None, factory=None):
 

src/django/toga_django/app.py

@@ -22,7 +22,6 @@ def on_close(self, widget, data):
 class App(AppInterface):
     _MAIN_WINDOW_CLASS = MainWindow
 
-
     def __init__(self, interface):
         self.interface = interface
         self.interface._impl = self
@@ -138,3 +137,6 @@ def home(self, request):
             }
         }
         return render(request, 'toga/app.html', context)
+
+    def add_background_task(self, handler):
+        self.interface.factory.not_implemented('App.add_background_task()')

src/dummy/toga_dummy/app.py

@@ -1,4 +1,4 @@
-from .utils import not_required_on, LoggedObject
+from .utils import LoggedObject, not_required_on
 from .window import Window
 
 
@@ -49,6 +49,9 @@ def show_cursor(self):
     def hide_cursor(self):
         self._action('hide_cursor')
 
+    def add_background_task(self, handler):
+        self._action('add_background_task', handler=handler)
+
 
 @not_required_on('mobile', 'web')
 class DocumentApp(App):

src/gtk/toga_gtk/app.py

@@ -1,18 +1,17 @@
 import asyncio
-import signal
-import sys
 import os
 import os.path
+import signal
+import sys
 from urllib.parse import unquote, urlparse
 
 import gbulb
-
 import toga
 from toga import Icon
 from toga.command import GROUP_BREAK, SECTION_BREAK, Command
 
 from .keys import gtk_accel
-from .libs import Gtk, Gio, GLib
+from .libs import Gio, GLib, Gtk
 from .window import Window
 
 
@@ -199,6 +198,9 @@ def show_cursor(self):
     def hide_cursor(self):
         self.interface.factory.not_implemented('App.hide_cursor()')
 
+    def add_background_task(self, handler):
+        self.interface.factory.not_implemented('App.add_background_task()')
+
 
 class DocumentApp(App):
     def _create_app_commands(self):

src/iOS/toga_iOS/app.py

@@ -2,16 +2,11 @@
 
 from rubicon.objc import objc_method
 from rubicon.objc.eventloop import EventLoopPolicy, iOSLifecycle
+from toga.handlers import wrapped_handler
 
-from .libs import (
-    NSNotificationCenter,
-    SEL,
-    UIKeyboardFrameEndUserInfoKey,
-    UIKeyboardWillHideNotification,
-    UIKeyboardWillShowNotification,
-    UIResponder
-)
-
+from .libs import (SEL, NSNotificationCenter, UIKeyboardFrameEndUserInfoKey,
+                   UIKeyboardWillHideNotification,
+                   UIKeyboardWillShowNotification, UIResponder)
 from .window import Window
 
 
@@ -120,3 +115,6 @@ def exit(self):
 
     def set_on_exit(self, value):
         pass
+
+    def add_background_task(self, handler):
+        self.loop.call_soon(wrapped_handler(self, handler), self)

src/win32/toga_win32/app.py

@@ -1,4 +1,5 @@
-from .libs import *
+from .libs import (MSG, NULL, WA_INACTIVE, WM_ACTIVATE, WM_SETFOCUS, ctypes,
+                   user32)
 from .window import Window
 
 
@@ -46,3 +47,6 @@ def on_set_focus(self, msg, old_focus, wParam):
     def on_activate(self, msg, state, lParam):
         if state == WA_INACTIVE:
             self.last_focus = user32.GetFocus()
+
+    def add_background_task(self, handler):
+        self.interface.factory.not_implemented('App.add_background_task()')

src/winforms/toga_winforms/app.py

@@ -154,6 +154,9 @@ def show_cursor(self):
     def hide_cursor(self):
         self.interface.factory.not_implemented('App.hide_cursor()')
 
+    def add_background_task(self, handler):
+        self.interface.factory.not_implemented('App.add_background_task()')
+
 
 class DocumentApp(App):
     def _create_app_commands(self):