aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/python/ipython/py2/IPython/lib/inputhookwx.py
blob: e054c6d915cf2c5ff0fa2b10204556fb2c004405 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
# encoding: utf-8 
 
""" 
Enable wxPython to be used interacive by setting PyOS_InputHook. 
 
Authors:  Robin Dunn, Brian Granger, Ondrej Certik 
""" 
 
#----------------------------------------------------------------------------- 
#  Copyright (C) 2008-2011  The IPython Development Team 
# 
#  Distributed under the terms of the BSD License.  The full license is in 
#  the file COPYING, distributed as part of this software. 
#----------------------------------------------------------------------------- 
 
#----------------------------------------------------------------------------- 
# Imports 
#----------------------------------------------------------------------------- 
 
import sys 
import signal 
import time 
from timeit import default_timer as clock 
import wx 
 
from IPython.lib.inputhook import stdin_ready 
 
 
#----------------------------------------------------------------------------- 
# Code 
#----------------------------------------------------------------------------- 
 
def inputhook_wx1(): 
    """Run the wx event loop by processing pending events only. 
 
    This approach seems to work, but its performance is not great as it 
    relies on having PyOS_InputHook called regularly. 
    """ 
    try: 
        app = wx.GetApp() 
        if app is not None: 
            assert wx.Thread_IsMain() 
 
            # Make a temporary event loop and process system events until 
            # there are no more waiting, then allow idle events (which 
            # will also deal with pending or posted wx events.) 
            evtloop = wx.EventLoop() 
            ea = wx.EventLoopActivator(evtloop) 
            while evtloop.Pending(): 
                evtloop.Dispatch() 
            app.ProcessIdle() 
            del ea 
    except KeyboardInterrupt: 
        pass 
    return 0 
 
class EventLoopTimer(wx.Timer): 
 
    def __init__(self, func): 
        self.func = func 
        wx.Timer.__init__(self) 
 
    def Notify(self): 
        self.func() 
 
class EventLoopRunner(object): 
 
    def Run(self, time): 
        self.evtloop = wx.EventLoop() 
        self.timer = EventLoopTimer(self.check_stdin) 
        self.timer.Start(time) 
        self.evtloop.Run() 
 
    def check_stdin(self): 
        if stdin_ready(): 
            self.timer.Stop() 
            self.evtloop.Exit() 
 
def inputhook_wx2(): 
    """Run the wx event loop, polling for stdin. 
 
    This version runs the wx eventloop for an undetermined amount of time, 
    during which it periodically checks to see if anything is ready on 
    stdin.  If anything is ready on stdin, the event loop exits. 
 
    The argument to elr.Run controls how often the event loop looks at stdin. 
    This determines the responsiveness at the keyboard.  A setting of 1000 
    enables a user to type at most 1 char per second.  I have found that a 
    setting of 10 gives good keyboard response.  We can shorten it further, 
    but eventually performance would suffer from calling select/kbhit too 
    often. 
    """ 
    try: 
        app = wx.GetApp() 
        if app is not None: 
            assert wx.Thread_IsMain() 
            elr = EventLoopRunner() 
            # As this time is made shorter, keyboard response improves, but idle 
            # CPU load goes up.  10 ms seems like a good compromise. 
            elr.Run(time=10)  # CHANGE time here to control polling interval 
    except KeyboardInterrupt: 
        pass 
    return 0 
 
def inputhook_wx3(): 
    """Run the wx event loop by processing pending events only. 
 
    This is like inputhook_wx1, but it keeps processing pending events 
    until stdin is ready.  After processing all pending events, a call to 
    time.sleep is inserted.  This is needed, otherwise, CPU usage is at 100%. 
    This sleep time should be tuned though for best performance. 
    """ 
    # We need to protect against a user pressing Control-C when IPython is 
    # idle and this is running. We trap KeyboardInterrupt and pass. 
    try: 
        app = wx.GetApp() 
        if app is not None: 
            assert wx.Thread_IsMain() 
 
            # The import of wx on Linux sets the handler for signal.SIGINT 
            # to 0.  This is a bug in wx or gtk.  We fix by just setting it 
            # back to the Python default. 
            if not callable(signal.getsignal(signal.SIGINT)): 
                signal.signal(signal.SIGINT, signal.default_int_handler) 
 
            evtloop = wx.EventLoop() 
            ea = wx.EventLoopActivator(evtloop) 
            t = clock() 
            while not stdin_ready(): 
                while evtloop.Pending(): 
                    t = clock() 
                    evtloop.Dispatch() 
                app.ProcessIdle() 
                # We need to sleep at this point to keep the idle CPU load 
                # low.  However, if sleep to long, GUI response is poor.  As 
                # a compromise, we watch how often GUI events are being processed 
                # and switch between a short and long sleep time.  Here are some 
                # stats useful in helping to tune this. 
                # time    CPU load 
                # 0.001   13% 
                # 0.005   3% 
                # 0.01    1.5% 
                # 0.05    0.5% 
                used_time = clock() - t 
                if used_time > 10.0: 
                    # print 'Sleep for 1 s'  # dbg 
                    time.sleep(1.0) 
                elif used_time > 0.1: 
                    # Few GUI events coming in, so we can sleep longer 
                    # print 'Sleep for 0.05 s'  # dbg 
                    time.sleep(0.05) 
                else: 
                    # Many GUI events coming in, so sleep only very little 
                    time.sleep(0.001) 
            del ea 
    except KeyboardInterrupt: 
        pass 
    return 0 
 
if sys.platform == 'darwin': 
    # On OSX, evtloop.Pending() always returns True, regardless of there being 
    # any events pending. As such we can't use implementations 1 or 3 of the 
    # inputhook as those depend on a pending/dispatch loop. 
    inputhook_wx = inputhook_wx2 
else: 
    # This is our default implementation 
    inputhook_wx = inputhook_wx3