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

branch
maintenance
changeset 7286
7eb04391adf7
parent 7226
babe80d84a3e
parent 7285
1ff497f33f31
child 7287
1c17f2191bdd
equal deleted inserted replaced
7226:babe80d84a3e 7286:7eb04391adf7
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Helpviewer.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><a NAME="top" ID="top"></a>
22 <h1>eric6.Helpviewer.FlashCookieManager.FlashCookieReader</h1>
23 <p>
24 Module implementing a class to read flash cookies.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#FlashCookieReader">FlashCookieReader</a></td>
34 <td>Class implementing a reader for flash cookies (*.sol files).</td>
35 </tr><tr>
36 <td><a href="#FlashCookieReaderError">FlashCookieReaderError</a></td>
37 <td>Class containing data of a reader error.</td>
38 </tr>
39 </table>
40 <h3>Functions</h3>
41 <table>
42 <tr><td>None</td></tr>
43 </table>
44 <hr /><hr />
45 <a NAME="FlashCookieReader" ID="FlashCookieReader"></a>
46 <h2>FlashCookieReader</h2>
47 <p>
48 Class implementing a reader for flash cookies (*.sol files).
49 </p>
50 <h3>Derived from</h3>
51 object
52 <h3>Class Attributes</h3>
53 <table>
54 <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>
55 </table>
56 <h3>Class Methods</h3>
57 <table>
58 <tr><td>None</td></tr>
59 </table>
60 <h3>Methods</h3>
61 <table>
62 <tr>
63 <td><a href="#FlashCookieReader.__init__">FlashCookieReader</a></td>
64 <td>Constructor</td>
65 </tr><tr>
66 <td><a href="#FlashCookieReader.__parseArray">__parseArray</a></td>
67 <td>Private method to parse an array.</td>
68 </tr><tr>
69 <td><a href="#FlashCookieReader.__parseBoolean">__parseBoolean</a></td>
70 <td>Private method to parse a boolean.</td>
71 </tr><tr>
72 <td><a href="#FlashCookieReader.__parseDate">__parseDate</a></td>
73 <td>Private method to parse a date.</td>
74 </tr><tr>
75 <td><a href="#FlashCookieReader.__parseNull">__parseNull</a></td>
76 <td>Private method to parse a null object.</td>
77 </tr><tr>
78 <td><a href="#FlashCookieReader.__parseNumber">__parseNumber</a></td>
79 <td>Private method to parse a number.</td>
80 </tr><tr>
81 <td><a href="#FlashCookieReader.__parseObject">__parseObject</a></td>
82 <td>Private method to parse an object.</td>
83 </tr><tr>
84 <td><a href="#FlashCookieReader.__parseOcc">__parseOcc</a></td>
85 <td>Private method to parse a c_object.</td>
86 </tr><tr>
87 <td><a href="#FlashCookieReader.__parseOjm">__parseOjm</a></td>
88 <td>Private method to parse an m_object.</td>
89 </tr><tr>
90 <td><a href="#FlashCookieReader.__parseString">__parseString</a></td>
91 <td>Private method to parse a string.</td>
92 </tr><tr>
93 <td><a href="#FlashCookieReader.__parseUndefined">__parseUndefined</a></td>
94 <td>Private method to parse an undefined object.</td>
95 </tr><tr>
96 <td><a href="#FlashCookieReader.__parseXml">__parseXml</a></td>
97 <td>Private method to parse XML.</td>
98 </tr><tr>
99 <td><a href="#FlashCookieReader.parse">parse</a></td>
100 <td>Public method to parse the sol file.</td>
101 </tr><tr>
102 <td><a href="#FlashCookieReader.setBytes">setBytes</a></td>
103 <td>Public method to set the contents of a sol file to be parsed.</td>
104 </tr><tr>
105 <td><a href="#FlashCookieReader.setFile">setFile</a></td>
106 <td>Public method to set an open sol file to be parsed.</td>
107 </tr><tr>
108 <td><a href="#FlashCookieReader.setFileName">setFileName</a></td>
109 <td>Public method to set the name of a sol file to be parsed.</td>
110 </tr><tr>
111 <td><a href="#FlashCookieReader.toString">toString</a></td>
112 <td>Public method to convert the parsed cookie to a string representation.</td>
113 </tr>
114 </table>
115 <h3>Static Methods</h3>
116 <table>
117 <tr><td>None</td></tr>
118 </table>
119 <a NAME="FlashCookieReader.__init__" ID="FlashCookieReader.__init__"></a>
120 <h4>FlashCookieReader (Constructor)</h4>
121 <b>FlashCookieReader</b>(<i></i>)
122 <p>
123 Constructor
124 </p><a NAME="FlashCookieReader.__parseArray" ID="FlashCookieReader.__parseArray"></a>
125 <h4>FlashCookieReader.__parseArray</h4>
126 <b>__parseArray</b>(<i>variableName, parent</i>)
127 <p>
128 Private method to parse an array.
129 </p><dl>
130 <dt><i>variableName</i> (str)</dt>
131 <dd>
132 name of the variable to be parsed
133 </dd><dt><i>parent</i> (dict)</dt>
134 <dd>
135 reference to the dictionary to insert the result into
136 </dd>
137 </dl><dl>
138 <dt>Raises <b>FlashCookieReaderError</b>:</dt>
139 <dd>
140 raised when an issue with the cookie
141 file is found
142 </dd>
143 </dl><a NAME="FlashCookieReader.__parseBoolean" ID="FlashCookieReader.__parseBoolean"></a>
144 <h4>FlashCookieReader.__parseBoolean</h4>
145 <b>__parseBoolean</b>(<i>variableName, parent</i>)
146 <p>
147 Private method to parse a boolean.
148 </p><dl>
149 <dt><i>variableName</i> (str)</dt>
150 <dd>
151 name of the variable to be parsed
152 </dd><dt><i>parent</i> (dict)</dt>
153 <dd>
154 reference to the dictionary to insert the result into
155 </dd>
156 </dl><a NAME="FlashCookieReader.__parseDate" ID="FlashCookieReader.__parseDate"></a>
157 <h4>FlashCookieReader.__parseDate</h4>
158 <b>__parseDate</b>(<i>variableName, parent</i>)
159 <p>
160 Private method to parse a date.
161 </p><dl>
162 <dt><i>variableName</i> (str)</dt>
163 <dd>
164 name of the variable to be parsed
165 </dd><dt><i>parent</i> (dict)</dt>
166 <dd>
167 reference to the dictionary to insert the result into
168 </dd>
169 </dl><a NAME="FlashCookieReader.__parseNull" ID="FlashCookieReader.__parseNull"></a>
170 <h4>FlashCookieReader.__parseNull</h4>
171 <b>__parseNull</b>(<i>variableName, parent</i>)
172 <p>
173 Private method to parse a null object.
174 </p><dl>
175 <dt><i>variableName</i> (str)</dt>
176 <dd>
177 name of the variable to be parsed
178 </dd><dt><i>parent</i> (dict)</dt>
179 <dd>
180 reference to the dictionary to insert the result into
181 </dd>
182 </dl><a NAME="FlashCookieReader.__parseNumber" ID="FlashCookieReader.__parseNumber"></a>
183 <h4>FlashCookieReader.__parseNumber</h4>
184 <b>__parseNumber</b>(<i>variableName, parent</i>)
185 <p>
186 Private method to parse a number.
187 </p><dl>
188 <dt><i>variableName</i> (str)</dt>
189 <dd>
190 name of the variable to be parsed
191 </dd><dt><i>parent</i> (dict)</dt>
192 <dd>
193 reference to the dictionary to insert the result into
194 </dd>
195 </dl><a NAME="FlashCookieReader.__parseObject" ID="FlashCookieReader.__parseObject"></a>
196 <h4>FlashCookieReader.__parseObject</h4>
197 <b>__parseObject</b>(<i>variableName, parent</i>)
198 <p>
199 Private method to parse an object.
200 </p><dl>
201 <dt><i>variableName</i> (str)</dt>
202 <dd>
203 name of the variable to be parsed
204 </dd><dt><i>parent</i> (dict)</dt>
205 <dd>
206 reference to the dictionary to insert the result into
207 </dd>
208 </dl><dl>
209 <dt>Raises <b>FlashCookieReaderError</b>:</dt>
210 <dd>
211 raised when an issue with the cookie
212 file is found
213 </dd>
214 </dl><a NAME="FlashCookieReader.__parseOcc" ID="FlashCookieReader.__parseOcc"></a>
215 <h4>FlashCookieReader.__parseOcc</h4>
216 <b>__parseOcc</b>(<i>variableName, parent</i>)
217 <p>
218 Private method to parse a c_object.
219 </p><dl>
220 <dt><i>variableName</i> (str)</dt>
221 <dd>
222 name of the variable to be parsed
223 </dd><dt><i>parent</i> (dict)</dt>
224 <dd>
225 reference to the dictionary to insert the result into
226 </dd>
227 </dl><dl>
228 <dt>Raises <b>FlashCookieReaderError</b>:</dt>
229 <dd>
230 raised when an issue with the cookie
231 file is found
232 </dd>
233 </dl><a NAME="FlashCookieReader.__parseOjm" ID="FlashCookieReader.__parseOjm"></a>
234 <h4>FlashCookieReader.__parseOjm</h4>
235 <b>__parseOjm</b>(<i>variableName, parent</i>)
236 <p>
237 Private method to parse an m_object.
238 </p><dl>
239 <dt><i>variableName</i> (str)</dt>
240 <dd>
241 name of the variable to be parsed
242 </dd><dt><i>parent</i> (dict)</dt>
243 <dd>
244 reference to the dictionary to insert the result into
245 </dd>
246 </dl><a NAME="FlashCookieReader.__parseString" ID="FlashCookieReader.__parseString"></a>
247 <h4>FlashCookieReader.__parseString</h4>
248 <b>__parseString</b>(<i>variableName, parent</i>)
249 <p>
250 Private method to parse a string.
251 </p><dl>
252 <dt><i>variableName</i> (str)</dt>
253 <dd>
254 name of the variable to be parsed
255 </dd><dt><i>parent</i> (dict)</dt>
256 <dd>
257 reference to the dictionary to insert the result into
258 </dd>
259 </dl><a NAME="FlashCookieReader.__parseUndefined" ID="FlashCookieReader.__parseUndefined"></a>
260 <h4>FlashCookieReader.__parseUndefined</h4>
261 <b>__parseUndefined</b>(<i>variableName, parent</i>)
262 <p>
263 Private method to parse an undefined object.
264 </p><dl>
265 <dt><i>variableName</i> (str)</dt>
266 <dd>
267 name of the variable to be parsed
268 </dd><dt><i>parent</i> (dict)</dt>
269 <dd>
270 reference to the dictionary to insert the result into
271 </dd>
272 </dl><a NAME="FlashCookieReader.__parseXml" ID="FlashCookieReader.__parseXml"></a>
273 <h4>FlashCookieReader.__parseXml</h4>
274 <b>__parseXml</b>(<i>variableName, parent</i>)
275 <p>
276 Private method to parse XML.
277 </p><dl>
278 <dt><i>variableName</i> (str)</dt>
279 <dd>
280 name of the variable to be parsed
281 </dd><dt><i>parent</i> (dict)</dt>
282 <dd>
283 reference to the dictionary to insert the result into
284 </dd>
285 </dl><a NAME="FlashCookieReader.parse" ID="FlashCookieReader.parse"></a>
286 <h4>FlashCookieReader.parse</h4>
287 <b>parse</b>(<i></i>)
288 <p>
289 Public method to parse the sol file.
290 </p><dl>
291 <dt>Raises <b>FlashCookieReaderError</b>:</dt>
292 <dd>
293 raised when encountering a parse
294 issue
295 </dd>
296 </dl><a NAME="FlashCookieReader.setBytes" ID="FlashCookieReader.setBytes"></a>
297 <h4>FlashCookieReader.setBytes</h4>
298 <b>setBytes</b>(<i>solData</i>)
299 <p>
300 Public method to set the contents of a sol file to be parsed.
301 </p><dl>
302 <dt><i>solData</i> (bytes)</dt>
303 <dd>
304 contents of the file
305 </dd>
306 </dl><a NAME="FlashCookieReader.setFile" ID="FlashCookieReader.setFile"></a>
307 <h4>FlashCookieReader.setFile</h4>
308 <b>setFile</b>(<i>solFile</i>)
309 <p>
310 Public method to set an open sol file to be parsed.
311 </p><dl>
312 <dt><i>solFile</i> (io.FileIO)</dt>
313 <dd>
314 sol file to be parsed
315 </dd>
316 </dl><a NAME="FlashCookieReader.setFileName" ID="FlashCookieReader.setFileName"></a>
317 <h4>FlashCookieReader.setFileName</h4>
318 <b>setFileName</b>(<i>solFilename</i>)
319 <p>
320 Public method to set the name of a sol file to be parsed.
321 </p><dl>
322 <dt><i>solFilename</i> (str)</dt>
323 <dd>
324 name of the sol file
325 </dd>
326 </dl><a NAME="FlashCookieReader.toString" ID="FlashCookieReader.toString"></a>
327 <h4>FlashCookieReader.toString</h4>
328 <b>toString</b>(<i>indent=0, parent=None</i>)
329 <p>
330 Public method to convert the parsed cookie to a string representation.
331 </p><dl>
332 <dt><i>indent</i> (int)</dt>
333 <dd>
334 indentation level
335 </dd><dt><i>parent</i> (dict)</dt>
336 <dd>
337 reference to the dictionary to be converted
338 </dd>
339 </dl><dl>
340 <dt>Returns:</dt>
341 <dd>
342 string representation of the cookie
343 </dd>
344 </dl><dl>
345 <dt>Return Type:</dt>
346 <dd>
347 str
348 </dd>
349 </dl>
350 <div align="right"><a href="#top">Up</a></div>
351 <hr /><hr />
352 <a NAME="FlashCookieReaderError" ID="FlashCookieReaderError"></a>
353 <h2>FlashCookieReaderError</h2>
354 <p>
355 Class containing data of a reader error.
356 </p>
357 <h3>Derived from</h3>
358 Exception
359 <h3>Class Attributes</h3>
360 <table>
361 <tr><td>None</td></tr>
362 </table>
363 <h3>Class Methods</h3>
364 <table>
365 <tr><td>None</td></tr>
366 </table>
367 <h3>Methods</h3>
368 <table>
369 <tr>
370 <td><a href="#FlashCookieReaderError.__init__">FlashCookieReaderError</a></td>
371 <td>Constructor</td>
372 </tr>
373 </table>
374 <h3>Static Methods</h3>
375 <table>
376 <tr><td>None</td></tr>
377 </table>
378 <a NAME="FlashCookieReaderError.__init__" ID="FlashCookieReaderError.__init__"></a>
379 <h4>FlashCookieReaderError (Constructor)</h4>
380 <b>FlashCookieReaderError</b>(<i>msg</i>)
381 <p>
382 Constructor
383 </p><dl>
384 <dt><i>msg</i> (str)</dt>
385 <dd>
386 error message
387 </dd>
388 </dl>
389 <div align="right"><a href="#top">Up</a></div>
390 <hr />
391 </body></html>

eric ide

mercurial