root / docstrings / pyinotify.Stats-class.html

Revision a17385ae4cd3f952f689cfeee0d6e04841a4325e, 17.6 kB (checked in by Sebastien Martini <seb@…>, 21 minutes ago)

Updated docstrings generated documentation.

  • Property mode set to 100644
Line 
1<?xml version="1.0" encoding="ascii"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3          "DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
6  <title>pyinotify.Stats</title>
7  <link rel="stylesheet" href="epydoc.css" type="text/css" />
8  <script type="text/javascript" src="epydoc.js"></script>
9</head>
10
11<body bgcolor="white" text="black" link="blue" vlink="#204080"
12      alink="#204080">
13<!-- ==================== NAVIGATION BAR ==================== -->
14<table class="navbar" border="0" width="100%" cellpadding="0"
15       bgcolor="#a0c0ff" cellspacing="0">
16  <tr valign="middle">
17  <!-- Home link -->
18      <th>&nbsp;&nbsp;&nbsp;<a
19        href="pyinotify-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
20
21  <!-- Tree link -->
22      <th>&nbsp;&nbsp;&nbsp;<a
23        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
24
25  <!-- Index link -->
26      <th>&nbsp;&nbsp;&nbsp;<a
27        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
28
29  <!-- Help link -->
30      <th>&nbsp;&nbsp;&nbsp;<a
31        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
32
33      <th class="navbar" width="100%"></th>
34  </tr>
35</table>
36<table width="100%" cellpadding="0" cellspacing="0">
37  <tr valign="top">
38    <td width="100%">
39      <span class="breadcrumbs">
40        <a href="pyinotify-module.html">Module&nbsp;pyinotify</a> ::
41        Class&nbsp;Stats
42      </span>
43    </td>
44    <td>
45      <table cellpadding="0" cellspacing="0">
46        <!-- hide/show private -->
47        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
48    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
49        <tr><td align="right"><span class="options"
50            >[<a href="frames.html" target="_top">frames</a
51            >]&nbsp;|&nbsp;<a href="pyinotify.Stats-class.html"
52            target="_top">no&nbsp;frames</a>]</span></td></tr>
53      </table>
54    </td>
55  </tr>
56</table>
57<!-- ==================== CLASS DESCRIPTION ==================== -->
58<h1 class="epydoc">Class Stats</h1><p class="nomargin-top"><span class="codelink"><a href="pyinotify-pysrc.html#Stats">source&nbsp;code</a></span></p>
59<center>
60<center>  <map id="uml_class_diagram_for_pyinotif_16" name="uml_class_diagram_for_pyinotif_16">
61<area shape="rect" href="pyinotify.Stats&#45;class.html#my_init" title="Override this method when subclassing if you want to achieve custom &#160;initialization of your subclass&#39; instance." alt="" coords="43,223,205,241"/>
62<area shape="rect" href="pyinotify.Stats&#45;class.html#process_default" title="Default default processing event method." alt="" coords="43,241,205,260"/>
63<area shape="rect" href="pyinotify.Stats&#45;class.html#__repr__" title="repr(x)" alt="" coords="43,260,205,279"/>
64<area shape="rect" href="pyinotify.Stats&#45;class.html#dump" title="pyinotify.Stats.dump" alt="" coords="43,279,205,297"/>
65<area shape="rect" href="pyinotify.Stats&#45;class.html#__str__" title="str(x)" alt="" coords="43,297,205,316"/>
66<area shape="rect" href="pyinotify.Stats&#45;class.html" title="pyinotify.Stats" alt="" coords="41,197,207,317"/>
67<area shape="rect" href="pyinotify.ProcessEvent&#45;class.html#pevent" title="pyinotify.ProcessEvent.pevent" alt="" coords="17,89,231,108"/>
68<area shape="rect" href="pyinotify.ProcessEvent&#45;class.html#__init__" title="Enable chaining of ProcessEvent instances." alt="" coords="17,111,231,129"/>
69<area shape="rect" href="pyinotify.ProcessEvent&#45;class.html#__call__" title="To behave like a functor the object must be callable." alt="" coords="17,129,231,148"/>
70<area shape="rect" href="pyinotify.ProcessEvent&#45;class.html#nested_pevent" title="pyinotify.ProcessEvent.nested_pevent" alt="" coords="17,148,231,167"/>
71<area shape="rect" href="pyinotify.ProcessEvent&#45;class.html" title="Process events objects, can be specialized via subclassing, thus its behavior can be overriden:" alt="" coords="16,72,232,168"/>
72<area shape="rect" href="pyinotify._ProcessEvent&#45;class.html" title="Abstract processing event class." alt="" coords="79,11,169,43"/>
73</map>
74  <img src="uml_class_diagram_for_pyinotif_16.gif" alt='' usemap="#uml_class_diagram_for_pyinotif_16" ismap="ismap" class="graph-without-title" />
75</center>
76</center>
77<hr />
78<!-- ==================== INSTANCE METHODS ==================== -->
79<a name="section-InstanceMethods"></a>
80<table class="summary" border="1" cellpadding="3"
81       cellspacing="0" width="100%" bgcolor="white">
82<tr bgcolor="#70b0f0" class="table-header">
83  <td colspan="2" class="table-header">
84    <table border="0" cellpadding="0" cellspacing="0" width="100%">
85      <tr valign="top">
86        <td align="left"><span class="table-header">Instance Methods</span></td>
87        <td align="right" valign="top"
88         ><span class="options">[<a href="#section-InstanceMethods"
89         class="privatelink" onclick="toggle_private();"
90         >hide private</a>]</span></td>
91      </tr>
92    </table>
93  </td>
94</tr>
95<tr>
96    <td width="15%" align="right" valign="top" class="summary">
97      <span class="summary-type">&nbsp;</span>
98    </td><td class="summary">
99      <table width="100%" cellpadding="0" cellspacing="0" border="0">
100        <tr>
101          <td><span class="summary-sig"><a href="pyinotify.Stats-class.html#my_init" class="summary-sig-name">my_init</a>(<span class="summary-sig-arg">self</span>)</span><br />
102      Override this method when subclassing if you want to achieve custom
103      initialization of your subclass' instance.</td>
104          <td align="right" valign="top">
105            <span class="codelink"><a href="pyinotify-pysrc.html#Stats.my_init">source&nbsp;code</a></span>
106           
107          </td>
108        </tr>
109      </table>
110     
111    </td>
112  </tr>
113<tr>
114    <td width="15%" align="right" valign="top" class="summary">
115      <span class="summary-type">&nbsp;</span>
116    </td><td class="summary">
117      <table width="100%" cellpadding="0" cellspacing="0" border="0">
118        <tr>
119          <td><span class="summary-sig"><a href="pyinotify.Stats-class.html#process_default" class="summary-sig-name">process_default</a>(<span class="summary-sig-arg">self</span>,
120        <span class="summary-sig-arg">event</span>)</span><br />
121      Default default processing event method.</td>
122          <td align="right" valign="top">
123            <span class="codelink"><a href="pyinotify-pysrc.html#Stats.process_default">source&nbsp;code</a></span>
124           
125          </td>
126        </tr>
127      </table>
128     
129    </td>
130  </tr>
131<tr class="private">
132    <td width="15%" align="right" valign="top" class="summary">
133      <span class="summary-type">&nbsp;</span>
134    </td><td class="summary">
135      <table width="100%" cellpadding="0" cellspacing="0" border="0">
136        <tr>
137          <td><span class="summary-sig"><a name="_stats_copy"></a><span class="summary-sig-name">_stats_copy</span>(<span class="summary-sig-arg">self</span>)</span></td>
138          <td align="right" valign="top">
139            <span class="codelink"><a href="pyinotify-pysrc.html#Stats._stats_copy">source&nbsp;code</a></span>
140           
141          </td>
142        </tr>
143      </table>
144     
145    </td>
146  </tr>
147<tr>
148    <td width="15%" align="right" valign="top" class="summary">
149      <span class="summary-type">&nbsp;</span>
150    </td><td class="summary">
151      <table width="100%" cellpadding="0" cellspacing="0" border="0">
152        <tr>
153          <td><span class="summary-sig"><a href="pyinotify.Stats-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br />
154      repr(x)</td>
155          <td align="right" valign="top">
156            <span class="codelink"><a href="pyinotify-pysrc.html#Stats.__repr__">source&nbsp;code</a></span>
157           
158          </td>
159        </tr>
160      </table>
161     
162    </td>
163  </tr>
164<tr>
165    <td width="15%" align="right" valign="top" class="summary">
166      <span class="summary-type">&nbsp;</span>
167    </td><td class="summary">
168      <table width="100%" cellpadding="0" cellspacing="0" border="0">
169        <tr>
170          <td><span class="summary-sig"><a name="dump"></a><span class="summary-sig-name">dump</span>(<span class="summary-sig-arg">self</span>,
171        <span class="summary-sig-arg">filename</span>)</span></td>
172          <td align="right" valign="top">
173            <span class="codelink"><a href="pyinotify-pysrc.html#Stats.dump">source&nbsp;code</a></span>
174           
175          </td>
176        </tr>
177      </table>
178     
179    </td>
180  </tr>
181<tr>
182    <td width="15%" align="right" valign="top" class="summary">
183      <span class="summary-type">&nbsp;</span>
184    </td><td class="summary">
185      <table width="100%" cellpadding="0" cellspacing="0" border="0">
186        <tr>
187          <td><span class="summary-sig"><a href="pyinotify.Stats-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">self</span>,
188        <span class="summary-sig-arg">scale</span>=<span class="summary-sig-default">45</span>)</span><br />
189      str(x)</td>
190          <td align="right" valign="top">
191            <span class="codelink"><a href="pyinotify-pysrc.html#Stats.__str__">source&nbsp;code</a></span>
192           
193          </td>
194        </tr>
195      </table>
196     
197    </td>
198  </tr>
199  <tr>
200    <td colspan="2" class="summary">
201    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="pyinotify.ProcessEvent-class.html">ProcessEvent</a></code></b>:
202      <code><a href="pyinotify.ProcessEvent-class.html#__call__">__call__</a></code>,
203      <code><a href="pyinotify.ProcessEvent-class.html#__init__">__init__</a></code>,
204      <code><a href="pyinotify.ProcessEvent-class.html#nested_pevent">nested_pevent</a></code>
205      </p>
206    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
207      <code>__delattr__</code>,
208      <code>__getattribute__</code>,
209      <code>__hash__</code>,
210      <code>__new__</code>,
211      <code>__reduce__</code>,
212      <code>__reduce_ex__</code>,
213      <code>__setattr__</code>
214      </p>
215    </td>
216  </tr>
217</table>
218<!-- ==================== CLASS VARIABLES ==================== -->
219<a name="section-ClassVariables"></a>
220<table class="summary" border="1" cellpadding="3"
221       cellspacing="0" width="100%" bgcolor="white">
222<tr bgcolor="#70b0f0" class="table-header">
223  <td colspan="2" class="table-header">
224    <table border="0" cellpadding="0" cellspacing="0" width="100%">
225      <tr valign="top">
226        <td align="left"><span class="table-header">Class Variables</span></td>
227        <td align="right" valign="top"
228         ><span class="options">[<a href="#section-ClassVariables"
229         class="privatelink" onclick="toggle_private();"
230         >hide private</a>]</span></td>
231      </tr>
232    </table>
233  </td>
234</tr>
235  <tr>
236    <td colspan="2" class="summary">
237    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="pyinotify.ProcessEvent-class.html">ProcessEvent</a></code></b>:
238      <code><a href="pyinotify.ProcessEvent-class.html#pevent">pevent</a></code>
239      </p>
240    </td>
241  </tr>
242</table>
243<!-- ==================== PROPERTIES ==================== -->
244<a name="section-Properties"></a>
245<table class="summary" border="1" cellpadding="3"
246       cellspacing="0" width="100%" bgcolor="white">
247<tr bgcolor="#70b0f0" class="table-header">
248  <td colspan="2" class="table-header">
249    <table border="0" cellpadding="0" cellspacing="0" width="100%">
250      <tr valign="top">
251        <td align="left"><span class="table-header">Properties</span></td>
252        <td align="right" valign="top"
253         ><span class="options">[<a href="#section-Properties"
254         class="privatelink" onclick="toggle_private();"
255         >hide private</a>]</span></td>
256      </tr>
257    </table>
258  </td>
259</tr>
260  <tr>
261    <td colspan="2" class="summary">
262    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
263      <code>__class__</code>
264      </p>
265    </td>
266  </tr>
267</table>
268<!-- ==================== METHOD DETAILS ==================== -->
269<a name="section-MethodDetails"></a>
270<table class="details" border="1" cellpadding="3"
271       cellspacing="0" width="100%" bgcolor="white">
272<tr bgcolor="#70b0f0" class="table-header">
273  <td colspan="2" class="table-header">
274    <table border="0" cellpadding="0" cellspacing="0" width="100%">
275      <tr valign="top">
276        <td align="left"><span class="table-header">Method Details</span></td>
277        <td align="right" valign="top"
278         ><span class="options">[<a href="#section-MethodDetails"
279         class="privatelink" onclick="toggle_private();"
280         >hide private</a>]</span></td>
281      </tr>
282    </table>
283  </td>
284</tr>
285</table>
286<a name="my_init"></a>
287<div>
288<table class="details" border="1" cellpadding="3"
289       cellspacing="0" width="100%" bgcolor="white">
290<tr><td>
291  <table width="100%" cellpadding="0" cellspacing="0" border="0">
292  <tr valign="top"><td>
293  <h3 class="epydoc"><span class="sig"><span class="sig-name">my_init</span>(<span class="sig-arg">self</span>)</span>
294  </h3>
295  </td><td align="right" valign="top"
296    ><span class="codelink"><a href="pyinotify-pysrc.html#Stats.my_init">source&nbsp;code</a></span>&nbsp;
297    </td>
298  </tr></table>
299 
300  <p>Override this method when subclassing if you want to achieve custom
301  initialization of your subclass' instance. You MUST pass keyword
302  arguments. This method does nothing by default.</p>
303  <dl class="fields">
304    <dt>Parameters:</dt>
305    <dd><ul class="nomargin-top">
306        <li><strong class="pname"><code>kargs</code></strong> - optional arguments delagated to template method my_init</li>
307    </ul></dd>
308    <dt>Overrides:
309        <a href="pyinotify.ProcessEvent-class.html#my_init">ProcessEvent.my_init</a>
310        <dd><em class="note">(inherited documentation)</em></dd>
311    </dt>
312  </dl>
313</td></tr></table>
314</div>
315<a name="process_default"></a>
316<div>
317<table class="details" border="1" cellpadding="3"
318       cellspacing="0" width="100%" bgcolor="white">
319<tr><td>
320  <table width="100%" cellpadding="0" cellspacing="0" border="0">
321  <tr valign="top"><td>
322  <h3 class="epydoc"><span class="sig"><span class="sig-name">process_default</span>(<span class="sig-arg">self</span>,
323        <span class="sig-arg">event</span>)</span>
324  </h3>
325  </td><td align="right" valign="top"
326    ><span class="codelink"><a href="pyinotify-pysrc.html#Stats.process_default">source&nbsp;code</a></span>&nbsp;
327    </td>
328  </tr></table>
329 
330  <p>Default default processing event method. Print event on standart
331  output.</p>
332  <dl class="fields">
333    <dt>Parameters:</dt>
334    <dd><ul class="nomargin-top">
335        <li><strong class="pname"><code>event</code></strong> - Event to be processed.</li>
336    </ul></dd>
337    <dt>Overrides:
338        <a href="pyinotify.ProcessEvent-class.html#process_default">ProcessEvent.process_default</a>
339        <dd><em class="note">(inherited documentation)</em></dd>
340    </dt>
341  </dl>
342</td></tr></table>
343</div>
344<a name="__repr__"></a>
345<div>
346<table class="details" border="1" cellpadding="3"
347       cellspacing="0" width="100%" bgcolor="white">
348<tr><td>
349  <table width="100%" cellpadding="0" cellspacing="0" border="0">
350  <tr valign="top"><td>
351  <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span>
352    <br /><em class="fname">(Representation operator)</em>
353  </h3>
354  </td><td align="right" valign="top"
355    ><span class="codelink"><a href="pyinotify-pysrc.html#Stats.__repr__">source&nbsp;code</a></span>&nbsp;
356    </td>
357  </tr></table>
358 
359  <p>repr(x)</p>
360  <dl class="fields">
361    <dt>Overrides:
362        object.__repr__
363        <dd><em class="note">(inherited documentation)</em></dd>
364    </dt>
365  </dl>
366</td></tr></table>
367</div>
368<a name="__str__"></a>
369<div>
370<table class="details" border="1" cellpadding="3"
371       cellspacing="0" width="100%" bgcolor="white">
372<tr><td>
373  <table width="100%" cellpadding="0" cellspacing="0" border="0">
374  <tr valign="top"><td>
375  <h3 class="epydoc"><span class="sig"><span class="sig-name">__str__</span>(<span class="sig-arg">self</span>,
376        <span class="sig-arg">scale</span>=<span class="sig-default">45</span>)</span>
377    <br /><em class="fname">(Informal representation operator)</em>
378  </h3>
379  </td><td align="right" valign="top"
380    ><span class="codelink"><a href="pyinotify-pysrc.html#Stats.__str__">source&nbsp;code</a></span>&nbsp;
381    </td>
382  </tr></table>
383 
384  <p>str(x)</p>
385  <dl class="fields">
386    <dt>Overrides:
387        object.__str__
388        <dd><em class="note">(inherited documentation)</em></dd>
389    </dt>
390  </dl>
391</td></tr></table>
392</div>
393<br />
394<!-- ==================== NAVIGATION BAR ==================== -->
395<table class="navbar" border="0" width="100%" cellpadding="0"
396       bgcolor="#a0c0ff" cellspacing="0">
397  <tr valign="middle">
398  <!-- Home link -->
399      <th>&nbsp;&nbsp;&nbsp;<a
400        href="pyinotify-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
401
402  <!-- Tree link -->
403      <th>&nbsp;&nbsp;&nbsp;<a
404        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
405
406  <!-- Index link -->
407      <th>&nbsp;&nbsp;&nbsp;<a
408        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;