Moved to different Rep
This commit is contained in:
MikeTheWatchGuy
parent
eba5b6da79
commit
ecf30c3351
|
|
@ -1,46 +0,0 @@
|
|||
import PySimpleGUI as sg
|
||||
import imwatchingyou # STEP 1
|
||||
|
||||
"""
|
||||
Demo program that shows you how to integrate the PySimpleGUI Debugger
|
||||
into your program.
|
||||
In this example, the debugger is not started initiallly. You click the "Debug" button to launch it
|
||||
There are THREE steps, and they are copy and pastes.
|
||||
1. At the top of your app to debug add
|
||||
import imwatchingyou
|
||||
2. Initialize the debugger at the start of your program by calling:
|
||||
imwatchingyou.initialize()
|
||||
3. At the top of your app's Event Loop add:
|
||||
imwatchingyou.refresh(locals(), globals())
|
||||
"""
|
||||
|
||||
layout = [
|
||||
[sg.T('A typical PSG application')],
|
||||
[sg.In(key='_IN_')],
|
||||
[sg.T(' ', key='_OUT_')],
|
||||
[sg.Radio('a',1, key='_R1_'), sg.Radio('b',1, key='_R2_'), sg.Radio('c',1, key='_R3_')],
|
||||
[sg.Combo(['c1', 'c2', 'c3'], size=(6,3), key='_COMBO_')],
|
||||
[sg.Output(size=(50,6))],
|
||||
[sg.Ok(), sg.Exit(), sg.B('Debug')],
|
||||
]
|
||||
|
||||
window = sg.Window('This is your Application Window', layout)
|
||||
|
||||
counter = 0
|
||||
timeout = 100
|
||||
debug_started = False
|
||||
|
||||
while True: # Your Event Loop
|
||||
if debug_started:
|
||||
debug_started = imwatchingyou.refresh(locals(), globals()) # STEP 3 - refresh debugger
|
||||
event, values = window.Read(timeout=timeout)
|
||||
if event in (None, 'Exit'):
|
||||
break
|
||||
elif event == 'Ok':
|
||||
print('You clicked Ok.... this is where print output goes')
|
||||
elif event == 'Debug' and not debug_started:
|
||||
imwatchingyou.initialize() # STEP 2
|
||||
debug_started = True
|
||||
counter += 1
|
||||
window.Element('_OUT_').Update(values['_IN_'])
|
||||
window.Close()
|
||||
|
|
@ -1,171 +0,0 @@
|
|||
import PySimpleGUI as sg
|
||||
import textwrap
|
||||
|
||||
|
||||
"""
|
||||
The Offiicial Unofficiall official PySimpleGUI debug tool
|
||||
Not calling it a debugger, but it is also quite a step up from "print statemements"
|
||||
"""
|
||||
PSGDebugLogo = b'R0lGODlhMgAtAPcAAAAAADD/2akK/4yz0pSxyZWyy5u3zZ24zpW30pG52J250J+60aC60KS90aDC3a3E163F2K3F2bPI2bvO3rzP3qvJ4LHN4rnR5P/zuf/zuv/0vP/0vsDS38XZ6cnb6f/xw//zwv/yxf/1w//zyP/1yf/2zP/3z//30wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH5BAEAAP8ALAAAAAAyAC0AAAj/AP8JHEiwoMGDCBMqXMiwoUOFAiJGXBigYoAPDxlK3CigwUGLIAOEyIiQI8cCBUOqJFnQpEkGA1XKZPlPgkuXBATK3JmRws2bB3TuXNmQw8+jQoeCbHj0qIGkSgNobNoUqlKIVJs++BfV4oiEWalaHVpyosCwJidw7Sr1YMQFBDn+y4qSbUW3AiDElXiWqoK1bPEKGLixr1jAXQ9GuGn4sN22Bl02roo4Kla+c8OOJbsQM9rNPJlORlr5asbPpTk/RP2YJGu7rjWnDm2RIQLZrSt3zgp6ZmqwmkHAng3ccWDEMe8Kpnw8JEHlkXnPdh6SxHPILaU/dp60LFUP07dfRq5aYntohAO0m+c+nvT6pVMPZ3jv8AJu8xktyNbw+ATJDtKFBx9NlA20gWU0DVQBYwZhsJMICRrkwEYJJGRCSBtEqGGCAQEAOw=='
|
||||
|
||||
COLOR_SCHEME = 'LightGreen'
|
||||
|
||||
WIDTH_VARIABLES = 12
|
||||
WIDTH_RESULTS = 36
|
||||
|
||||
WIDTH_LOCALS = 80
|
||||
|
||||
# done purely for testing / show
|
||||
def func(x=''):
|
||||
return 'return value from func()={}'.format(x)
|
||||
|
||||
|
||||
def _non_user_init():
|
||||
global watcher_window
|
||||
sg.ChangeLookAndFeel(COLOR_SCHEME)
|
||||
def InVar(key1, key2):
|
||||
row1 = [sg.T(' '),
|
||||
sg.I(key=key1, size=(WIDTH_VARIABLES,1)),
|
||||
sg.T('',key=key1+'CHANGED_', size=(WIDTH_RESULTS,1)),sg.B('Detail', key=key1+'DETAIL_'),sg.B('Obj', key=key1+'OBJ_'), sg.T(' '),
|
||||
sg.T(' '), sg.I(key=key2, size=(WIDTH_VARIABLES, 1)), sg.T('',key=key2 + 'CHANGED_', size=(WIDTH_RESULTS, 1)), sg.B('Detail', key=key2+'DETAIL_'),sg.B('Obj', key=key2+'OBJ_')]
|
||||
return row1
|
||||
|
||||
variables_frame = [ InVar('_VAR1_', '_VAR2_'),
|
||||
InVar('_VAR3_', '_VAR4_'),
|
||||
InVar('_VAR5_', '_VAR6_'),]
|
||||
|
||||
interactive_frame = [[sg.T('>>> '), sg.In(size=(83,1), key='_INTERACTIVE_'), sg.B('Go', bind_return_key=True, visible=False)],
|
||||
[sg.Multiline(size=(88,12),key='_OUTPUT_',autoscroll=True, do_not_clear=True)],]
|
||||
|
||||
layout = [ [sg.Frame('Variables or Expressions to Watch', variables_frame, )],
|
||||
[sg.Frame('REPL-Light', interactive_frame,)],
|
||||
[sg.Button('All Local Variables',key='_LOCALS_'), sg.Button('Exit')]]
|
||||
|
||||
window = sg.Window('PySimpleGUI Debugger', layout, icon=PSGDebugLogo).Finalize()
|
||||
window.Element('_VAR1_').SetFocus()
|
||||
watcher_window = window
|
||||
sg.ChangeLookAndFeel('SystemDefault')
|
||||
return window
|
||||
|
||||
def _event_once(mylocals, myglobals):
|
||||
global myrc, watcher_window, locals_window
|
||||
if not watcher_window:
|
||||
return False
|
||||
if locals_window:
|
||||
_locals_window_event_loop(mylocals)
|
||||
# _window = watcher_window
|
||||
event, values = watcher_window.Read(timeout=1)
|
||||
if event in (None, 'Exit'):
|
||||
watcher_window.Close()
|
||||
watcher_window = None
|
||||
return False
|
||||
cmd = values['_INTERACTIVE_']
|
||||
|
||||
if event == 'Go':
|
||||
watcher_window.Element('_INTERACTIVE_').Update('')
|
||||
watcher_window.Element('_OUTPUT_').Update(">>> {}\n".format(cmd), append=True, autoscroll=True)
|
||||
expression = """
|
||||
global myrc
|
||||
imwatchingyou.imwatchingyou.myrc = {} """.format(cmd)
|
||||
try:
|
||||
exec(expression, myglobals, mylocals)
|
||||
watcher_window.Element('_OUTPUT_').Update('{}\n'.format(myrc),append=True, autoscroll=True)
|
||||
|
||||
except Exception as e:
|
||||
watcher_window.Element('_OUTPUT_').Update('Exception {}\n'.format(e),append=True, autoscroll=True)
|
||||
|
||||
elif event.endswith('_DETAIL_'):
|
||||
expression = """
|
||||
global myrc
|
||||
imwatchingyou.imwatchingyou.myrc = {} """.format(values['_VAR{}_'.format(event[4])])
|
||||
try:
|
||||
exec(expression, myglobals, mylocals)
|
||||
sg.PopupScrolled(str(values['_VAR{}_'.format(event[4])]) + '\n' + str(myrc))
|
||||
except:
|
||||
print('Detail failed')
|
||||
elif event.endswith('_OBJ_'):
|
||||
var = values['_VAR{}_'.format(event[4])]
|
||||
expression = """
|
||||
global myrc
|
||||
imwatchingyou.imwatchingyou.myrc = {} """.format(var)
|
||||
try:
|
||||
exec(expression, myglobals, mylocals)
|
||||
sg.PopupScrolled(sg.ObjToStringSingleObj(myrc))
|
||||
except:
|
||||
print('Detail failed')
|
||||
elif event == '_LOCALS_' and locals_window is None:
|
||||
locals_window = _locals_window_initialize(mylocals)
|
||||
|
||||
# -------------------- Process the "watch list" ------------------
|
||||
for i in range(1, 7):
|
||||
key = '_VAR{}_'.format(i)
|
||||
out_key = '_VAR{}_CHANGED_'.format(i)
|
||||
myrc =''
|
||||
if watcher_window.Element(key):
|
||||
if values[key]:
|
||||
expression = """
|
||||
global myrc
|
||||
imwatchingyou.imwatchingyou.myrc = {} """.format(values[key])
|
||||
try:
|
||||
exec(expression, myglobals, mylocals)
|
||||
except Exception as e:
|
||||
pass
|
||||
watcher_window.Element(out_key).Update(myrc)
|
||||
else:
|
||||
watcher_window.Element(out_key).Update('')
|
||||
return True
|
||||
|
||||
|
||||
def _locals_window_event_loop(my_locals):
|
||||
global locals_window
|
||||
|
||||
output_text = ''
|
||||
for key in my_locals:
|
||||
value = "{} : {}".format(key, str(my_locals[key]))
|
||||
wrapped = '\n'.join(textwrap.wrap(value,WIDTH_LOCALS))
|
||||
output_text += '\n' + wrapped
|
||||
|
||||
locals_window.Element('_MULTI_').Update(output_text)
|
||||
|
||||
event, values = locals_window.Read(timeout=1)
|
||||
|
||||
if event in (None, 'Exit'):
|
||||
locals_window.Close()
|
||||
locals_window = None
|
||||
|
||||
|
||||
def _locals_window_initialize(my_locals):
|
||||
sg.ChangeLookAndFeel(COLOR_SCHEME)
|
||||
|
||||
output_text = ''
|
||||
num_lines = 1
|
||||
for key in my_locals:
|
||||
value = "{} : {}".format(key, str(my_locals[key]))
|
||||
num_lines += len(textwrap.wrap(value, WIDTH_LOCALS))
|
||||
wrapped = '\n'.join(textwrap.wrap(value,WIDTH_LOCALS))
|
||||
output_text += wrapped
|
||||
|
||||
layout = [[sg.Multiline(output_text, key='_MULTI_', size=(WIDTH_LOCALS, num_lines))],
|
||||
[sg.Exit()]]
|
||||
|
||||
window = sg.Window('All Locals', layout, icon=PSGDebugLogo).Finalize()
|
||||
sg.ChangeLookAndFeel('SystemDefault')
|
||||
|
||||
return window
|
||||
|
||||
def refresh(locals, globals):
|
||||
return _event_once(locals, globals)
|
||||
|
||||
def initialize():
|
||||
global watcher_window
|
||||
watcher_window = _non_user_init()
|
||||
|
||||
myrc = ''
|
||||
locals_window = watcher_window = None
|
||||
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
initialize()
|
||||
while True:
|
||||
refresh(locals(), globals())
|
||||
|
|
@ -1,197 +0,0 @@
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# imwatchingyou
|
||||
|
||||
A "debugger" that's based on PySimpleGUI. It was developed to help debug PySimpleGUI based programs, but it can be used to debug any program. The only requirement is that a `refresh()` function be called on a "periodic basis".
|
||||
|
||||
What you can do with this "debugger" is:
|
||||
* Set "watch points" that update in realtime
|
||||
* Write expressions / code that update in realtime
|
||||
* Use a REPL style prompt to type in "code" / modify variables
|
||||
|
||||
All of this is done using a window secondary and separate from your primary application window.
|
||||
|
||||
Check out this video as a guide. The user's window is the smaller one one top. The PySimpleGUIdebugger is the green window on the buttom. You can watch variables, evaluate expressions, even execute code.
|
||||
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
Installation is via pip:
|
||||
|
||||
`pip install imwatchingyou`
|
||||
|
||||
or if you need to upgrade later:
|
||||
|
||||
`pip install --upgrade --no-cache-dir imwatchingyou`
|
||||
|
||||
|
||||
Note that you need to install the debugger using pip rather than downloading. There are some detailed technical reasons for this.
|
||||
|
||||
So, don't forget: __You must pip install imwatchingyou in order to use it.__
|
||||
|
||||
|
||||
|
||||
## Integrating imwatchingyou Into Your Application
|
||||
|
||||
There are 3 lines of code to add to a program in order to make it debugger ready - The import, an initialization, a refresh function called periodically.
|
||||
|
||||
Copy and paste these lines of code into your code just as you see them written. Don't get clever and rename anything. Don't do an "import as". Just copy the lines of code.
|
||||
|
||||
Here is an entire program including this integration code:
|
||||
|
||||
```python
|
||||
import PySimpleGUI as sg
|
||||
import imwatchingyou
|
||||
"""
|
||||
Demo program that shows you how to integrate the PySimpleGUI Debugger
|
||||
into your program.
|
||||
There are THREE steps, and they are copy and pastes.
|
||||
1. At the top of your app to debug add
|
||||
import imwatchingyou
|
||||
2. Initialize the debugger by calling:
|
||||
imwatchingyou.initialize()
|
||||
2. At the top of your app's event loop add
|
||||
imwatchingyou.refresh(locals(), globals())
|
||||
"""
|
||||
|
||||
imwatchingyou.initialize()
|
||||
|
||||
layout = [
|
||||
[sg.T('A typical PSG application')],
|
||||
[sg.In(key='_IN_')],
|
||||
[sg.T(' ', key='_OUT_')],
|
||||
[sg.Radio('a',1, key='_R1_'), sg.Radio('b',1, key='_R2_'), sg.Radio('c',1, key='_R3_')],
|
||||
[sg.Combo(['c1', 'c2', 'c3'], size=(6,3), key='_COMBO_')],
|
||||
[sg.Output(size=(50,6))],
|
||||
[sg.Ok(), sg.Exit()],
|
||||
]
|
||||
|
||||
|
||||
window = sg.Window('This is your Application Window', layout)
|
||||
window.Element('_OUT_').Update(background_color='red')
|
||||
# Variables that we'll use to demonstrate the debugger's features
|
||||
counter = 0
|
||||
timeout = 100
|
||||
|
||||
while True: # Event Loop
|
||||
imwatchingyou.refresh(locals(), globals()) # call the debugger to refresh the items being shown
|
||||
event, values = window.Read(timeout=timeout)
|
||||
if event in (None, 'Exit'):
|
||||
break
|
||||
elif event == 'Ok':
|
||||
print('You clicked Ok.... this is where print output goes')
|
||||
counter += 1
|
||||
window.Element('_OUT_').Update(values['_IN_'])
|
||||
```
|
||||
|
||||
|
||||
## Using imwatchingyou
|
||||
|
||||
To use the debugger in your code you will need to add TWO lines of code:
|
||||
The import at the top of your code:
|
||||
`import imwatchingyou`
|
||||
|
||||
You need to "initialize" the imwatchingyou package by calling near the top of your code. This is what creates the debugger window:
|
||||
`imwatchingyou.initialize()`
|
||||
|
||||
This "refresh" call that must be added to your event loop. Your `window.Read` call should have a timeout value so that it does not block. If you do not have a timeout value, the debugger will not update in realtime.
|
||||
|
||||
Add this line to the top of your event loop.
|
||||
`imwatchingyou.refresh(locals(), globals())`
|
||||
|
||||
### Using in "when needed" mode
|
||||
|
||||
The Demo Program was recently updated so that instead of launching with the Debugger window immediately shown, the program launches with the Debugger not started. With this new code, you can open and close the Debugger as many times as you wish.
|
||||
|
||||
Here is the code, based on the code shown previously in this readme, that has a "Debug" button
|
||||
|
||||
```python
|
||||
import PySimpleGUI as sg
|
||||
import imwatchingyou # STEP 1
|
||||
|
||||
"""
|
||||
Demo program that shows you how to integrate the PySimpleGUI Debugger
|
||||
into your program.
|
||||
In this example, the debugger is not started initiallly. You click the "Debug" button to launch it
|
||||
There are THREE steps, and they are copy and pastes.
|
||||
1. At the top of your app to debug add
|
||||
import imwatchingyou
|
||||
2. Initialize the debugger at the start of your program by calling:
|
||||
imwatchingyou.initialize()
|
||||
3. At the top of your app's Event Loop add:
|
||||
imwatchingyou.refresh(locals(), globals())
|
||||
"""
|
||||
|
||||
layout = [
|
||||
[sg.T('A typical PSG application')],
|
||||
[sg.In(key='_IN_')],
|
||||
[sg.T(' ', key='_OUT_')],
|
||||
[sg.Radio('a',1, key='_R1_'), sg.Radio('b',1, key='_R2_'), sg.Radio('c',1, key='_R3_')],
|
||||
[sg.Combo(['c1', 'c2', 'c3'], size=(6,3), key='_COMBO_')],
|
||||
[sg.Output(size=(50,6))],
|
||||
[sg.Ok(), sg.Exit(), sg.B('Debug')],
|
||||
]
|
||||
|
||||
window = sg.Window('This is your Application Window', layout)
|
||||
|
||||
counter = 0
|
||||
timeout = 100
|
||||
debug_started = False
|
||||
|
||||
while True: # Your Event Loop
|
||||
if debug_started:
|
||||
debug_started = imwatchingyou.refresh(locals(), globals()) # STEP 3 - refresh debugger
|
||||
event, values = window.Read(timeout=timeout)
|
||||
if event in (None, 'Exit'):
|
||||
break
|
||||
elif event == 'Ok':
|
||||
print('You clicked Ok.... this is where print output goes')
|
||||
elif event == 'Debug' and not debug_started:
|
||||
imwatchingyou.initialize() # STEP 2
|
||||
debug_started = True
|
||||
counter += 1
|
||||
window.Element('_OUT_').Update(values['_IN_'])
|
||||
window.Close()
|
||||
```
|
||||
|
||||
This puts the launching of the debugger firmly into the control of the program being debugged. Want debugger help? Then press the debug button.
|
||||
|
||||
In the future I want to add a "hotkey" or some other trivial way of launching a debugger from any program that has is running PySimpleGUI. The only one with real trouble wit this will be the PySimpleGUIWeb one as multiple web windows gets a bit cluttered.
|
||||
|
||||
|
||||
## Requirements
|
||||
|
||||
** You'll need to have PySimpleGUI installed. It will automatically be installed if it is not already installed. **
|
||||
|
||||
The debugger itself is written using PySimpleGUI, the tkinter version. It could be changed to use Qt for example by modifying the pip installed version.
|
||||
|
||||
You MUST run the debugger from the pip installed version. You cannot download the debugger from the GitHub at this point and use it.
|
||||
|
||||
## What's it good for, when should it be used??
|
||||
|
||||
Hell if I know. Maybe it's a terrible idea! Or, maybe it'll be really helpful, particularly in situations where you don't have many resources on the target system and perhaps you can't fit a debugger onto that system. imwatchingyou provides another tool for your Python toolbox.
|
||||
|
||||
## The Future
|
||||
|
||||
LOTS of plans for this debugger in the future. One of the immediate things I want to do is to integrate this into the PySimpleGUI.py file itself. To include the debugger with the SDK so that it doesn't have to be installed.
|
||||
|
||||
This will enable the use of a "hotkey" or other mechanism to "magically launch" the debugger.
|
||||
|
||||
I'll be adding a "Launch debugger" button for sure so that it's trivial for you to add this capability to your code.
|
||||
|
||||
Watch this space in the future! COOL SHIT COMING SOON!
|
||||
|
||||
|
||||
# Design
|
||||
# Author
|
||||
Mike B.
|
||||
|
||||
|
||||
# License
|
||||
GNU Lesser General Public License (LGPL 3) +
|
||||
Loading…
Reference in New Issue