Mercurial Repositories > eric / file comparison

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

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

changeset 4368
a8f6c587c7aa
child 4370
54dbb658f9e6
equal deleted inserted replaced
4367:af2d7ceeb019 4368:a8f6c587c7aa
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><a NAME="FlashCookieReader.__parseBoolean" ID="FlashCookieReader.__parseBoolean"></a>
138 <h4>FlashCookieReader.__parseBoolean</h4>
139 <b>__parseBoolean</b>(<i>variableName, parent</i>)
140 <p>
141 Private method to parse a boolean.
142 </p><dl>
143 <dt><i>variableName</i> (str)</dt>
144 <dd>
145 name of the variable to be parsed
146 </dd><dt><i>parent</i> (dict)</dt>
147 <dd>
148 reference to the dictionary to insert the result into
149 </dd>
150 </dl><a NAME="FlashCookieReader.__parseDate" ID="FlashCookieReader.__parseDate"></a>
151 <h4>FlashCookieReader.__parseDate</h4>
152 <b>__parseDate</b>(<i>variableName, parent</i>)
153 <p>
154 Private method to parse a date.
155 </p><dl>
156 <dt><i>variableName</i> (str)</dt>
157 <dd>
158 name of the variable to be parsed
159 </dd><dt><i>parent</i> (dict)</dt>
160 <dd>
161 reference to the dictionary to insert the result into
162 </dd>
163 </dl><a NAME="FlashCookieReader.__parseNull" ID="FlashCookieReader.__parseNull"></a>
164 <h4>FlashCookieReader.__parseNull</h4>
165 <b>__parseNull</b>(<i>variableName, parent</i>)
166 <p>
167 Private method to parse a null object.
168 </p><dl>
169 <dt><i>variableName</i> (str)</dt>
170 <dd>
171 name of the variable to be parsed
172 </dd><dt><i>parent</i> (dict)</dt>
173 <dd>
174 reference to the dictionary to insert the result into
175 </dd>
176 </dl><a NAME="FlashCookieReader.__parseNumber" ID="FlashCookieReader.__parseNumber"></a>
177 <h4>FlashCookieReader.__parseNumber</h4>
178 <b>__parseNumber</b>(<i>variableName, parent</i>)
179 <p>
180 Private method to parse a number.
181 </p><dl>
182 <dt><i>variableName</i> (str)</dt>
183 <dd>
184 name of the variable to be parsed
185 </dd><dt><i>parent</i> (dict)</dt>
186 <dd>
187 reference to the dictionary to insert the result into
188 </dd>
189 </dl><a NAME="FlashCookieReader.__parseObject" ID="FlashCookieReader.__parseObject"></a>
190 <h4>FlashCookieReader.__parseObject</h4>
191 <b>__parseObject</b>(<i>variableName, parent</i>)
192 <p>
193 Private method to parse an object.
194 </p><dl>
195 <dt><i>variableName</i> (str)</dt>
196 <dd>
197 name of the variable to be parsed
198 </dd><dt><i>parent</i> (dict)</dt>
199 <dd>
200 reference to the dictionary to insert the result into
201 </dd>
202 </dl><a NAME="FlashCookieReader.__parseOcc" ID="FlashCookieReader.__parseOcc"></a>
203 <h4>FlashCookieReader.__parseOcc</h4>
204 <b>__parseOcc</b>(<i>variableName, parent</i>)
205 <p>
206 Private method to parse a c_object.
207 </p><dl>
208 <dt><i>variableName</i> (str)</dt>
209 <dd>
210 name of the variable to be parsed
211 </dd><dt><i>parent</i> (dict)</dt>
212 <dd>
213 reference to the dictionary to insert the result into
214 </dd>
215 </dl><a NAME="FlashCookieReader.__parseOjm" ID="FlashCookieReader.__parseOjm"></a>
216 <h4>FlashCookieReader.__parseOjm</h4>
217 <b>__parseOjm</b>(<i>variableName, parent</i>)
218 <p>
219 Private method to parse an m_object.
220 </p><dl>
221 <dt><i>variableName</i> (str)</dt>
222 <dd>
223 name of the variable to be parsed
224 </dd><dt><i>parent</i> (dict)</dt>
225 <dd>
226 reference to the dictionary to insert the result into
227 </dd>
228 </dl><a NAME="FlashCookieReader.__parseString" ID="FlashCookieReader.__parseString"></a>
229 <h4>FlashCookieReader.__parseString</h4>
230 <b>__parseString</b>(<i>variableName, parent</i>)
231 <p>
232 Private method to parse a string.
233 </p><dl>
234 <dt><i>variableName</i> (str)</dt>
235 <dd>
236 name of the variable to be parsed
237 </dd><dt><i>parent</i> (dict)</dt>
238 <dd>
239 reference to the dictionary to insert the result into
240 </dd>
241 </dl><a NAME="FlashCookieReader.__parseUndefined" ID="FlashCookieReader.__parseUndefined"></a>
242 <h4>FlashCookieReader.__parseUndefined</h4>
243 <b>__parseUndefined</b>(<i>variableName, parent</i>)
244 <p>
245 Private method to parse an undefined object.
246 </p><dl>
247 <dt><i>variableName</i> (str)</dt>
248 <dd>
249 name of the variable to be parsed
250 </dd><dt><i>parent</i> (dict)</dt>
251 <dd>
252 reference to the dictionary to insert the result into
253 </dd>
254 </dl><a NAME="FlashCookieReader.__parseXml" ID="FlashCookieReader.__parseXml"></a>
255 <h4>FlashCookieReader.__parseXml</h4>
256 <b>__parseXml</b>(<i>variableName, parent</i>)
257 <p>
258 Private method to parse XML.
259 </p><dl>
260 <dt><i>variableName</i> (str)</dt>
261 <dd>
262 name of the variable to be parsed
263 </dd><dt><i>parent</i> (dict)</dt>
264 <dd>
265 reference to the dictionary to insert the result into
266 </dd>
267 </dl><a NAME="FlashCookieReader.parse" ID="FlashCookieReader.parse"></a>
268 <h4>FlashCookieReader.parse</h4>
269 <b>parse</b>(<i></i>)
270 <p>
271 Public method to parse the sol file.
272 </p><dl>
273 <dt>Raises <b>FlashCookieReaderError</b>:</dt>
274 <dd>
275 raised when encountering a parse
276 issue
277 </dd>
278 </dl><a NAME="FlashCookieReader.setBytes" ID="FlashCookieReader.setBytes"></a>
279 <h4>FlashCookieReader.setBytes</h4>
280 <b>setBytes</b>(<i>solData</i>)
281 <p>
282 Public method to set the contents of a sol file to be parsed.
283 </p><dl>
284 <dt><i>solData</i> (bytes)</dt>
285 <dd>
286 contents of the file
287 </dd>
288 </dl><a NAME="FlashCookieReader.setFile" ID="FlashCookieReader.setFile"></a>
289 <h4>FlashCookieReader.setFile</h4>
290 <b>setFile</b>(<i>solFile</i>)
291 <p>
292 Public method to set an open sol file to be parsed.
293 </p><dl>
294 <dt><i>solFile</i> (io.FileIO)</dt>
295 <dd>
296 sol file to be parsed
297 </dd>
298 </dl><a NAME="FlashCookieReader.setFileName" ID="FlashCookieReader.setFileName"></a>
299 <h4>FlashCookieReader.setFileName</h4>
300 <b>setFileName</b>(<i>solFilename</i>)
301 <p>
302 Public method to set the name of a sol file to be parsed.
303 </p><dl>
304 <dt><i>solFilename</i> (str)</dt>
305 <dd>
306 name of the sol file
307 </dd>
308 </dl><a NAME="FlashCookieReader.toString" ID="FlashCookieReader.toString"></a>
309 <h4>FlashCookieReader.toString</h4>
310 <b>toString</b>(<i>indent=0, parent=None</i>)
311 <p>
312 Public method to convert the parsed cookie to a string representation.
313 </p><dl>
314 <dt><i>indent</i> (int)</dt>
315 <dd>
316 indentation level
317 </dd><dt><i>parent</i> (dict)</dt>
318 <dd>
319 reference to the dictionary to be converted
320 </dd>
321 </dl><dl>
322 <dt>Returns:</dt>
323 <dd>
324 string representation of the cookie
325 </dd>
326 </dl><dl>
327 <dt>Return Type:</dt>
328 <dd>
329 str
330 </dd>
331 </dl>
332 <div align="right"><a href="#top">Up</a></div>
333 <hr /><hr />
334 <a NAME="FlashCookieReaderError" ID="FlashCookieReaderError"></a>
335 <h2>FlashCookieReaderError</h2>
336 <p>
337 Class containing data of a reader error.
338 </p>
339 <h3>Derived from</h3>
340 Exception
341 <h3>Class Attributes</h3>
342 <table>
343 <tr><td>None</td></tr>
344 </table>
345 <h3>Class Methods</h3>
346 <table>
347 <tr><td>None</td></tr>
348 </table>
349 <h3>Methods</h3>
350 <table>
351 <tr>
352 <td><a href="#FlashCookieReaderError.__init__">FlashCookieReaderError</a></td>
353 <td>Constructor</td>
354 </tr>
355 </table>
356 <h3>Static Methods</h3>
357 <table>
358 <tr><td>None</td></tr>
359 </table>
360 <a NAME="FlashCookieReaderError.__init__" ID="FlashCookieReaderError.__init__"></a>
361 <h4>FlashCookieReaderError (Constructor)</h4>
362 <b>FlashCookieReaderError</b>(<i>msg</i>)
363 <p>
364 Constructor
365 </p><dl>
366 <dt><i>msg</i> (str)</dt>
367 <dd>
368 error message
369 </dd>
370 </dl>
371 <div align="right"><a href="#top">Up</a></div>
372 <hr />
373 </body></html>

Mercurial Repository: eric

eric ide

mercurial