Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.E5Network.E5TldExtractor.html

eric6/Documentation/Source/eric6.E5Network.E5TldExtractor.html

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7989
a21d673a8f99
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.E5Network.E5TldExtractor</h1> 23 <h1>eric6.E5Network.E5TldExtractor</h1>
24
23 <p> 25 <p>
24 Module implementing the TLD Extractor. 26 Module implementing the TLD Extractor.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>_TLDExtractor</td></tr> 31 <tr><td>_TLDExtractor</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#E5TldExtractor">E5TldExtractor</a></td> 38 <td><a href="#E5TldExtractor">E5TldExtractor</a></td>
34 <td>Class implementing the TLD Extractor.</td> 39 <td>Class implementing the TLD Extractor.</td>
35 </tr><tr> 40 </tr>
41 <tr>
36 <td><a href="#E5TldHostParts">E5TldHostParts</a></td> 42 <td><a href="#E5TldHostParts">E5TldHostParts</a></td>
37 <td>Class implementing the host parts helper.</td> 43 <td>Class implementing the host parts helper.</td>
38 </tr> 44 </tr>
39 </table> 45 </table>
40 <h3>Functions</h3> 46 <h3>Functions</h3>
41 <table> 47
48 <table>
49
42 <tr> 50 <tr>
43 <td><a href="#instance">instance</a></td> 51 <td><a href="#instance">instance</a></td>
44 <td>Global function to get a reference to the TLD extractor and create it, if it hasn't been yet.</td> 52 <td>Global function to get a reference to the TLD extractor and create it, if it hasn't been yet.</td>
45 </tr> 53 </tr>
46 </table> 54 </table>
47 <hr /><hr /> 55 <hr />
56 <hr />
48 <a NAME="E5TldExtractor" ID="E5TldExtractor"></a> 57 <a NAME="E5TldExtractor" ID="E5TldExtractor"></a>
49 <h2>E5TldExtractor</h2> 58 <h2>E5TldExtractor</h2>
59
50 <p> 60 <p>
51 Class implementing the TLD Extractor. 61 Class implementing the TLD Extractor.
52 </p><p> 62 </p>
63 <p>
53 Note: The module function instance() should be used to get a reference 64 Note: The module function instance() should be used to get a reference
54 to a global object to avoid overhead. 65 to a global object to avoid overhead.
55 </p> 66 </p>
56 <h3>Derived from</h3> 67 <h3>Derived from</h3>
57 QObject 68 QObject
58 <h3>Class Attributes</h3> 69 <h3>Class Attributes</h3>
70
59 <table> 71 <table>
60 <tr><td>None</td></tr> 72 <tr><td>None</td></tr>
61 </table> 73 </table>
62 <h3>Class Methods</h3> 74 <h3>Class Methods</h3>
75
63 <table> 76 <table>
64 <tr><td>None</td></tr> 77 <tr><td>None</td></tr>
65 </table> 78 </table>
66 <h3>Methods</h3> 79 <h3>Methods</h3>
67 <table> 80
81 <table>
82
68 <tr> 83 <tr>
69 <td><a href="#E5TldExtractor.__init__">E5TldExtractor</a></td> 84 <td><a href="#E5TldExtractor.__init__">E5TldExtractor</a></td>
70 <td>Constructor</td> 85 <td>Constructor</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#E5TldExtractor.__checkPublicSuffix">__checkPublicSuffix</a></td> 88 <td><a href="#E5TldExtractor.__checkPublicSuffix">__checkPublicSuffix</a></td>
73 <td>Private method to test a host name against a registrable name.</td> 89 <td>Private method to test a host name against a registrable name.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#E5TldExtractor.__defaultDataSearchPaths">__defaultDataSearchPaths</a></td> 92 <td><a href="#E5TldExtractor.__defaultDataSearchPaths">__defaultDataSearchPaths</a></td>
76 <td>Private method to get the default search paths for the TLD data file.</td> 93 <td>Private method to get the default search paths for the TLD data file.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#E5TldExtractor.__domainHelper">__domainHelper</a></td> 96 <td><a href="#E5TldExtractor.__domainHelper">__domainHelper</a></td>
79 <td>Private method to get the domain name without TLD.</td> 97 <td>Private method to get the domain name without TLD.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#E5TldExtractor.__loadData">__loadData</a></td> 100 <td><a href="#E5TldExtractor.__loadData">__loadData</a></td>
82 <td>Private method to load the TLD data.</td> 101 <td>Private method to load the TLD data.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#E5TldExtractor.__normalizedHost">__normalizedHost</a></td> 104 <td><a href="#E5TldExtractor.__normalizedHost">__normalizedHost</a></td>
85 <td>Private method to get the normalized host for a host address.</td> 105 <td>Private method to get the normalized host for a host address.</td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#E5TldExtractor.__parseData">__parseData</a></td> 108 <td><a href="#E5TldExtractor.__parseData">__parseData</a></td>
88 <td>Private method to parse TLD data.</td> 109 <td>Private method to parse TLD data.</td>
89 </tr><tr> 110 </tr>
111 <tr>
90 <td><a href="#E5TldExtractor.__registrableDomainHelper">__registrableDomainHelper</a></td> 112 <td><a href="#E5TldExtractor.__registrableDomainHelper">__registrableDomainHelper</a></td>
91 <td>Private method to get the registrable domain (i.e.</td> 113 <td>Private method to get the registrable domain (i.e.</td>
92 </tr><tr> 114 </tr>
115 <tr>
93 <td><a href="#E5TldExtractor.__subdomainHelper">__subdomainHelper</a></td> 116 <td><a href="#E5TldExtractor.__subdomainHelper">__subdomainHelper</a></td>
94 <td>Private method to get the subdomain of a host address (i.e.</td> 117 <td>Private method to get the subdomain of a host address (i.e.</td>
95 </tr><tr> 118 </tr>
119 <tr>
96 <td><a href="#E5TldExtractor.dataSearchPaths">dataSearchPaths</a></td> 120 <td><a href="#E5TldExtractor.dataSearchPaths">dataSearchPaths</a></td>
97 <td>Public method to get the search paths for the TLD data file.</td> 121 <td>Public method to get the search paths for the TLD data file.</td>
98 </tr><tr> 122 </tr>
123 <tr>
99 <td><a href="#E5TldExtractor.domain">domain</a></td> 124 <td><a href="#E5TldExtractor.domain">domain</a></td>
100 <td>Public method to get the domain for a host.</td> 125 <td>Public method to get the domain for a host.</td>
101 </tr><tr> 126 </tr>
127 <tr>
102 <td><a href="#E5TldExtractor.getTldDownloadUrl">getTldDownloadUrl</a></td> 128 <td><a href="#E5TldExtractor.getTldDownloadUrl">getTldDownloadUrl</a></td>
103 <td>Public method to get the TLD data file download URL.</td> 129 <td>Public method to get the TLD data file download URL.</td>
104 </tr><tr> 130 </tr>
131 <tr>
105 <td><a href="#E5TldExtractor.isDataLoaded">isDataLoaded</a></td> 132 <td><a href="#E5TldExtractor.isDataLoaded">isDataLoaded</a></td>
106 <td>Public method to check, if the TLD data ia already loaded.</td> 133 <td>Public method to check, if the TLD data ia already loaded.</td>
107 </tr><tr> 134 </tr>
135 <tr>
108 <td><a href="#E5TldExtractor.registrableDomain">registrableDomain</a></td> 136 <td><a href="#E5TldExtractor.registrableDomain">registrableDomain</a></td>
109 <td>Public method to get the registrable domain for a host.</td> 137 <td>Public method to get the registrable domain for a host.</td>
110 </tr><tr> 138 </tr>
139 <tr>
111 <td><a href="#E5TldExtractor.setDataSearchPaths">setDataSearchPaths</a></td> 140 <td><a href="#E5TldExtractor.setDataSearchPaths">setDataSearchPaths</a></td>
112 <td>Public method to set the search paths for the TLD data file.</td> 141 <td>Public method to set the search paths for the TLD data file.</td>
113 </tr><tr> 142 </tr>
143 <tr>
114 <td><a href="#E5TldExtractor.splitParts">splitParts</a></td> 144 <td><a href="#E5TldExtractor.splitParts">splitParts</a></td>
115 <td>Public method to split a host address into its parts.</td> 145 <td>Public method to split a host address into its parts.</td>
116 </tr><tr> 146 </tr>
147 <tr>
117 <td><a href="#E5TldExtractor.subdomain">subdomain</a></td> 148 <td><a href="#E5TldExtractor.subdomain">subdomain</a></td>
118 <td>Public method to get the subdomain for a host.</td> 149 <td>Public method to get the subdomain for a host.</td>
119 </tr><tr> 150 </tr>
151 <tr>
120 <td><a href="#E5TldExtractor.test">test</a></td> 152 <td><a href="#E5TldExtractor.test">test</a></td>
121 <td>Public method to execute the tests.</td> 153 <td>Public method to execute the tests.</td>
122 </tr><tr> 154 </tr>
155 <tr>
123 <td><a href="#E5TldExtractor.tld">tld</a></td> 156 <td><a href="#E5TldExtractor.tld">tld</a></td>
124 <td>Public method to get the top level domain for a host.</td> 157 <td>Public method to get the top level domain for a host.</td>
125 </tr> 158 </tr>
126 </table> 159 </table>
127 <h3>Static Methods</h3> 160 <h3>Static Methods</h3>
161
128 <table> 162 <table>
129 <tr><td>None</td></tr> 163 <tr><td>None</td></tr>
130 </table> 164 </table>
165
131 <a NAME="E5TldExtractor.__init__" ID="E5TldExtractor.__init__"></a> 166 <a NAME="E5TldExtractor.__init__" ID="E5TldExtractor.__init__"></a>
132 <h4>E5TldExtractor (Constructor)</h4> 167 <h4>E5TldExtractor (Constructor)</h4>
133 <b>E5TldExtractor</b>(<i>withPrivate=False, parent=None</i>) 168 <b>E5TldExtractor</b>(<i>withPrivate=False, parent=None</i>)
169
134 <p> 170 <p>
135 Constructor 171 Constructor
136 </p><dl> 172 </p>
173 <dl>
174
137 <dt><i>withPrivate</i> (bool)</dt> 175 <dt><i>withPrivate</i> (bool)</dt>
138 <dd> 176 <dd>
139 flag indicating to load private TLDs as well 177 flag indicating to load private TLDs as well
140 </dd><dt><i>parent</i> (QObject)</dt> 178 </dd>
179 <dt><i>parent</i> (QObject)</dt>
141 <dd> 180 <dd>
142 reference to the parent object 181 reference to the parent object
143 </dd> 182 </dd>
144 </dl><a NAME="E5TldExtractor.__checkPublicSuffix" ID="E5TldExtractor.__checkPublicSuffix"></a> 183 </dl>
184 <a NAME="E5TldExtractor.__checkPublicSuffix" ID="E5TldExtractor.__checkPublicSuffix"></a>
145 <h4>E5TldExtractor.__checkPublicSuffix</h4> 185 <h4>E5TldExtractor.__checkPublicSuffix</h4>
146 <b>__checkPublicSuffix</b>(<i>host, registrableName</i>) 186 <b>__checkPublicSuffix</b>(<i>host, registrableName</i>)
187
147 <p> 188 <p>
148 Private method to test a host name against a registrable name. 189 Private method to test a host name against a registrable name.
149 </p><dl> 190 </p>
191 <dl>
192
150 <dt><i>host</i> (str)</dt> 193 <dt><i>host</i> (str)</dt>
151 <dd> 194 <dd>
152 host name to test 195 host name to test
153 </dd><dt><i>registrableName</i> (str)</dt> 196 </dd>
197 <dt><i>registrableName</i> (str)</dt>
154 <dd> 198 <dd>
155 registrable domain name to test against 199 registrable domain name to test against
156 </dd> 200 </dd>
157 </dl><dl> 201 </dl>
202 <dl>
158 <dt>Returns:</dt> 203 <dt>Returns:</dt>
159 <dd> 204 <dd>
160 flag indicating the check result 205 flag indicating the check result
161 </dd> 206 </dd>
162 </dl><dl> 207 </dl>
208 <dl>
163 <dt>Return Type:</dt> 209 <dt>Return Type:</dt>
164 <dd> 210 <dd>
165 bool 211 bool
166 </dd> 212 </dd>
167 </dl><a NAME="E5TldExtractor.__defaultDataSearchPaths" ID="E5TldExtractor.__defaultDataSearchPaths"></a> 213 </dl>
214 <a NAME="E5TldExtractor.__defaultDataSearchPaths" ID="E5TldExtractor.__defaultDataSearchPaths"></a>
168 <h4>E5TldExtractor.__defaultDataSearchPaths</h4> 215 <h4>E5TldExtractor.__defaultDataSearchPaths</h4>
169 <b>__defaultDataSearchPaths</b>(<i></i>) 216 <b>__defaultDataSearchPaths</b>(<i></i>)
217
170 <p> 218 <p>
171 Private method to get the default search paths for the TLD data file. 219 Private method to get the default search paths for the TLD data file.
172 </p><dl> 220 </p>
221 <dl>
173 <dt>Returns:</dt> 222 <dt>Returns:</dt>
174 <dd> 223 <dd>
175 default search paths for the TLD data file 224 default search paths for the TLD data file
176 </dd> 225 </dd>
177 </dl><dl> 226 </dl>
227 <dl>
178 <dt>Return Type:</dt> 228 <dt>Return Type:</dt>
179 <dd> 229 <dd>
180 list of str 230 list of str
181 </dd> 231 </dd>
182 </dl><a NAME="E5TldExtractor.__domainHelper" ID="E5TldExtractor.__domainHelper"></a> 232 </dl>
233 <a NAME="E5TldExtractor.__domainHelper" ID="E5TldExtractor.__domainHelper"></a>
183 <h4>E5TldExtractor.__domainHelper</h4> 234 <h4>E5TldExtractor.__domainHelper</h4>
184 <b>__domainHelper</b>(<i>host, tldPart</i>) 235 <b>__domainHelper</b>(<i>host, tldPart</i>)
236
185 <p> 237 <p>
186 Private method to get the domain name without TLD. 238 Private method to get the domain name without TLD.
187 </p><dl> 239 </p>
240 <dl>
241
188 <dt><i>host</i> (str)</dt> 242 <dt><i>host</i> (str)</dt>
189 <dd> 243 <dd>
190 host address 244 host address
191 </dd><dt><i>tldPart</i> (str)</dt> 245 </dd>
246 <dt><i>tldPart</i> (str)</dt>
192 <dd> 247 <dd>
193 TLD part of the host address 248 TLD part of the host address
194 </dd> 249 </dd>
195 </dl><dl> 250 </dl>
251 <dl>
196 <dt>Returns:</dt> 252 <dt>Returns:</dt>
197 <dd> 253 <dd>
198 domain name 254 domain name
199 </dd> 255 </dd>
200 </dl><dl> 256 </dl>
201 <dt>Return Type:</dt> 257 <dl>
202 <dd> 258 <dt>Return Type:</dt>
203 str 259 <dd>
204 </dd> 260 str
205 </dl><a NAME="E5TldExtractor.__loadData" ID="E5TldExtractor.__loadData"></a> 261 </dd>
262 </dl>
263 <a NAME="E5TldExtractor.__loadData" ID="E5TldExtractor.__loadData"></a>
206 <h4>E5TldExtractor.__loadData</h4> 264 <h4>E5TldExtractor.__loadData</h4>
207 <b>__loadData</b>(<i></i>) 265 <b>__loadData</b>(<i></i>)
266
208 <p> 267 <p>
209 Private method to load the TLD data. 268 Private method to load the TLD data.
210 </p><a NAME="E5TldExtractor.__normalizedHost" ID="E5TldExtractor.__normalizedHost"></a> 269 </p>
270 <a NAME="E5TldExtractor.__normalizedHost" ID="E5TldExtractor.__normalizedHost"></a>
211 <h4>E5TldExtractor.__normalizedHost</h4> 271 <h4>E5TldExtractor.__normalizedHost</h4>
212 <b>__normalizedHost</b>(<i>host</i>) 272 <b>__normalizedHost</b>(<i>host</i>)
273
213 <p> 274 <p>
214 Private method to get the normalized host for a host address. 275 Private method to get the normalized host for a host address.
215 </p><dl> 276 </p>
277 <dl>
278
216 <dt><i>host</i> (str)</dt> 279 <dt><i>host</i> (str)</dt>
217 <dd> 280 <dd>
218 host address to be normalized 281 host address to be normalized
219 </dd> 282 </dd>
220 </dl><dl> 283 </dl>
284 <dl>
221 <dt>Returns:</dt> 285 <dt>Returns:</dt>
222 <dd> 286 <dd>
223 normalized host address 287 normalized host address
224 </dd> 288 </dd>
225 </dl><dl> 289 </dl>
226 <dt>Return Type:</dt> 290 <dl>
227 <dd> 291 <dt>Return Type:</dt>
228 str 292 <dd>
229 </dd> 293 str
230 </dl><a NAME="E5TldExtractor.__parseData" ID="E5TldExtractor.__parseData"></a> 294 </dd>
295 </dl>
296 <a NAME="E5TldExtractor.__parseData" ID="E5TldExtractor.__parseData"></a>
231 <h4>E5TldExtractor.__parseData</h4> 297 <h4>E5TldExtractor.__parseData</h4>
232 <b>__parseData</b>(<i>dataFile, loadPrivateDomains=False</i>) 298 <b>__parseData</b>(<i>dataFile, loadPrivateDomains=False</i>)
299
233 <p> 300 <p>
234 Private method to parse TLD data. 301 Private method to parse TLD data.
235 </p><dl> 302 </p>
303 <dl>
304
236 <dt><i>dataFile</i> (str)</dt> 305 <dt><i>dataFile</i> (str)</dt>
237 <dd> 306 <dd>
238 name of the file containing the TLD data 307 name of the file containing the TLD data
239 </dd><dt><i>loadPrivateDomains</i> (bool)</dt> 308 </dd>
309 <dt><i>loadPrivateDomains</i> (bool)</dt>
240 <dd> 310 <dd>
241 flag indicating to load private domains 311 flag indicating to load private domains
242 </dd> 312 </dd>
243 </dl><dl> 313 </dl>
314 <dl>
244 <dt>Returns:</dt> 315 <dt>Returns:</dt>
245 <dd> 316 <dd>
246 flag indicating success 317 flag indicating success
247 </dd> 318 </dd>
248 </dl><dl> 319 </dl>
320 <dl>
249 <dt>Return Type:</dt> 321 <dt>Return Type:</dt>
250 <dd> 322 <dd>
251 bool 323 bool
252 </dd> 324 </dd>
253 </dl><a NAME="E5TldExtractor.__registrableDomainHelper" ID="E5TldExtractor.__registrableDomainHelper"></a> 325 </dl>
326 <a NAME="E5TldExtractor.__registrableDomainHelper" ID="E5TldExtractor.__registrableDomainHelper"></a>
254 <h4>E5TldExtractor.__registrableDomainHelper</h4> 327 <h4>E5TldExtractor.__registrableDomainHelper</h4>
255 <b>__registrableDomainHelper</b>(<i>domainPart, tldPart</i>) 328 <b>__registrableDomainHelper</b>(<i>domainPart, tldPart</i>)
329
256 <p> 330 <p>
257 Private method to get the registrable domain (i.e. domain plus TLD). 331 Private method to get the registrable domain (i.e. domain plus TLD).
258 </p><dl> 332 </p>
333 <dl>
334
259 <dt><i>domainPart</i> (str)</dt> 335 <dt><i>domainPart</i> (str)</dt>
260 <dd> 336 <dd>
261 domain part of a host address 337 domain part of a host address
262 </dd><dt><i>tldPart</i> (str)</dt> 338 </dd>
339 <dt><i>tldPart</i> (str)</dt>
263 <dd> 340 <dd>
264 TLD part of a host address 341 TLD part of a host address
265 </dd> 342 </dd>
266 </dl><dl> 343 </dl>
344 <dl>
267 <dt>Returns:</dt> 345 <dt>Returns:</dt>
268 <dd> 346 <dd>
269 registrable domain name 347 registrable domain name
270 </dd> 348 </dd>
271 </dl><dl> 349 </dl>
272 <dt>Return Type:</dt> 350 <dl>
273 <dd> 351 <dt>Return Type:</dt>
274 str 352 <dd>
275 </dd> 353 str
276 </dl><a NAME="E5TldExtractor.__subdomainHelper" ID="E5TldExtractor.__subdomainHelper"></a> 354 </dd>
355 </dl>
356 <a NAME="E5TldExtractor.__subdomainHelper" ID="E5TldExtractor.__subdomainHelper"></a>
277 <h4>E5TldExtractor.__subdomainHelper</h4> 357 <h4>E5TldExtractor.__subdomainHelper</h4>
278 <b>__subdomainHelper</b>(<i>host, registrablePart</i>) 358 <b>__subdomainHelper</b>(<i>host, registrablePart</i>)
359
279 <p> 360 <p>
280 Private method to get the subdomain of a host address (i.e. domain part 361 Private method to get the subdomain of a host address (i.e. domain part
281 without the registrable domain name). 362 without the registrable domain name).
282 </p><dl> 363 </p>
364 <dl>
365
283 <dt><i>host</i> (str)</dt> 366 <dt><i>host</i> (str)</dt>
284 <dd> 367 <dd>
285 host address 368 host address
286 </dd><dt><i>registrablePart</i> (str)</dt> 369 </dd>
370 <dt><i>registrablePart</i> (str)</dt>
287 <dd> 371 <dd>
288 registrable domain part of the host address 372 registrable domain part of the host address
289 </dd> 373 </dd>
290 </dl><dl> 374 </dl>
375 <dl>
291 <dt>Returns:</dt> 376 <dt>Returns:</dt>
292 <dd> 377 <dd>
293 subdomain name 378 subdomain name
294 </dd> 379 </dd>
295 </dl><dl> 380 </dl>
296 <dt>Return Type:</dt> 381 <dl>
297 <dd> 382 <dt>Return Type:</dt>
298 str 383 <dd>
299 </dd> 384 str
300 </dl><a NAME="E5TldExtractor.dataSearchPaths" ID="E5TldExtractor.dataSearchPaths"></a> 385 </dd>
386 </dl>
387 <a NAME="E5TldExtractor.dataSearchPaths" ID="E5TldExtractor.dataSearchPaths"></a>
301 <h4>E5TldExtractor.dataSearchPaths</h4> 388 <h4>E5TldExtractor.dataSearchPaths</h4>
302 <b>dataSearchPaths</b>(<i></i>) 389 <b>dataSearchPaths</b>(<i></i>)
390
303 <p> 391 <p>
304 Public method to get the search paths for the TLD data file. 392 Public method to get the search paths for the TLD data file.
305 </p><dl> 393 </p>
394 <dl>
306 <dt>Returns:</dt> 395 <dt>Returns:</dt>
307 <dd> 396 <dd>
308 search paths for the TLD data file 397 search paths for the TLD data file
309 </dd> 398 </dd>
310 </dl><dl> 399 </dl>
400 <dl>
311 <dt>Return Type:</dt> 401 <dt>Return Type:</dt>
312 <dd> 402 <dd>
313 list of str 403 list of str
314 </dd> 404 </dd>
315 </dl><a NAME="E5TldExtractor.domain" ID="E5TldExtractor.domain"></a> 405 </dl>
406 <a NAME="E5TldExtractor.domain" ID="E5TldExtractor.domain"></a>
316 <h4>E5TldExtractor.domain</h4> 407 <h4>E5TldExtractor.domain</h4>
317 <b>domain</b>(<i>host</i>) 408 <b>domain</b>(<i>host</i>)
409
318 <p> 410 <p>
319 Public method to get the domain for a host. 411 Public method to get the domain for a host.
320 </p><dl> 412 </p>
413 <dl>
414
321 <dt><i>host</i> (str)</dt> 415 <dt><i>host</i> (str)</dt>
322 <dd> 416 <dd>
323 host name to get the domain for 417 host name to get the domain for
324 </dd> 418 </dd>
325 </dl><dl> 419 </dl>
420 <dl>
326 <dt>Returns:</dt> 421 <dt>Returns:</dt>
327 <dd> 422 <dd>
328 domain for host 423 domain for host
329 </dd> 424 </dd>
330 </dl><dl> 425 </dl>
331 <dt>Return Type:</dt> 426 <dl>
332 <dd> 427 <dt>Return Type:</dt>
333 str 428 <dd>
334 </dd> 429 str
335 </dl><a NAME="E5TldExtractor.getTldDownloadUrl" ID="E5TldExtractor.getTldDownloadUrl"></a> 430 </dd>
431 </dl>
432 <a NAME="E5TldExtractor.getTldDownloadUrl" ID="E5TldExtractor.getTldDownloadUrl"></a>
336 <h4>E5TldExtractor.getTldDownloadUrl</h4> 433 <h4>E5TldExtractor.getTldDownloadUrl</h4>
337 <b>getTldDownloadUrl</b>(<i></i>) 434 <b>getTldDownloadUrl</b>(<i></i>)
435
338 <p> 436 <p>
339 Public method to get the TLD data file download URL. 437 Public method to get the TLD data file download URL.
340 </p><dl> 438 </p>
439 <dl>
341 <dt>Returns:</dt> 440 <dt>Returns:</dt>
342 <dd> 441 <dd>
343 download URL 442 download URL
344 </dd> 443 </dd>
345 </dl><dl> 444 </dl>
445 <dl>
346 <dt>Return Type:</dt> 446 <dt>Return Type:</dt>
347 <dd> 447 <dd>
348 QUrl 448 QUrl
349 </dd> 449 </dd>
350 </dl><a NAME="E5TldExtractor.isDataLoaded" ID="E5TldExtractor.isDataLoaded"></a> 450 </dl>
451 <a NAME="E5TldExtractor.isDataLoaded" ID="E5TldExtractor.isDataLoaded"></a>
351 <h4>E5TldExtractor.isDataLoaded</h4> 452 <h4>E5TldExtractor.isDataLoaded</h4>
352 <b>isDataLoaded</b>(<i></i>) 453 <b>isDataLoaded</b>(<i></i>)
454
353 <p> 455 <p>
354 Public method to check, if the TLD data ia already loaded. 456 Public method to check, if the TLD data ia already loaded.
355 </p><dl> 457 </p>
458 <dl>
356 <dt>Returns:</dt> 459 <dt>Returns:</dt>
357 <dd> 460 <dd>
358 flag indicating data is loaded 461 flag indicating data is loaded
359 </dd> 462 </dd>
360 </dl><dl> 463 </dl>
464 <dl>
361 <dt>Return Type:</dt> 465 <dt>Return Type:</dt>
362 <dd> 466 <dd>
363 bool 467 bool
364 </dd> 468 </dd>
365 </dl><a NAME="E5TldExtractor.registrableDomain" ID="E5TldExtractor.registrableDomain"></a> 469 </dl>
470 <a NAME="E5TldExtractor.registrableDomain" ID="E5TldExtractor.registrableDomain"></a>
366 <h4>E5TldExtractor.registrableDomain</h4> 471 <h4>E5TldExtractor.registrableDomain</h4>
367 <b>registrableDomain</b>(<i>host</i>) 472 <b>registrableDomain</b>(<i>host</i>)
473
368 <p> 474 <p>
369 Public method to get the registrable domain for a host. 475 Public method to get the registrable domain for a host.
370 </p><dl> 476 </p>
477 <dl>
478
371 <dt><i>host</i> (str)</dt> 479 <dt><i>host</i> (str)</dt>
372 <dd> 480 <dd>
373 host name to get the registrable domain for 481 host name to get the registrable domain for
374 </dd> 482 </dd>
375 </dl><dl> 483 </dl>
484 <dl>
376 <dt>Returns:</dt> 485 <dt>Returns:</dt>
377 <dd> 486 <dd>
378 registrable domain for host 487 registrable domain for host
379 </dd> 488 </dd>
380 </dl><dl> 489 </dl>
381 <dt>Return Type:</dt> 490 <dl>
382 <dd> 491 <dt>Return Type:</dt>
383 str 492 <dd>
384 </dd> 493 str
385 </dl><a NAME="E5TldExtractor.setDataSearchPaths" ID="E5TldExtractor.setDataSearchPaths"></a> 494 </dd>
495 </dl>
496 <a NAME="E5TldExtractor.setDataSearchPaths" ID="E5TldExtractor.setDataSearchPaths"></a>
386 <h4>E5TldExtractor.setDataSearchPaths</h4> 497 <h4>E5TldExtractor.setDataSearchPaths</h4>
387 <b>setDataSearchPaths</b>(<i>searchPaths=None</i>) 498 <b>setDataSearchPaths</b>(<i>searchPaths=None</i>)
499
388 <p> 500 <p>
389 Public method to set the search paths for the TLD data file. 501 Public method to set the search paths for the TLD data file.
390 </p><dl> 502 </p>
503 <dl>
504
391 <dt><i>searchPaths</i> (list of str)</dt> 505 <dt><i>searchPaths</i> (list of str)</dt>
392 <dd> 506 <dd>
393 search paths for the TLD data file or None, 507 search paths for the TLD data file or None,
394 if the default search paths shall be set 508 if the default search paths shall be set
395 </dd> 509 </dd>
396 </dl><a NAME="E5TldExtractor.splitParts" ID="E5TldExtractor.splitParts"></a> 510 </dl>
511 <a NAME="E5TldExtractor.splitParts" ID="E5TldExtractor.splitParts"></a>
397 <h4>E5TldExtractor.splitParts</h4> 512 <h4>E5TldExtractor.splitParts</h4>
398 <b>splitParts</b>(<i>host</i>) 513 <b>splitParts</b>(<i>host</i>)
514
399 <p> 515 <p>
400 Public method to split a host address into its parts. 516 Public method to split a host address into its parts.
401 </p><dl> 517 </p>
518 <dl>
519
402 <dt><i>host</i> (str)</dt> 520 <dt><i>host</i> (str)</dt>
403 <dd> 521 <dd>
404 host address to be split 522 host address to be split
405 </dd> 523 </dd>
406 </dl><dl> 524 </dl>
525 <dl>
407 <dt>Returns:</dt> 526 <dt>Returns:</dt>
408 <dd> 527 <dd>
409 splitted host address 528 splitted host address
410 </dd> 529 </dd>
411 </dl><dl> 530 </dl>
531 <dl>
412 <dt>Return Type:</dt> 532 <dt>Return Type:</dt>
413 <dd> 533 <dd>
414 E5TldHostParts 534 E5TldHostParts
415 </dd> 535 </dd>
416 </dl><a NAME="E5TldExtractor.subdomain" ID="E5TldExtractor.subdomain"></a> 536 </dl>
537 <a NAME="E5TldExtractor.subdomain" ID="E5TldExtractor.subdomain"></a>
417 <h4>E5TldExtractor.subdomain</h4> 538 <h4>E5TldExtractor.subdomain</h4>
418 <b>subdomain</b>(<i>host</i>) 539 <b>subdomain</b>(<i>host</i>)
540
419 <p> 541 <p>
420 Public method to get the subdomain for a host. 542 Public method to get the subdomain for a host.
421 </p><dl> 543 </p>
544 <dl>
545
422 <dt><i>host</i> (str)</dt> 546 <dt><i>host</i> (str)</dt>
423 <dd> 547 <dd>
424 host name to get the subdomain for 548 host name to get the subdomain for
425 </dd> 549 </dd>
426 </dl><dl> 550 </dl>
551 <dl>
427 <dt>Returns:</dt> 552 <dt>Returns:</dt>
428 <dd> 553 <dd>
429 subdomain for host 554 subdomain for host
430 </dd> 555 </dd>
431 </dl><dl> 556 </dl>
432 <dt>Return Type:</dt> 557 <dl>
433 <dd> 558 <dt>Return Type:</dt>
434 str 559 <dd>
435 </dd> 560 str
436 </dl><a NAME="E5TldExtractor.test" ID="E5TldExtractor.test"></a> 561 </dd>
562 </dl>
563 <a NAME="E5TldExtractor.test" ID="E5TldExtractor.test"></a>
437 <h4>E5TldExtractor.test</h4> 564 <h4>E5TldExtractor.test</h4>
438 <b>test</b>(<i></i>) 565 <b>test</b>(<i></i>)
566
439 <p> 567 <p>
440 Public method to execute the tests. 568 Public method to execute the tests.
441 </p><dl> 569 </p>
570 <dl>
442 <dt>Returns:</dt> 571 <dt>Returns:</dt>
443 <dd> 572 <dd>
444 flag indicating the test result 573 flag indicating the test result
445 </dd> 574 </dd>
446 </dl><dl> 575 </dl>
576 <dl>
447 <dt>Return Type:</dt> 577 <dt>Return Type:</dt>
448 <dd> 578 <dd>
449 bool 579 bool
450 </dd> 580 </dd>
451 </dl><a NAME="E5TldExtractor.tld" ID="E5TldExtractor.tld"></a> 581 </dl>
582 <a NAME="E5TldExtractor.tld" ID="E5TldExtractor.tld"></a>
452 <h4>E5TldExtractor.tld</h4> 583 <h4>E5TldExtractor.tld</h4>
453 <b>tld</b>(<i>host</i>) 584 <b>tld</b>(<i>host</i>)
585
454 <p> 586 <p>
455 Public method to get the top level domain for a host. 587 Public method to get the top level domain for a host.
456 </p><dl> 588 </p>
589 <dl>
590
457 <dt><i>host</i> (str)</dt> 591 <dt><i>host</i> (str)</dt>
458 <dd> 592 <dd>
459 host name to get TLD for 593 host name to get TLD for
460 </dd> 594 </dd>
461 </dl><dl> 595 </dl>
596 <dl>
462 <dt>Returns:</dt> 597 <dt>Returns:</dt>
463 <dd> 598 <dd>
464 TLD for host 599 TLD for host
465 </dd> 600 </dd>
466 </dl><dl> 601 </dl>
602 <dl>
467 <dt>Return Type:</dt> 603 <dt>Return Type:</dt>
468 <dd> 604 <dd>
469 str 605 str
470 </dd> 606 </dd>
471 </dl> 607 </dl>
472 <div align="right"><a href="#top">Up</a></div> 608 <div align="right"><a href="#top">Up</a></div>
473 <hr /><hr /> 609 <hr />
610 <hr />
474 <a NAME="E5TldHostParts" ID="E5TldHostParts"></a> 611 <a NAME="E5TldHostParts" ID="E5TldHostParts"></a>
475 <h2>E5TldHostParts</h2> 612 <h2>E5TldHostParts</h2>
613
476 <p> 614 <p>
477 Class implementing the host parts helper. 615 Class implementing the host parts helper.
478 </p> 616 </p>
479 <h3>Derived from</h3> 617 <h3>Derived from</h3>
480 object 618 object
481 <h3>Class Attributes</h3> 619 <h3>Class Attributes</h3>
620
482 <table> 621 <table>
483 <tr><td>None</td></tr> 622 <tr><td>None</td></tr>
484 </table> 623 </table>
485 <h3>Class Methods</h3> 624 <h3>Class Methods</h3>
625
486 <table> 626 <table>
487 <tr><td>None</td></tr> 627 <tr><td>None</td></tr>
488 </table> 628 </table>
489 <h3>Methods</h3> 629 <h3>Methods</h3>
490 <table> 630
631 <table>
632
491 <tr> 633 <tr>
492 <td><a href="#E5TldHostParts.__init__">E5TldHostParts</a></td> 634 <td><a href="#E5TldHostParts.__init__">E5TldHostParts</a></td>
493 <td>Constructor</td> 635 <td>Constructor</td>
494 </tr> 636 </tr>
495 </table> 637 </table>
496 <h3>Static Methods</h3> 638 <h3>Static Methods</h3>
639
497 <table> 640 <table>
498 <tr><td>None</td></tr> 641 <tr><td>None</td></tr>
499 </table> 642 </table>
643
500 <a NAME="E5TldHostParts.__init__" ID="E5TldHostParts.__init__"></a> 644 <a NAME="E5TldHostParts.__init__" ID="E5TldHostParts.__init__"></a>
501 <h4>E5TldHostParts (Constructor)</h4> 645 <h4>E5TldHostParts (Constructor)</h4>
502 <b>E5TldHostParts</b>(<i></i>) 646 <b>E5TldHostParts</b>(<i></i>)
647
503 <p> 648 <p>
504 Constructor 649 Constructor
505 </p> 650 </p>
506 <div align="right"><a href="#top">Up</a></div> 651 <div align="right"><a href="#top">Up</a></div>
507 <hr /><hr /> 652 <hr />
653 <hr />
508 <a NAME="instance" ID="instance"></a> 654 <a NAME="instance" ID="instance"></a>
509 <h2>instance</h2> 655 <h2>instance</h2>
510 <b>instance</b>(<i>withPrivate=False</i>) 656 <b>instance</b>(<i>withPrivate=False</i>)
657
511 <p> 658 <p>
512 Global function to get a reference to the TLD extractor and create it, if 659 Global function to get a reference to the TLD extractor and create it, if
513 it hasn't been yet. 660 it hasn't been yet.
514 </p><dl> 661 </p>
662 <dl>
663
515 <dt><i>withPrivate</i> (bool)</dt> 664 <dt><i>withPrivate</i> (bool)</dt>
516 <dd> 665 <dd>
517 flag indicating to load private TLDs as well 666 flag indicating to load private TLDs as well
518 </dd> 667 </dd>
519 </dl><dl> 668 </dl>
669 <dl>
520 <dt>Returns:</dt> 670 <dt>Returns:</dt>
521 <dd> 671 <dd>
522 reference to the zoom manager object 672 reference to the zoom manager object
523 </dd> 673 </dd>
524 </dl><dl> 674 </dl>
675 <dl>
525 <dt>Return Type:</dt> 676 <dt>Return Type:</dt>
526 <dd> 677 <dd>
527 E5TldExtractor 678 E5TldExtractor
528 </dd> 679 </dd>
529 </dl> 680 </dl>

Mercurial Repository: eric

eric ide

mercurial