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
|
debug module
==============
::
from sqlkit import debug as dbg
purpose
=========
.. image:: ../img/gtk_debug.png
:align: right
This module provides easy way to debug with print commands. This is not in
general my preferred way of debugging (``pdb`` within ipython being my
preferred solution). Nevertheless I found myself in need of these functions.
Printing of messages can be easily switched on or off.
Printing can diverted to a gtk widget.
Methods of Classes can be tracked in the way reported in the image, where
blue rows correspond to ``dbg.write`` commands and all the rest is
tracking of methods calls.
use
=====
switching debug on & off
------------------------
The way to use this is
1. in you library::
from sqlkit import debug as dbg
dbg.write('text message', 'text2')
2. in you application::
from sqlkit import debug as dbg
dbg.debug(True)
write() - caller()
------------------
from now on, each time you use dbg.write()/dbg.caller() you'll see the text you
want to log anly if you enabled it with dbg.debug(True)
If you want the log to happen in a gtk.TreeView window, you can specify:;
import dbg
dbg.debug(True, gtk=True)
Logging methods
---------------
Following recipe 198078 in the ASP Python CookBook (see in the code)
this module provides also a metaclass to trace the use of methods of a
particular class. It will be instantiated as::
class A(object):
__metaclass__ = dbg.LogTheMethods
for each method call a line will be logged (unless configured to be ignored)
with
function called
caller class
arguments
caller function
line of code
return code
calling class
time elapsed
IMPORTANT: since the logging occurs with metaclasses you need to import dbg and
set debugging *before* importing the class you want to trace::
from sqlkit import debug as dbg
dbg.debug(True, gtk=True)
dbg.trace_class('SqlTable2') # optional
dbg.trace_function(exclude='cell_default_cb|cell_bool_cb') # optional
import sqlkit
TraceIt
-------
in case you need to understand who is changing the value of a variable, you
can use TraceIt as::
commit_allowed = dbg.TraceIt(True, name='commit_allowed', mode='rw')
and use it as a normal variable. You'll get lines in your output stating
who changed the value of that variable, in the form::
__str__/function_name: old_value => new_value
__get__/function_name: value
|
