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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.LogFormatter:
==========================================================================================================================================
|phoenix_title| **wx.LogFormatter**
==========================================================================================================================================
:ref:`wx.LogFormatter` class is used to format the log messages.
It implements the default formatting and can be derived from to create custom formatters.
The default implementation formats the message into a string containing the time stamp, level-dependent prefix and the message itself.
To change it, you can derive from it and override its :meth:`~wx.LogFormatter.Format` method. For example, to include the thread id in the log messages you can use ::
class LogFormatterWithThread(wx.LogFormatter):
def Format(level, msg, info):
return "[%d] %s(%d) : %s" % \
(info.threadId, info.filename, info.line, msg)
And then associate it with :ref:`wx.Log` instance using its SetFormatter(). Then, if you call:
::
wx.LogMessage("*** Application started ***")
the log output could be something like:
.. versionadded:: 2.9.4
.. seealso:: :ref:`Logging Overview <logging overview>`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>LogFormatter</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.LogFormatter_inheritance.png" alt="Inheritance diagram of LogFormatter" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.LogFormatter.html" title="wx.LogFormatter" alt="" coords="5,5,133,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.LogFormatter.__init__` The default constructor does nothing.
:meth:`~wx.LogFormatter.Format` This function creates the full log message string.
:meth:`~wx.LogFormatter.FormatTime` This function formats the time stamp part of the log message.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.LogFormatter(object)
**Possible constructors**::
LogFormatter()
LogFormatter class is used to format the log messages.
.. method:: __init__(self)
The default constructor does nothing.
.. method:: Format(self, level, msg, info)
This function creates the full log message string.
Override it to customize the output string format.
:param `level`: The level of this log record, e.g. :ref:`wx.LOG_Error`.
:type `level`: wx.LogLevel
:param `msg`: The log message itself.
:type `msg`: string
:param `info`: All the other information (such as time, component, location...) associated with this log record.
:type `info`: wx.LogRecordInfo
:rtype: `string`
:returns:
The formated message.
.. note::
Time stamping is disabled for Visual C++ users in debug builds by default because otherwise it would be impossible to directly go to the line from which the log message was generated by simply clicking in the debugger window on the corresponding error message. If you wish to enable it, override :meth:`FormatTime` .
.. method:: FormatTime(self, time)
This function formats the time stamp part of the log message.
Override this function if you need to customize just the time stamp.
:param `time`: Time to format.
:type `time`: int
:rtype: `string`
:returns:
The formated time string, may be empty.
|
