added called_on_main decorator

serwy · serwy · commit 78e29f6002ff · 2022-03-20T10:11:47.000-05:00
diff --git a/tests/test_tkthread.py b/tests/test_tkthread.py
@@ -396,5 +396,33 @@ def func():
         self.assertIsNot(d['thread'], t)
 
 
+    def test_called_on_thread(self):
+
+        d = {}
+        main = tkthread._willdispatch._main_thread_
+
+        @tkthread.called_on_main
+        def main_func(*args, **kw):
+            d['args'] = args
+            d['kw'] = kw
+            d['thread'] = threading.current_thread()
+            return 'done'
+
+        t = threading.current_thread()
+        @thread_start()
+        def tstart():
+            r = main_func(1, 2, c=3)
+            d['result'] = r
+
+        while tstart.is_alive():
+            self.root.update()
+
+        self.assertEqual(d['result'], 'done')
+        self.assertIs(d['thread'], main)
+        self.assertEqual(d['args'], (1, 2))
+        self.assertEqual(d['kw'], {'c':3})
+
+
+
 if __name__ == '__main__':
     unittest.main()
diff --git a/tkthread/__init__.py b/tkthread/__init__.py
@@ -102,7 +102,9 @@ def run(func):
     import queue
 
 from ._version import __version__
-from ._willdispatch import tkinstall, main, current, call
+from ._willdispatch import (
+    tkinstall, main, current, call, called_on_main
+    )
 
 __all__ = ['TkThread', 'tk', '__version__',
            'tkinstall', 'main', 'current', 'call']
diff --git a/tkthread/_willdispatch.py b/tkthread/_willdispatch.py
@@ -261,6 +261,7 @@ def _handler(d=d):
         d['outerr'] = (result, error)
 
     main(sync=sync)(_handler)
+
     if sync:
         result, error = d['outerr']
         if error is not None:
@@ -272,3 +273,24 @@ def _handler(d=d):
 def call(func, *args, **kwargs):
     """Call the function on the main thread, wait for result."""
     return _callsync(True, func, args, kwargs)
+
+
+class called_on_main:
+    """Decorator to cause function call to execute on the main thread.
+
+    example:
+
+    @tkthread.called_on_main
+    def gui_code():
+        ...
+
+    gui_code()  # calling will automatically dispatch to main thread
+    """
+    def __init__(self, func):
+        self.func = func
+
+    def __call__(self, *args, **kw):
+        return call(self.func, *args, **kw)
+
+    def __repr__(self):
+        return '<called_on_main %r>' % self.func
