1 <?xml version="1.0" encoding="iso-8859-1"?>
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">
6 <title>lightmediascanner.c_lightmediascanner.LightMediaScanner</title>
7 <link rel="stylesheet" href="epydoc.css" type="text/css"></link>
9 <body bgcolor="white" text="black" link="blue" vlink="#204080"
12 <!-- =========== START OF NAVBAR =========== -->
13 <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
15 <th class="navbar"> <a class="navbar" href="lightmediascanner-module.html">Home</a> </th>
16 <th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
17 <th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
18 <th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
19 <th class="navbar" width="100%"></th>
22 <table width="100%" cellpadding="0" cellspacing="0">
25 <font size="-1"><b class="breadcrumbs">
26 <a href="lightmediascanner-module.html">Package lightmediascanner</a> ::
27 <a href="lightmediascanner.c_lightmediascanner-module.html">Module c_lightmediascanner</a> ::
28 Class LightMediaScanner
31 <td><table cellpadding="0" cellspacing="0">
32 <tr><td align="right"><font size="-2">[show private | <a href="../public/lightmediascanner.c_lightmediascanner.LightMediaScanner-class.html">hide private</a>]</font></td></tr>
33 <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="lightmediascanner.c_lightmediascanner.LightMediaScanner-class.html" target="_top">no frames</a>]</font></td></tr>
37 <!-- =========== START OF CLASS DESCRIPTION =========== -->
38 <h2 class="class">Type LightMediaScanner</h2>
40 <pre class="base-tree">
41 <a href="__builtin__.object-class.html"><code>object</code></a> --+
43 <b>LightMediaScanner</b>
49 <!-- =========== START OF METHOD SUMMARY =========== -->
50 <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
51 <tr bgcolor="#70b0f0" class="summary">
52 <th colspan="2">Method Summary</th></tr>
53 <tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
54 <td><code><span class="summary-sig"><a href="lightmediascanner.c_lightmediascanner.LightMediaScanner-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
56 x.__init__(...) initializes x; see x.__class__.__doc__ for
58 <tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
59 <td><code><span class="summary-sig"><a href="lightmediascanner.c_lightmediascanner.LightMediaScanner-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>,
60 <span class=summary-sig-arg>S</span>,
61 <span class="summary-sig-vararg">...</span>)</span></code>
63 T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr>
64 <tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
65 <td><code><a name="__repr__"></a><span class="summary-sig"><span class="summary-sig-name">__repr__</span>(<span class="summary-sig-vararg">...</span>)</span></code>
67 <tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
68 <td><code><a name="__str__"></a><span class="summary-sig"><span class="summary-sig-name">__str__</span>(<span class="summary-sig-vararg">...</span>)</span></code>
70 <tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
71 <td><code><span class="summary-sig"><a href="lightmediascanner.c_lightmediascanner.LightMediaScanner-class.html#charset_add" class="summary-sig-name"><code>charset_add</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
73 Add charset to list of supported input charsets/encoding.</td></tr>
74 <tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
75 <td><code><span class="summary-sig"><a href="lightmediascanner.c_lightmediascanner.LightMediaScanner-class.html#charset_del" class="summary-sig-name"><code>charset_del</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
77 Del charset from list of supported input charsets/encoding.</td></tr>
78 <tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
79 <td><code><span class="summary-sig"><a href="lightmediascanner.c_lightmediascanner.LightMediaScanner-class.html#check" class="summary-sig-name"><code>check</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
81 Check (and update) files under directory.</td></tr>
82 <tr><td align="right" valign="top" width="15%"><font size="-1"> int
84 <td><code><span class="summary-sig"><a href="lightmediascanner.c_lightmediascanner.LightMediaScanner-class.html#get_commit_interval" class="summary-sig-name"><code>get_commit_interval</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
86 <tr><td align="right" valign="top" width="15%"><font size="-1"> int
88 <td><code><span class="summary-sig"><a href="lightmediascanner.c_lightmediascanner.LightMediaScanner-class.html#get_slave_timeout" class="summary-sig-name"><code>get_slave_timeout</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
90 <tr><td align="right" valign="top" width="15%"><font size="-1"> bool
92 <td><code><span class="summary-sig"><a href="lightmediascanner.c_lightmediascanner.LightMediaScanner-class.html#is_processing" class="summary-sig-name"><code>is_processing</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
94 <tr><td align="right" valign="top" width="15%"><font size="-1"> <a
95 href="lightmediascanner.c_lightmediascanner.Parser-class.html"
96 class="link"><code>Parser</code></a>
98 <td><code><span class="summary-sig"><a href="lightmediascanner.c_lightmediascanner.LightMediaScanner-class.html#parser_add" class="summary-sig-name"><code>parser_add</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
100 Add a new plugin/parser based on it's whole path to shared object.</td></tr>
101 <tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
102 <td><code><span class="summary-sig"><a href="lightmediascanner.c_lightmediascanner.LightMediaScanner-class.html#parser_del" class="summary-sig-name"><code>parser_del</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
104 Delete a plugin/parser.</td></tr>
105 <tr><td align="right" valign="top" width="15%"><font size="-1"> <a
106 href="lightmediascanner.c_lightmediascanner.Parser-class.html"
107 class="link"><code>Parser</code></a>
109 <td><code><span class="summary-sig"><a href="lightmediascanner.c_lightmediascanner.LightMediaScanner-class.html#parser_find_and_add" class="summary-sig-name"><code>parser_find_and_add</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
111 Add a new plugin/parser based on it's name.</td></tr>
112 <tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
113 <td><code><span class="summary-sig"><a href="lightmediascanner.c_lightmediascanner.LightMediaScanner-class.html#process" class="summary-sig-name"><code>process</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
115 Process directory recursively.</td></tr>
116 <tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
117 <td><code><span class="summary-sig"><a href="lightmediascanner.c_lightmediascanner.LightMediaScanner-class.html#set_commit_interval" class="summary-sig-name"><code>set_commit_interval</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
119 Set the number of transactions between commits.</td></tr>
120 <tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
121 <td><code><span class="summary-sig"><a href="lightmediascanner.c_lightmediascanner.LightMediaScanner-class.html#set_slave_timeout" class="summary-sig-name"><code>set_slave_timeout</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
123 Set maximum time a parser may use.</td></tr>
124 <tr bgcolor="#e8f0f8" class="group">
125 <th colspan="2"> Inherited from object</th></tr>
126 <tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
127 <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
129 x.__delattr__('name') <==> del x.name</td></tr>
130 <tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
131 <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
133 x.__getattribute__('name') <==> x.name</td></tr>
134 <tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
135 <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code>
137 x.__hash__() <==> hash(x)</td></tr>
138 <tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
139 <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
141 helper for pickle</td></tr>
142 <tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
143 <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
145 helper for pickle</td></tr>
146 <tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
147 <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
149 x.__setattr__('name', value) <==> x.name = value</td></tr>
153 <!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
154 <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
155 <tr bgcolor="#70b0f0" class="summary">
156 <th colspan="2">Class Variable Summary</th></tr>
157 <tr><td align="right" valign="top" width="15%"><font size="-1"><code>getset_descriptor</code></font></td>
158 <td><b><a href="lightmediascanner.c_lightmediascanner.LightMediaScanner-class.html#commit_interval"><code>commit_interval</code></a></b> = <span title="<attribute 'commit_interval' of 'lightmediascanner.c_lightmediascanner.LightMediaScanner' objects>"><code><attribute 'commit_interval' of 'light<span class="variable-ellipsis">...</span></code>
160 <tr><td align="right" valign="top" width="15%"><font size="-1"><code>member_descriptor</code></font></td>
161 <td><b><a href="lightmediascanner.c_lightmediascanner.LightMediaScanner-class.html#db_path"><code>db_path</code></a></b> = <span title="<member 'db_path' of 'lightmediascanner.c_lightmediascanner.LightMediaScanner' objects>"><code><member 'db_path' of 'lightmediascanner.c_ligh<span class="variable-ellipsis">...</span></code>
163 <tr><td align="right" valign="top" width="15%"><font size="-1"><code>member_descriptor</code></font></td>
164 <td><b><a href="lightmediascanner.c_lightmediascanner.LightMediaScanner-class.html#parsers"><code>parsers</code></a></b> = <span title="<member 'parsers' of 'lightmediascanner.c_lightmediascanner.LightMediaScanner' objects>"><code><member 'parsers' of 'lightmediascanner.c_ligh<span class="variable-ellipsis">...</span></code>
166 <tr><td align="right" valign="top" width="15%"><font size="-1"><code>getset_descriptor</code></font></td>
167 <td><b><a href="lightmediascanner.c_lightmediascanner.LightMediaScanner-class.html#slave_timeout"><code>slave_timeout</code></a></b> = <span title="<attribute 'slave_timeout' of 'lightmediascanner.c_lightmediascanner.LightMediaScanner' objects>"><code><attribute 'slave_timeout' of 'lightmedi<span class="variable-ellipsis">...</span></code>
172 <!-- =========== START OF METHOD DETAILS =========== -->
173 <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
174 <tr bgcolor="#70b0f0" class="details">
175 <th colspan="2">Method Details</th></tr>
178 <a name="__init__"></a>
179 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
180 <h3><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-vararg">...</span>)</span>
181 <br /><i>(Constructor)</i>
183 x.__init__(...) initializes x; see x.__class__.__doc__ for
186 <dl><dt><b>Overrides:</b></dt>
187 <dd><a href="__builtin__.object-class.html#__init__"><code>__builtin__.object.__init__</code></a></dd>
192 <a name="__new__"></a>
193 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
194 <h3><span class="sig"><span class="sig-name">__new__</span>(<span class=sig-arg>T</span>,
195 <span class=sig-arg>S</span>,
196 <span class="sig-vararg">...</span>)</span>
198 T.__new__(S, ...) -> a new object with type S, a subtype of T
200 <dl><dt><b>Returns:</b></dt>
202 <pre class="literalblock">
203 a new object with type S, a subtype of T
207 <dl><dt><b>Overrides:</b></dt>
208 <dd><a href="__builtin__.object-class.html#__new__"><code>__builtin__.object.__new__</code></a></dd>
213 <a name="charset_add"></a>
214 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
215 <h3><span class="sig"><span class="sig-name">charset_add</span>(<span class="sig-vararg">...</span>)</span>
217 <p>Add charset to list of supported input charsets/encoding.</p>
218 If some string in analysed/parsed files are not UTF-8, then it will
219 try agains a list of charsets registered with this function.
224 <a name="charset_del"></a>
225 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
226 <h3><span class="sig"><span class="sig-name">charset_del</span>(<span class="sig-vararg">...</span>)</span>
228 Del charset from list of supported input charsets/encoding.
234 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
235 <h3><span class="sig"><span class="sig-name">check</span>(<span class="sig-vararg">...</span>)</span>
237 <p>Check (and update) files under directory.</p>
238 This operates on all files in all sub directories of top_path using
239 the added parsers. If files are up to date, nothing is done, otherwise
240 they can be marked as deleted or updated if they still exists, but with
241 different size or modification time.
246 <a name="get_commit_interval"></a>
247 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
248 <h3><span class="sig"><span class="sig-name">get_commit_interval</span>(<span class="sig-vararg">...</span>)</span>
251 <dl><dt><b>Returns:</b></dt>
259 <a name="get_slave_timeout"></a>
260 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
261 <h3><span class="sig"><span class="sig-name">get_slave_timeout</span>(<span class="sig-vararg">...</span>)</span>
264 <dl><dt><b>Returns:</b></dt>
272 <a name="is_processing"></a>
273 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
274 <h3><span class="sig"><span class="sig-name">is_processing</span>(<span class="sig-vararg">...</span>)</span>
277 <dl><dt><b>Returns:</b></dt>
285 <a name="parser_add"></a>
286 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
287 <h3><span class="sig"><span class="sig-name">parser_add</span>(<span class="sig-vararg">...</span>)</span>
289 Add a new plugin/parser based on it's whole path to shared
292 <dl><dt><b>Returns:</b></dt>
295 href="lightmediascanner.c_lightmediascanner.Parser-class.html"
296 class="link"><code>Parser</code></a>
302 <a name="parser_del"></a>
303 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
304 <h3><span class="sig"><span class="sig-name">parser_del</span>(<span class="sig-vararg">...</span>)</span>
306 Delete a plugin/parser.
311 <a name="parser_find_and_add"></a>
312 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
313 <h3><span class="sig"><span class="sig-name">parser_find_and_add</span>(<span class="sig-vararg">...</span>)</span>
315 Add a new plugin/parser based on it's name.
317 <dl><dt><b>Returns:</b></dt>
320 href="lightmediascanner.c_lightmediascanner.Parser-class.html"
321 class="link"><code>Parser</code></a>
327 <a name="process"></a>
328 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
329 <h3><span class="sig"><span class="sig-name">process</span>(<span class="sig-vararg">...</span>)</span>
331 <p>Process directory recursively.</p>
332 This operates on all files in all sub directories of top_path using
338 <a name="set_commit_interval"></a>
339 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
340 <h3><span class="sig"><span class="sig-name">set_commit_interval</span>(<span class="sig-vararg">...</span>)</span>
342 <p>Set the number of transactions between commits.</p>
343 <p>Sets how many transactions/files to handle in one commit, the more
344 the faster, but if one parser takes too long and it's killed due
345 slave_timeout being exceeded, then at most this number of transactions
347 Note that transaction here is not a single SQL statement, but it is
348 considered to be the processing of a file, which can be more than just
354 <a name="set_slave_timeout"></a>
355 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
356 <h3><span class="sig"><span class="sig-name">set_slave_timeout</span>(<span class="sig-vararg">...</span>)</span>
358 <p>Set maximum time a parser may use.</p>
359 This will be the timeout before killing the slave process running
360 some parser. If this happens, another slave process will be started to
361 continue from next file.
368 <!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
369 <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
370 <tr bgcolor="#70b0f0" class="details">
371 <th colspan="2">Class Variable Details</th></tr>
373 <table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
374 <a name="commit_interval"></a>
375 <h3>commit_interval</h3>
380 <dt><b>Type:</b></dt>
382 <code>getset_descriptor</code>
385 <span title="<attribute 'commit_interval' of 'lightmediascanner.c_lightmediascanner.LightMediaScanner' objects>"> <dt><b>Value:</b></dt>
387 <pre class="variable">
388 <attribute 'commit_interval' of 'lightmediascanner.c_lightmediascanner<span class="variable-linewrap">\</span>
389 .LightMediaScanner' objects> </pre>
390 </td></tr></table></dd>
393 </dl></td></tr></table>
394 <table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
395 <a name="db_path"></a>
401 <dt><b>Type:</b></dt>
403 <code>member_descriptor</code>
406 <span title="<member 'db_path' of 'lightmediascanner.c_lightmediascanner.LightMediaScanner' objects>"> <dt><b>Value:</b></dt>
408 <pre class="variable">
409 <member 'db_path' of 'lightmediascanner.c_lightmediascanner.LightMedia<span class="variable-linewrap">\</span>
410 Scanner' objects> </pre>
411 </td></tr></table></dd>
414 </dl></td></tr></table>
415 <table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
416 <a name="parsers"></a>
422 <dt><b>Type:</b></dt>
424 <code>member_descriptor</code>
427 <span title="<member 'parsers' of 'lightmediascanner.c_lightmediascanner.LightMediaScanner' objects>"> <dt><b>Value:</b></dt>
429 <pre class="variable">
430 <member 'parsers' of 'lightmediascanner.c_lightmediascanner.LightMedia<span class="variable-linewrap">\</span>
431 Scanner' objects> </pre>
432 </td></tr></table></dd>
435 </dl></td></tr></table>
436 <table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
437 <a name="slave_timeout"></a>
438 <h3>slave_timeout</h3>
443 <dt><b>Type:</b></dt>
445 <code>getset_descriptor</code>
448 <span title="<attribute 'slave_timeout' of 'lightmediascanner.c_lightmediascanner.LightMediaScanner' objects>"> <dt><b>Value:</b></dt>
450 <pre class="variable">
451 <attribute 'slave_timeout' of 'lightmediascanner.c_lightmediascanner.L<span class="variable-linewrap">\</span>
452 ightMediaScanner' objects> </pre>
453 </td></tr></table></dd>
456 </dl></td></tr></table>
460 <!-- =========== START OF NAVBAR =========== -->
461 <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
463 <th class="navbar"> <a class="navbar" href="lightmediascanner-module.html">Home</a> </th>
464 <th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
465 <th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
466 <th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
467 <th class="navbar" width="100%"></th>
471 <table border="0" cellpadding="0" cellspacing="0" width="100%">
473 <td align="left"><font size="-2">Generated by Epydoc 2.1 on Thu Dec 13 02:07:27 2007</font></td>
474 <td align="right"><a href="http://epydoc.sourceforge.net"
475 ><font size="-2">http://epydoc.sf.net</font></a></td>