eric6/Documentation/Source/eric6.PipInterface.PipPackageDetailsDialog.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.PipInterface.PipPackageDetailsDialog</h1> 23 <h1>eric6.PipInterface.PipPackageDetailsDialog</h1>
24
23 <p> 25 <p>
24 Module implementing a dialog to show details about a package. 26 Module implementing a dialog to show details about a package.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</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="#PipPackageDetailsDialog">PipPackageDetailsDialog</a></td> 38 <td><a href="#PipPackageDetailsDialog">PipPackageDetailsDialog</a></td>
34 <td>Class implementing a dialog to show details about a package.</td> 39 <td>Class implementing a dialog to show details about a package.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
38 <table> 43
39 <tr><td>None</td></tr> 44 <table>
40 </table> 45 <tr><td>None</td></tr>
41 <hr /><hr /> 46 </table>
47 <hr />
48 <hr />
42 <a NAME="PipPackageDetailsDialog" ID="PipPackageDetailsDialog"></a> 49 <a NAME="PipPackageDetailsDialog" ID="PipPackageDetailsDialog"></a>
43 <h2>PipPackageDetailsDialog</h2> 50 <h2>PipPackageDetailsDialog</h2>
51
44 <p> 52 <p>
45 Class implementing a dialog to show details about a package. 53 Class implementing a dialog to show details about a package.
46 </p> 54 </p>
47 <h3>Derived from</h3> 55 <h3>Derived from</h3>
48 QDialog, Ui_PipPackageDetailsDialog 56 QDialog, Ui_PipPackageDetailsDialog
49 <h3>Class Attributes</h3> 57 <h3>Class Attributes</h3>
58
50 <table> 59 <table>
51 <tr><td>None</td></tr> 60 <tr><td>None</td></tr>
52 </table> 61 </table>
53 <h3>Class Methods</h3> 62 <h3>Class Methods</h3>
63
54 <table> 64 <table>
55 <tr><td>None</td></tr> 65 <tr><td>None</td></tr>
56 </table> 66 </table>
57 <h3>Methods</h3> 67 <h3>Methods</h3>
58 <table> 68
69 <table>
70
59 <tr> 71 <tr>
60 <td><a href="#PipPackageDetailsDialog.__init__">PipPackageDetailsDialog</a></td> 72 <td><a href="#PipPackageDetailsDialog.__init__">PipPackageDetailsDialog</a></td>
61 <td>Constructor</td> 73 <td>Constructor</td>
62 </tr><tr> 74 </tr>
75 <tr>
63 <td><a href="#PipPackageDetailsDialog.__formatSize">__formatSize</a></td> 76 <td><a href="#PipPackageDetailsDialog.__formatSize">__formatSize</a></td>
64 <td>Private slot to format the size.</td> 77 <td>Private slot to format the size.</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#PipPackageDetailsDialog.__formatUploadDate">__formatUploadDate</a></td> 80 <td><a href="#PipPackageDetailsDialog.__formatUploadDate">__formatUploadDate</a></td>
67 <td>Private method to format the upload date.</td> 81 <td>Private method to format the upload date.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#PipPackageDetailsDialog.__populateDetails">__populateDetails</a></td> 84 <td><a href="#PipPackageDetailsDialog.__populateDetails">__populateDetails</a></td>
70 <td>Private method to populate the details tab.</td> 85 <td>Private method to populate the details tab.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#PipPackageDetailsDialog.__populateDownloadUrls">__populateDownloadUrls</a></td> 88 <td><a href="#PipPackageDetailsDialog.__populateDownloadUrls">__populateDownloadUrls</a></td>
73 <td>Private method to populate the download URLs tab.</td> 89 <td>Private method to populate the download URLs tab.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#PipPackageDetailsDialog.__populateRequiresProvides">__populateRequiresProvides</a></td> 92 <td><a href="#PipPackageDetailsDialog.__populateRequiresProvides">__populateRequiresProvides</a></td>
76 <td>Private method to populate the requires/provides tab.</td> 93 <td>Private method to populate the requires/provides tab.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#PipPackageDetailsDialog.__sanitize">__sanitize</a></td> 96 <td><a href="#PipPackageDetailsDialog.__sanitize">__sanitize</a></td>
79 <td>Private method to clean-up the given text.</td> 97 <td>Private method to clean-up the given text.</td>
80 </tr> 98 </tr>
81 </table> 99 </table>
82 <h3>Static Methods</h3> 100 <h3>Static Methods</h3>
83 <table> 101
84 <tr><td>None</td></tr> 102 <table>
85 </table> 103 <tr><td>None</td></tr>
104 </table>
105
86 <a NAME="PipPackageDetailsDialog.__init__" ID="PipPackageDetailsDialog.__init__"></a> 106 <a NAME="PipPackageDetailsDialog.__init__" ID="PipPackageDetailsDialog.__init__"></a>
87 <h4>PipPackageDetailsDialog (Constructor)</h4> 107 <h4>PipPackageDetailsDialog (Constructor)</h4>
88 <b>PipPackageDetailsDialog</b>(<i>detailsData, parent=None</i>) 108 <b>PipPackageDetailsDialog</b>(<i>detailsData, parent=None</i>)
109
89 <p> 110 <p>
90 Constructor 111 Constructor
91 </p><dl> 112 </p>
113 <dl>
114
92 <dt><i>detailsData</i> (dict)</dt> 115 <dt><i>detailsData</i> (dict)</dt>
93 <dd> 116 <dd>
94 package details 117 package details
95 </dd><dt><i>parent</i> (QWidget)</dt> 118 </dd>
119 <dt><i>parent</i> (QWidget)</dt>
96 <dd> 120 <dd>
97 reference to the parent widget 121 reference to the parent widget
98 </dd> 122 </dd>
99 </dl><a NAME="PipPackageDetailsDialog.__formatSize" ID="PipPackageDetailsDialog.__formatSize"></a> 123 </dl>
124 <a NAME="PipPackageDetailsDialog.__formatSize" ID="PipPackageDetailsDialog.__formatSize"></a>
100 <h4>PipPackageDetailsDialog.__formatSize</h4> 125 <h4>PipPackageDetailsDialog.__formatSize</h4>
101 <b>__formatSize</b>(<i>size</i>) 126 <b>__formatSize</b>(<i>size</i>)
127
102 <p> 128 <p>
103 Private slot to format the size. 129 Private slot to format the size.
104 </p><dl> 130 </p>
131 <dl>
132
105 <dt><i>size</i> (int)</dt> 133 <dt><i>size</i> (int)</dt>
106 <dd> 134 <dd>
107 size to be formatted 135 size to be formatted
108 </dd> 136 </dd>
109 </dl><dl> 137 </dl>
138 <dl>
110 <dt>Returns:</dt> 139 <dt>Returns:</dt>
111 <dd> 140 <dd>
112 formatted size 141 formatted size
113 </dd> 142 </dd>
114 </dl><dl> 143 </dl>
144 <dl>
115 <dt>Return Type:</dt> 145 <dt>Return Type:</dt>
116 <dd> 146 <dd>
117 str 147 str
118 </dd> 148 </dd>
119 </dl><a NAME="PipPackageDetailsDialog.__formatUploadDate" ID="PipPackageDetailsDialog.__formatUploadDate"></a> 149 </dl>
150 <a NAME="PipPackageDetailsDialog.__formatUploadDate" ID="PipPackageDetailsDialog.__formatUploadDate"></a>
120 <h4>PipPackageDetailsDialog.__formatUploadDate</h4> 151 <h4>PipPackageDetailsDialog.__formatUploadDate</h4>
121 <b>__formatUploadDate</b>(<i>datetime</i>) 152 <b>__formatUploadDate</b>(<i>datetime</i>)
153
122 <p> 154 <p>
123 Private method to format the upload date. 155 Private method to format the upload date.
124 </p><dl> 156 </p>
157 <dl>
158
125 <dt><i>datetime</i> (xmlrpc.DateTime or str)</dt> 159 <dt><i>datetime</i> (xmlrpc.DateTime or str)</dt>
126 <dd> 160 <dd>
127 upload date and time 161 upload date and time
128 </dd> 162 </dd>
129 </dl><dl> 163 </dl>
164 <dl>
130 <dt>Returns:</dt> 165 <dt>Returns:</dt>
131 <dd> 166 <dd>
132 formatted date string 167 formatted date string
133 </dd> 168 </dd>
134 </dl><dl> 169 </dl>
170 <dl>
135 <dt>Return Type:</dt> 171 <dt>Return Type:</dt>
136 <dd> 172 <dd>
137 str 173 str
138 </dd> 174 </dd>
139 </dl><a NAME="PipPackageDetailsDialog.__populateDetails" ID="PipPackageDetailsDialog.__populateDetails"></a> 175 </dl>
176 <a NAME="PipPackageDetailsDialog.__populateDetails" ID="PipPackageDetailsDialog.__populateDetails"></a>
140 <h4>PipPackageDetailsDialog.__populateDetails</h4> 177 <h4>PipPackageDetailsDialog.__populateDetails</h4>
141 <b>__populateDetails</b>(<i>detailsData</i>) 178 <b>__populateDetails</b>(<i>detailsData</i>)
179
142 <p> 180 <p>
143 Private method to populate the details tab. 181 Private method to populate the details tab.
144 </p><dl> 182 </p>
183 <dl>
184
145 <dt><i>detailsData</i> (dict)</dt> 185 <dt><i>detailsData</i> (dict)</dt>
146 <dd> 186 <dd>
147 package details 187 package details
148 </dd> 188 </dd>
149 </dl><a NAME="PipPackageDetailsDialog.__populateDownloadUrls" ID="PipPackageDetailsDialog.__populateDownloadUrls"></a> 189 </dl>
190 <a NAME="PipPackageDetailsDialog.__populateDownloadUrls" ID="PipPackageDetailsDialog.__populateDownloadUrls"></a>
150 <h4>PipPackageDetailsDialog.__populateDownloadUrls</h4> 191 <h4>PipPackageDetailsDialog.__populateDownloadUrls</h4>
151 <b>__populateDownloadUrls</b>(<i>downloadsData</i>) 192 <b>__populateDownloadUrls</b>(<i>downloadsData</i>)
193
152 <p> 194 <p>
153 Private method to populate the download URLs tab. 195 Private method to populate the download URLs tab.
154 </p><dl> 196 </p>
197 <dl>
198
155 <dt><i>downloadsData</i> (dict)</dt> 199 <dt><i>downloadsData</i> (dict)</dt>
156 <dd> 200 <dd>
157 downloads information 201 downloads information
158 </dd> 202 </dd>
159 </dl><a NAME="PipPackageDetailsDialog.__populateRequiresProvides" ID="PipPackageDetailsDialog.__populateRequiresProvides"></a> 203 </dl>
204 <a NAME="PipPackageDetailsDialog.__populateRequiresProvides" ID="PipPackageDetailsDialog.__populateRequiresProvides"></a>
160 <h4>PipPackageDetailsDialog.__populateRequiresProvides</h4> 205 <h4>PipPackageDetailsDialog.__populateRequiresProvides</h4>
161 <b>__populateRequiresProvides</b>(<i>detailsData</i>) 206 <b>__populateRequiresProvides</b>(<i>detailsData</i>)
207
162 <p> 208 <p>
163 Private method to populate the requires/provides tab. 209 Private method to populate the requires/provides tab.
164 </p><dl> 210 </p>
211 <dl>
212
165 <dt><i>detailsData</i> (dict)</dt> 213 <dt><i>detailsData</i> (dict)</dt>
166 <dd> 214 <dd>
167 package details 215 package details
168 </dd> 216 </dd>
169 </dl><a NAME="PipPackageDetailsDialog.__sanitize" ID="PipPackageDetailsDialog.__sanitize"></a> 217 </dl>
218 <a NAME="PipPackageDetailsDialog.__sanitize" ID="PipPackageDetailsDialog.__sanitize"></a>
170 <h4>PipPackageDetailsDialog.__sanitize</h4> 219 <h4>PipPackageDetailsDialog.__sanitize</h4>
171 <b>__sanitize</b>(<i>text, forUrl=False</i>) 220 <b>__sanitize</b>(<i>text, forUrl=False</i>)
221
172 <p> 222 <p>
173 Private method to clean-up the given text. 223 Private method to clean-up the given text.
174 </p><dl> 224 </p>
225 <dl>
226
175 <dt><i>text</i> (str)</dt> 227 <dt><i>text</i> (str)</dt>
176 <dd> 228 <dd>
177 raw text 229 raw text
178 </dd><dt><i>forUrl</i> (bool)</dt> 230 </dd>
231 <dt><i>forUrl</i> (bool)</dt>
179 <dd> 232 <dd>
180 flag indicating to sanitize an URL text 233 flag indicating to sanitize an URL text
181 </dd> 234 </dd>
182 </dl><dl> 235 </dl>
236 <dl>
183 <dt>Returns:</dt> 237 <dt>Returns:</dt>
184 <dd> 238 <dd>
185 processed text 239 processed text
186 </dd> 240 </dd>
187 </dl><dl> 241 </dl>
242 <dl>
188 <dt>Return Type:</dt> 243 <dt>Return Type:</dt>
189 <dd> 244 <dd>
190 str 245 str
191 </dd> 246 </dd>
192 </dl> 247 </dl>

eric ide

mercurial