Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.WebBrowser.FlashCookieManager.FlashCookieReader.html

eric6/Documentation/Source/eric6.WebBrowser.FlashCookieManager.FlashCookieReader.html

changeset 8069
1176a936efa4
parent 8068
28457602b8f8
child 8070
6758ba4670e1
equal deleted inserted replaced
8068:28457602b8f8 8069:1176a936efa4
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.WebBrowser.FlashCookieManager.FlashCookieReader</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body>
22 <a NAME="top" ID="top"></a>
23 <h1>eric6.WebBrowser.FlashCookieManager.FlashCookieReader</h1>
24
25 <p>
26 Module implementing a class to read flash cookies.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#FlashCookieReader">FlashCookieReader</a></td>
39 <td>Class implementing a reader for flash cookies (*.sol files).</td>
40 </tr>
41 <tr>
42 <td><a href="#FlashCookieReaderError">FlashCookieReaderError</a></td>
43 <td>Class containing data of a reader error.</td>
44 </tr>
45 </table>
46 <h3>Functions</h3>
47
48 <table>
49 <tr><td>None</td></tr>
50 </table>
51 <hr />
52 <hr />
53 <a NAME="FlashCookieReader" ID="FlashCookieReader"></a>
54 <h2>FlashCookieReader</h2>
55
56 <p>
57 Class implementing a reader for flash cookies (*.sol files).
58 </p>
59 <h3>Derived from</h3>
60 object
61 <h3>Class Attributes</h3>
62
63 <table>
64 <tr><td>Boolean</td></tr><tr><td>EpochCorrectionMsecs</td></tr><tr><td>Null</td></tr><tr><td>Number</td></tr><tr><td>ObjArr</td></tr><tr><td>ObjCc</td></tr><tr><td>ObjDate</td></tr><tr><td>ObjM</td></tr><tr><td>ObjObj</td></tr><tr><td>ObjXml</td></tr><tr><td>String</td></tr><tr><td>Undef</td></tr>
65 </table>
66 <h3>Class Methods</h3>
67
68 <table>
69 <tr><td>None</td></tr>
70 </table>
71 <h3>Methods</h3>
72
73 <table>
74
75 <tr>
76 <td><a href="#FlashCookieReader.__init__">FlashCookieReader</a></td>
77 <td>Constructor</td>
78 </tr>
79 <tr>
80 <td><a href="#FlashCookieReader.__parseArray">__parseArray</a></td>
81 <td>Private method to parse an array.</td>
82 </tr>
83 <tr>
84 <td><a href="#FlashCookieReader.__parseBoolean">__parseBoolean</a></td>
85 <td>Private method to parse a boolean.</td>
86 </tr>
87 <tr>
88 <td><a href="#FlashCookieReader.__parseDate">__parseDate</a></td>
89 <td>Private method to parse a date.</td>
90 </tr>
91 <tr>
92 <td><a href="#FlashCookieReader.__parseNull">__parseNull</a></td>
93 <td>Private method to parse a null object.</td>
94 </tr>
95 <tr>
96 <td><a href="#FlashCookieReader.__parseNumber">__parseNumber</a></td>
97 <td>Private method to parse a number.</td>
98 </tr>
99 <tr>
100 <td><a href="#FlashCookieReader.__parseObject">__parseObject</a></td>
101 <td>Private method to parse an object.</td>
102 </tr>
103 <tr>
104 <td><a href="#FlashCookieReader.__parseOcc">__parseOcc</a></td>
105 <td>Private method to parse a c_object.</td>
106 </tr>
107 <tr>
108 <td><a href="#FlashCookieReader.__parseOjm">__parseOjm</a></td>
109 <td>Private method to parse an m_object.</td>
110 </tr>
111 <tr>
112 <td><a href="#FlashCookieReader.__parseString">__parseString</a></td>
113 <td>Private method to parse a string.</td>
114 </tr>
115 <tr>
116 <td><a href="#FlashCookieReader.__parseUndefined">__parseUndefined</a></td>
117 <td>Private method to parse an undefined object.</td>
118 </tr>
119 <tr>
120 <td><a href="#FlashCookieReader.__parseXml">__parseXml</a></td>
121 <td>Private method to parse XML.</td>
122 </tr>
123 <tr>
124 <td><a href="#FlashCookieReader.parse">parse</a></td>
125 <td>Public method to parse the sol file.</td>
126 </tr>
127 <tr>
128 <td><a href="#FlashCookieReader.setBytes">setBytes</a></td>
129 <td>Public method to set the contents of a sol file to be parsed.</td>
130 </tr>
131 <tr>
132 <td><a href="#FlashCookieReader.setFile">setFile</a></td>
133 <td>Public method to set an open sol file to be parsed.</td>
134 </tr>
135 <tr>
136 <td><a href="#FlashCookieReader.setFileName">setFileName</a></td>
137 <td>Public method to set the name of a sol file to be parsed.</td>
138 </tr>
139 <tr>
140 <td><a href="#FlashCookieReader.toString">toString</a></td>
141 <td>Public method to convert the parsed cookie to a string representation.</td>
142 </tr>
143 </table>
144 <h3>Static Methods</h3>
145
146 <table>
147 <tr><td>None</td></tr>
148 </table>
149
150 <a NAME="FlashCookieReader.__init__" ID="FlashCookieReader.__init__"></a>
151 <h4>FlashCookieReader (Constructor)</h4>
152 <b>FlashCookieReader</b>(<i></i>)
153
154 <p>
155 Constructor
156 </p>
157 <a NAME="FlashCookieReader.__parseArray" ID="FlashCookieReader.__parseArray"></a>
158 <h4>FlashCookieReader.__parseArray</h4>
159 <b>__parseArray</b>(<i>variableName, parent</i>)
160
161 <p>
162 Private method to parse an array.
163 </p>
164 <dl>
165
166 <dt><i>variableName</i> (str)</dt>
167 <dd>
168 name of the variable to be parsed
169 </dd>
170 <dt><i>parent</i> (dict)</dt>
171 <dd>
172 reference to the dictionary to insert the result into
173 </dd>
174 </dl>
175 <dl>
176
177 <dt>Raises <b>FlashCookieReaderError</b>:</dt>
178 <dd>
179 raised when an issue with the cookie
180 file is found
181 </dd>
182 </dl>
183 <a NAME="FlashCookieReader.__parseBoolean" ID="FlashCookieReader.__parseBoolean"></a>
184 <h4>FlashCookieReader.__parseBoolean</h4>
185 <b>__parseBoolean</b>(<i>variableName, parent</i>)
186
187 <p>
188 Private method to parse a boolean.
189 </p>
190 <dl>
191
192 <dt><i>variableName</i> (str)</dt>
193 <dd>
194 name of the variable to be parsed
195 </dd>
196 <dt><i>parent</i> (dict)</dt>
197 <dd>
198 reference to the dictionary to insert the result into
199 </dd>
200 </dl>
201 <a NAME="FlashCookieReader.__parseDate" ID="FlashCookieReader.__parseDate"></a>
202 <h4>FlashCookieReader.__parseDate</h4>
203 <b>__parseDate</b>(<i>variableName, parent</i>)
204
205 <p>
206 Private method to parse a date.
207 </p>
208 <dl>
209
210 <dt><i>variableName</i> (str)</dt>
211 <dd>
212 name of the variable to be parsed
213 </dd>
214 <dt><i>parent</i> (dict)</dt>
215 <dd>
216 reference to the dictionary to insert the result into
217 </dd>
218 </dl>
219 <a NAME="FlashCookieReader.__parseNull" ID="FlashCookieReader.__parseNull"></a>
220 <h4>FlashCookieReader.__parseNull</h4>
221 <b>__parseNull</b>(<i>variableName, parent</i>)
222
223 <p>
224 Private method to parse a null object.
225 </p>
226 <dl>
227
228 <dt><i>variableName</i> (str)</dt>
229 <dd>
230 name of the variable to be parsed
231 </dd>
232 <dt><i>parent</i> (dict)</dt>
233 <dd>
234 reference to the dictionary to insert the result into
235 </dd>
236 </dl>
237 <a NAME="FlashCookieReader.__parseNumber" ID="FlashCookieReader.__parseNumber"></a>
238 <h4>FlashCookieReader.__parseNumber</h4>
239 <b>__parseNumber</b>(<i>variableName, parent</i>)
240
241 <p>
242 Private method to parse a number.
243 </p>
244 <dl>
245
246 <dt><i>variableName</i> (str)</dt>
247 <dd>
248 name of the variable to be parsed
249 </dd>
250 <dt><i>parent</i> (dict)</dt>
251 <dd>
252 reference to the dictionary to insert the result into
253 </dd>
254 </dl>
255 <a NAME="FlashCookieReader.__parseObject" ID="FlashCookieReader.__parseObject"></a>
256 <h4>FlashCookieReader.__parseObject</h4>
257 <b>__parseObject</b>(<i>variableName, parent</i>)
258
259 <p>
260 Private method to parse an object.
261 </p>
262 <dl>
263
264 <dt><i>variableName</i> (str)</dt>
265 <dd>
266 name of the variable to be parsed
267 </dd>
268 <dt><i>parent</i> (dict)</dt>
269 <dd>
270 reference to the dictionary to insert the result into
271 </dd>
272 </dl>
273 <dl>
274
275 <dt>Raises <b>FlashCookieReaderError</b>:</dt>
276 <dd>
277 raised when an issue with the cookie
278 file is found
279 </dd>
280 </dl>
281 <a NAME="FlashCookieReader.__parseOcc" ID="FlashCookieReader.__parseOcc"></a>
282 <h4>FlashCookieReader.__parseOcc</h4>
283 <b>__parseOcc</b>(<i>variableName, parent</i>)
284
285 <p>
286 Private method to parse a c_object.
287 </p>
288 <dl>
289
290 <dt><i>variableName</i> (str)</dt>
291 <dd>
292 name of the variable to be parsed
293 </dd>
294 <dt><i>parent</i> (dict)</dt>
295 <dd>
296 reference to the dictionary to insert the result into
297 </dd>
298 </dl>
299 <dl>
300
301 <dt>Raises <b>FlashCookieReaderError</b>:</dt>
302 <dd>
303 raised when an issue with the cookie
304 file is found
305 </dd>
306 </dl>
307 <a NAME="FlashCookieReader.__parseOjm" ID="FlashCookieReader.__parseOjm"></a>
308 <h4>FlashCookieReader.__parseOjm</h4>
309 <b>__parseOjm</b>(<i>variableName, parent</i>)
310
311 <p>
312 Private method to parse an m_object.
313 </p>
314 <dl>
315
316 <dt><i>variableName</i> (str)</dt>
317 <dd>
318 name of the variable to be parsed
319 </dd>
320 <dt><i>parent</i> (dict)</dt>
321 <dd>
322 reference to the dictionary to insert the result into
323 </dd>
324 </dl>
325 <a NAME="FlashCookieReader.__parseString" ID="FlashCookieReader.__parseString"></a>
326 <h4>FlashCookieReader.__parseString</h4>
327 <b>__parseString</b>(<i>variableName, parent</i>)
328
329 <p>
330 Private method to parse a string.
331 </p>
332 <dl>
333
334 <dt><i>variableName</i> (str)</dt>
335 <dd>
336 name of the variable to be parsed
337 </dd>
338 <dt><i>parent</i> (dict)</dt>
339 <dd>
340 reference to the dictionary to insert the result into
341 </dd>
342 </dl>
343 <a NAME="FlashCookieReader.__parseUndefined" ID="FlashCookieReader.__parseUndefined"></a>
344 <h4>FlashCookieReader.__parseUndefined</h4>
345 <b>__parseUndefined</b>(<i>variableName, parent</i>)
346
347 <p>
348 Private method to parse an undefined object.
349 </p>
350 <dl>
351
352 <dt><i>variableName</i> (str)</dt>
353 <dd>
354 name of the variable to be parsed
355 </dd>
356 <dt><i>parent</i> (dict)</dt>
357 <dd>
358 reference to the dictionary to insert the result into
359 </dd>
360 </dl>
361 <a NAME="FlashCookieReader.__parseXml" ID="FlashCookieReader.__parseXml"></a>
362 <h4>FlashCookieReader.__parseXml</h4>
363 <b>__parseXml</b>(<i>variableName, parent</i>)
364
365 <p>
366 Private method to parse XML.
367 </p>
368 <dl>
369
370 <dt><i>variableName</i> (str)</dt>
371 <dd>
372 name of the variable to be parsed
373 </dd>
374 <dt><i>parent</i> (dict)</dt>
375 <dd>
376 reference to the dictionary to insert the result into
377 </dd>
378 </dl>
379 <a NAME="FlashCookieReader.parse" ID="FlashCookieReader.parse"></a>
380 <h4>FlashCookieReader.parse</h4>
381 <b>parse</b>(<i></i>)
382
383 <p>
384 Public method to parse the sol file.
385 </p>
386 <dl>
387
388 <dt>Raises <b>FlashCookieReaderError</b>:</dt>
389 <dd>
390 raised when encountering a parse
391 issue
392 </dd>
393 </dl>
394 <a NAME="FlashCookieReader.setBytes" ID="FlashCookieReader.setBytes"></a>
395 <h4>FlashCookieReader.setBytes</h4>
396 <b>setBytes</b>(<i>solData</i>)
397
398 <p>
399 Public method to set the contents of a sol file to be parsed.
400 </p>
401 <dl>
402
403 <dt><i>solData</i> (bytes)</dt>
404 <dd>
405 contents of the file
406 </dd>
407 </dl>
408 <a NAME="FlashCookieReader.setFile" ID="FlashCookieReader.setFile"></a>
409 <h4>FlashCookieReader.setFile</h4>
410 <b>setFile</b>(<i>solFile</i>)
411
412 <p>
413 Public method to set an open sol file to be parsed.
414 </p>
415 <dl>
416
417 <dt><i>solFile</i> (io.FileIO)</dt>
418 <dd>
419 sol file to be parsed
420 </dd>
421 </dl>
422 <a NAME="FlashCookieReader.setFileName" ID="FlashCookieReader.setFileName"></a>
423 <h4>FlashCookieReader.setFileName</h4>
424 <b>setFileName</b>(<i>solFilename</i>)
425
426 <p>
427 Public method to set the name of a sol file to be parsed.
428 </p>
429 <dl>
430
431 <dt><i>solFilename</i> (str)</dt>
432 <dd>
433 name of the sol file
434 </dd>
435 </dl>
436 <a NAME="FlashCookieReader.toString" ID="FlashCookieReader.toString"></a>
437 <h4>FlashCookieReader.toString</h4>
438 <b>toString</b>(<i>indent=0, parent=None</i>)
439
440 <p>
441 Public method to convert the parsed cookie to a string representation.
442 </p>
443 <dl>
444
445 <dt><i>indent</i> (int)</dt>
446 <dd>
447 indentation level
448 </dd>
449 <dt><i>parent</i> (dict)</dt>
450 <dd>
451 reference to the dictionary to be converted
452 </dd>
453 </dl>
454 <dl>
455 <dt>Return:</dt>
456 <dd>
457 string representation of the cookie
458 </dd>
459 </dl>
460 <dl>
461 <dt>Return Type:</dt>
462 <dd>
463 str
464 </dd>
465 </dl>
466 <div align="right"><a href="#top">Up</a></div>
467 <hr />
468 <hr />
469 <a NAME="FlashCookieReaderError" ID="FlashCookieReaderError"></a>
470 <h2>FlashCookieReaderError</h2>
471
472 <p>
473 Class containing data of a reader error.
474 </p>
475 <h3>Derived from</h3>
476 Exception
477 <h3>Class Attributes</h3>
478
479 <table>
480 <tr><td>None</td></tr>
481 </table>
482 <h3>Class Methods</h3>
483
484 <table>
485 <tr><td>None</td></tr>
486 </table>
487 <h3>Methods</h3>
488
489 <table>
490
491 <tr>
492 <td><a href="#FlashCookieReaderError.__init__">FlashCookieReaderError</a></td>
493 <td>Constructor</td>
494 </tr>
495 </table>
496 <h3>Static Methods</h3>
497
498 <table>
499 <tr><td>None</td></tr>
500 </table>
501
502 <a NAME="FlashCookieReaderError.__init__" ID="FlashCookieReaderError.__init__"></a>
503 <h4>FlashCookieReaderError (Constructor)</h4>
504 <b>FlashCookieReaderError</b>(<i>msg</i>)
505
506 <p>
507 Constructor
508 </p>
509 <dl>
510
511 <dt><i>msg</i> (str)</dt>
512 <dd>
513 error message
514 </dd>
515 </dl>
516 <div align="right"><a href="#top">Up</a></div>
517 <hr />
518 </body></html>

Mercurial Repository: eric

eric ide

mercurial