5 <link rel="stylesheet" href="styles.css"> |
5 <link rel="stylesheet" href="styles.css"> |
6 </head> |
6 </head> |
7 <body> |
7 <body> |
8 <a NAME="top" ID="top"></a> |
8 <a NAME="top" ID="top"></a> |
9 <h1>eric7.WebBrowser.SafeBrowsing.SafeBrowsingUrl</h1> |
9 <h1>eric7.WebBrowser.SafeBrowsing.SafeBrowsingUrl</h1> |
10 |
|
11 <p> |
10 <p> |
12 Module implementing an URL representation suitable for Google Safe Browsing. |
11 Module implementing an URL representation suitable for Google Safe Browsing. |
13 </p> |
12 </p> |
|
13 |
14 <h3>Global Attributes</h3> |
14 <h3>Global Attributes</h3> |
15 |
|
16 <table> |
15 <table> |
17 <tr><td>None</td></tr> |
16 <tr><td>None</td></tr> |
18 </table> |
17 </table> |
|
18 |
19 <h3>Classes</h3> |
19 <h3>Classes</h3> |
20 |
20 <table> |
21 <table> |
|
22 |
|
23 <tr> |
21 <tr> |
24 <td><a href="#SafeBrowsingUrl">SafeBrowsingUrl</a></td> |
22 <td><a href="#SafeBrowsingUrl">SafeBrowsingUrl</a></td> |
25 <td>Class implementing an URL representation suitable for Google Safe Browsing.</td> |
23 <td>Class implementing an URL representation suitable for Google Safe Browsing.</td> |
26 </tr> |
24 </tr> |
27 </table> |
25 </table> |
|
26 |
28 <h3>Functions</h3> |
27 <h3>Functions</h3> |
29 |
|
30 <table> |
28 <table> |
31 <tr><td>None</td></tr> |
29 <tr><td>None</td></tr> |
32 </table> |
30 </table> |
|
31 |
33 <hr /> |
32 <hr /> |
34 <hr /> |
33 <hr /> |
35 <a NAME="SafeBrowsingUrl" ID="SafeBrowsingUrl"></a> |
34 <a NAME="SafeBrowsingUrl" ID="SafeBrowsingUrl"></a> |
36 <h2>SafeBrowsingUrl</h2> |
35 <h2>SafeBrowsingUrl</h2> |
37 |
|
38 <p> |
36 <p> |
39 Class implementing an URL representation suitable for Google Safe Browsing. |
37 Class implementing an URL representation suitable for Google Safe Browsing. |
40 </p> |
38 </p> |
|
39 |
41 <h3>Derived from</h3> |
40 <h3>Derived from</h3> |
42 None |
41 None |
43 <h3>Class Attributes</h3> |
42 <h3>Class Attributes</h3> |
44 |
|
45 <table> |
43 <table> |
46 <tr><td>None</td></tr> |
44 <tr><td>None</td></tr> |
47 </table> |
45 </table> |
|
46 |
48 <h3>Class Methods</h3> |
47 <h3>Class Methods</h3> |
49 |
|
50 <table> |
48 <table> |
51 <tr><td>None</td></tr> |
49 <tr><td>None</td></tr> |
52 </table> |
50 </table> |
|
51 |
53 <h3>Methods</h3> |
52 <h3>Methods</h3> |
54 |
53 <table> |
55 <table> |
|
56 |
|
57 <tr> |
54 <tr> |
58 <td><a href="#SafeBrowsingUrl.__init__">SafeBrowsingUrl</a></td> |
55 <td><a href="#SafeBrowsingUrl.__init__">SafeBrowsingUrl</a></td> |
59 <td>Constructor</td> |
56 <td>Constructor</td> |
60 </tr> |
57 </tr> |
61 <tr> |
58 <tr> |
81 <tr> |
78 <tr> |
82 <td><a href="#SafeBrowsingUrl.quote">quote</a></td> |
79 <td><a href="#SafeBrowsingUrl.quote">quote</a></td> |
83 <td>Method to quote a string.</td> |
80 <td>Method to quote a string.</td> |
84 </tr> |
81 </tr> |
85 </table> |
82 </table> |
|
83 |
86 <h3>Static Methods</h3> |
84 <h3>Static Methods</h3> |
87 |
85 <table> |
88 <table> |
|
89 |
|
90 <tr> |
86 <tr> |
91 <td><a href="#SafeBrowsingUrl.digest">digest</a></td> |
87 <td><a href="#SafeBrowsingUrl.digest">digest</a></td> |
92 <td>Static method to calculate the SHA256 digest of an URL string.</td> |
88 <td>Static method to calculate the SHA256 digest of an URL string.</td> |
93 </tr> |
89 </tr> |
94 <tr> |
90 <tr> |
95 <td><a href="#SafeBrowsingUrl.permutations">permutations</a></td> |
91 <td><a href="#SafeBrowsingUrl.permutations">permutations</a></td> |
96 <td>Static method to determine all permutations of host name and path which can be applied to blacklisted URLs.</td> |
92 <td>Static method to determine all permutations of host name and path which can be applied to blacklisted URLs.</td> |
97 </tr> |
93 </tr> |
98 </table> |
94 </table> |
|
95 |
99 |
96 |
100 <a NAME="SafeBrowsingUrl.__init__" ID="SafeBrowsingUrl.__init__"></a> |
97 <a NAME="SafeBrowsingUrl.__init__" ID="SafeBrowsingUrl.__init__"></a> |
101 <h4>SafeBrowsingUrl (Constructor)</h4> |
98 <h4>SafeBrowsingUrl (Constructor)</h4> |
102 <b>SafeBrowsingUrl</b>(<i>url</i>) |
99 <b>SafeBrowsingUrl</b>(<i>url</i>) |
103 |
|
104 <p> |
100 <p> |
105 Constructor |
101 Constructor |
106 </p> |
102 </p> |
|
103 |
107 <dl> |
104 <dl> |
108 |
105 |
109 <dt><i>url</i> (str)</dt> |
106 <dt><i>url</i> (str)</dt> |
110 <dd> |
107 <dd> |
111 URL to be embedded |
108 URL to be embedded |
112 </dd> |
109 </dd> |
113 </dl> |
110 </dl> |
114 <a NAME="SafeBrowsingUrl.canonical" ID="SafeBrowsingUrl.canonical"></a> |
111 <a NAME="SafeBrowsingUrl.canonical" ID="SafeBrowsingUrl.canonical"></a> |
115 <h4>SafeBrowsingUrl.canonical</h4> |
112 <h4>SafeBrowsingUrl.canonical</h4> |
116 <b>canonical</b>(<i></i>) |
113 <b>canonical</b>(<i></i>) |
117 |
|
118 <p> |
114 <p> |
119 Public method to convert the URL to the canonical form. |
115 Public method to convert the URL to the canonical form. |
120 </p> |
116 </p> |
|
117 |
121 <dl> |
118 <dl> |
122 <dt>Return:</dt> |
119 <dt>Return:</dt> |
123 <dd> |
120 <dd> |
124 canonical form of the URL |
121 canonical form of the URL |
125 </dd> |
122 </dd> |
131 </dd> |
128 </dd> |
132 </dl> |
129 </dl> |
133 <a NAME="SafeBrowsingUrl.fullUnescape" ID="SafeBrowsingUrl.fullUnescape"></a> |
130 <a NAME="SafeBrowsingUrl.fullUnescape" ID="SafeBrowsingUrl.fullUnescape"></a> |
134 <h4>SafeBrowsingUrl.fullUnescape</h4> |
131 <h4>SafeBrowsingUrl.fullUnescape</h4> |
135 <b>fullUnescape</b>(<i></i>) |
132 <b>fullUnescape</b>(<i></i>) |
136 |
|
137 <p> |
133 <p> |
138 Method to recursively unescape an URL. |
134 Method to recursively unescape an URL. |
139 </p> |
135 </p> |
|
136 |
140 <dl> |
137 <dl> |
141 |
138 |
142 <dt><i>u</i> (str)</dt> |
139 <dt><i>u</i> (str)</dt> |
143 <dd> |
140 <dd> |
144 URL string to unescape |
141 URL string to unescape |
177 </dd> |
174 </dd> |
178 </dl> |
175 </dl> |
179 <a NAME="SafeBrowsingUrl.hostPermutations" ID="SafeBrowsingUrl.hostPermutations"></a> |
176 <a NAME="SafeBrowsingUrl.hostPermutations" ID="SafeBrowsingUrl.hostPermutations"></a> |
180 <h4>SafeBrowsingUrl.hostPermutations</h4> |
177 <h4>SafeBrowsingUrl.hostPermutations</h4> |
181 <b>hostPermutations</b>(<i></i>) |
178 <b>hostPermutations</b>(<i></i>) |
182 |
|
183 <p> |
179 <p> |
184 Method to generate the permutations of the host name. |
180 Method to generate the permutations of the host name. |
185 </p> |
181 </p> |
|
182 |
186 <dl> |
183 <dl> |
187 |
184 |
188 <dt><i>host</i> (str)</dt> |
185 <dt><i>host</i> (str)</dt> |
189 <dd> |
186 <dd> |
190 host name |
187 host name |
203 </dd> |
200 </dd> |
204 </dl> |
201 </dl> |
205 <a NAME="SafeBrowsingUrl.pathPermutations" ID="SafeBrowsingUrl.pathPermutations"></a> |
202 <a NAME="SafeBrowsingUrl.pathPermutations" ID="SafeBrowsingUrl.pathPermutations"></a> |
206 <h4>SafeBrowsingUrl.pathPermutations</h4> |
203 <h4>SafeBrowsingUrl.pathPermutations</h4> |
207 <b>pathPermutations</b>(<i></i>) |
204 <b>pathPermutations</b>(<i></i>) |
208 |
|
209 <p> |
205 <p> |
210 Method to generate the permutations of the path. |
206 Method to generate the permutations of the path. |
211 </p> |
207 </p> |
|
208 |
212 <dl> |
209 <dl> |
213 |
210 |
214 <dt><i>path</i> (str)</dt> |
211 <dt><i>path</i> (str)</dt> |
215 <dd> |
212 <dd> |
216 path to be processed |
213 path to be processed |
229 </dd> |
226 </dd> |
230 </dl> |
227 </dl> |
231 <a NAME="SafeBrowsingUrl.quote" ID="SafeBrowsingUrl.quote"></a> |
228 <a NAME="SafeBrowsingUrl.quote" ID="SafeBrowsingUrl.quote"></a> |
232 <h4>SafeBrowsingUrl.quote</h4> |
229 <h4>SafeBrowsingUrl.quote</h4> |
233 <b>quote</b>(<i></i>) |
230 <b>quote</b>(<i></i>) |
234 |
|
235 <p> |
231 <p> |
236 Method to quote a string. |
232 Method to quote a string. |
237 </p> |
233 </p> |
|
234 |
238 <dl> |
235 <dl> |
239 |
236 |
240 <dt><i>string</i> (str)</dt> |
237 <dt><i>string</i> (str)</dt> |
241 <dd> |
238 <dd> |
242 to be quoted |
239 to be quoted |
255 </dd> |
252 </dd> |
256 </dl> |
253 </dl> |
257 <a NAME="SafeBrowsingUrl.digest" ID="SafeBrowsingUrl.digest"></a> |
254 <a NAME="SafeBrowsingUrl.digest" ID="SafeBrowsingUrl.digest"></a> |
258 <h4>SafeBrowsingUrl.digest (static)</h4> |
255 <h4>SafeBrowsingUrl.digest (static)</h4> |
259 <b>digest</b>(<i></i>) |
256 <b>digest</b>(<i></i>) |
260 |
|
261 <p> |
257 <p> |
262 Static method to calculate the SHA256 digest of an URL string. |
258 Static method to calculate the SHA256 digest of an URL string. |
263 </p> |
259 </p> |
|
260 |
264 <dl> |
261 <dl> |
265 |
262 |
266 <dt><i>url</i> (str)</dt> |
263 <dt><i>url</i> (str)</dt> |
267 <dd> |
264 <dd> |
268 URL string |
265 URL string |
281 </dd> |
278 </dd> |
282 </dl> |
279 </dl> |
283 <a NAME="SafeBrowsingUrl.permutations" ID="SafeBrowsingUrl.permutations"></a> |
280 <a NAME="SafeBrowsingUrl.permutations" ID="SafeBrowsingUrl.permutations"></a> |
284 <h4>SafeBrowsingUrl.permutations (static)</h4> |
281 <h4>SafeBrowsingUrl.permutations (static)</h4> |
285 <b>permutations</b>(<i></i>) |
282 <b>permutations</b>(<i></i>) |
286 |
|
287 <p> |
283 <p> |
288 Static method to determine all permutations of host name and path |
284 Static method to determine all permutations of host name and path |
289 which can be applied to blacklisted URLs. |
285 which can be applied to blacklisted URLs. |
290 </p> |
286 </p> |
|
287 |
291 <dl> |
288 <dl> |
292 |
289 |
293 <dt><i>url</i> (str)</dt> |
290 <dt><i>url</i> (str)</dt> |
294 <dd> |
291 <dd> |
295 URL string to be permuted |
292 URL string to be permuted |