Documentation/Source/eric6.PipInterface.PipPackageDetailsDialog.html

changeset 6807
7e5eba19d86d
equal deleted inserted replaced
6806:d306647cb82d 6807:7e5eba19d86d
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.PipInterface.PipPackageDetailsDialog</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.PipInterface.PipPackageDetailsDialog</h1>
23 <p>
24 Module implementing a dialog to show details about a package.
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="#PipPackageDetailsDialog">PipPackageDetailsDialog</a></td>
34 <td>Class implementing a dialog to show details about a package.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="PipPackageDetailsDialog" ID="PipPackageDetailsDialog"></a>
43 <h2>PipPackageDetailsDialog</h2>
44 <p>
45 Class implementing a dialog to show details about a package.
46 </p>
47 <h3>Derived from</h3>
48 QDialog, Ui_PipPackageDetailsDialog
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#PipPackageDetailsDialog.__init__">PipPackageDetailsDialog</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#PipPackageDetailsDialog.__formatSize">__formatSize</a></td>
64 <td>Private slot to format the size.</td>
65 </tr><tr>
66 <td><a href="#PipPackageDetailsDialog.__formatUploadDate">__formatUploadDate</a></td>
67 <td>Private method to format the upload date.</td>
68 </tr><tr>
69 <td><a href="#PipPackageDetailsDialog.__populateDetails">__populateDetails</a></td>
70 <td>Private method to populate the details tab.</td>
71 </tr><tr>
72 <td><a href="#PipPackageDetailsDialog.__populateDownloadUrls">__populateDownloadUrls</a></td>
73 <td>Private method to populate the download URLs tab.</td>
74 </tr><tr>
75 <td><a href="#PipPackageDetailsDialog.__populateRequiresProvides">__populateRequiresProvides</a></td>
76 <td>Private method to populate the requires/provides tab.</td>
77 </tr><tr>
78 <td><a href="#PipPackageDetailsDialog.__sanitize">__sanitize</a></td>
79 <td>Private method to clean-up the given text.</td>
80 </tr>
81 </table>
82 <h3>Static Methods</h3>
83 <table>
84 <tr><td>None</td></tr>
85 </table>
86 <a NAME="PipPackageDetailsDialog.__init__" ID="PipPackageDetailsDialog.__init__"></a>
87 <h4>PipPackageDetailsDialog (Constructor)</h4>
88 <b>PipPackageDetailsDialog</b>(<i>detailsData, parent=None</i>)
89 <p>
90 Constructor
91 </p><dl>
92 <dt><i>detailsData</i> (dict)</dt>
93 <dd>
94 package details
95 </dd><dt><i>parent</i> (QWidget)</dt>
96 <dd>
97 reference to the parent widget
98 </dd>
99 </dl><a NAME="PipPackageDetailsDialog.__formatSize" ID="PipPackageDetailsDialog.__formatSize"></a>
100 <h4>PipPackageDetailsDialog.__formatSize</h4>
101 <b>__formatSize</b>(<i>size</i>)
102 <p>
103 Private slot to format the size.
104 </p><dl>
105 <dt><i>size</i> (int)</dt>
106 <dd>
107 size to be formatted
108 </dd>
109 </dl><dl>
110 <dt>Returns:</dt>
111 <dd>
112 formatted size
113 </dd>
114 </dl><dl>
115 <dt>Return Type:</dt>
116 <dd>
117 str
118 </dd>
119 </dl><a NAME="PipPackageDetailsDialog.__formatUploadDate" ID="PipPackageDetailsDialog.__formatUploadDate"></a>
120 <h4>PipPackageDetailsDialog.__formatUploadDate</h4>
121 <b>__formatUploadDate</b>(<i>datetime</i>)
122 <p>
123 Private method to format the upload date.
124 </p><dl>
125 <dt><i>datetime</i> (xmlrpc.DateTime or str)</dt>
126 <dd>
127 upload date and time
128 </dd>
129 </dl><dl>
130 <dt>Returns:</dt>
131 <dd>
132 formatted date string
133 </dd>
134 </dl><dl>
135 <dt>Return Type:</dt>
136 <dd>
137 str
138 </dd>
139 </dl><a NAME="PipPackageDetailsDialog.__populateDetails" ID="PipPackageDetailsDialog.__populateDetails"></a>
140 <h4>PipPackageDetailsDialog.__populateDetails</h4>
141 <b>__populateDetails</b>(<i>detailsData</i>)
142 <p>
143 Private method to populate the details tab.
144 </p><dl>
145 <dt><i>detailsData</i> (dict)</dt>
146 <dd>
147 package details
148 </dd>
149 </dl><a NAME="PipPackageDetailsDialog.__populateDownloadUrls" ID="PipPackageDetailsDialog.__populateDownloadUrls"></a>
150 <h4>PipPackageDetailsDialog.__populateDownloadUrls</h4>
151 <b>__populateDownloadUrls</b>(<i>downloadsData</i>)
152 <p>
153 Private method to populate the download URLs tab.
154 </p><dl>
155 <dt><i>downloadsData</i> (dict)</dt>
156 <dd>
157 downloads information
158 </dd>
159 </dl><a NAME="PipPackageDetailsDialog.__populateRequiresProvides" ID="PipPackageDetailsDialog.__populateRequiresProvides"></a>
160 <h4>PipPackageDetailsDialog.__populateRequiresProvides</h4>
161 <b>__populateRequiresProvides</b>(<i>detailsData</i>)
162 <p>
163 Private method to populate the requires/provides tab.
164 </p><dl>
165 <dt><i>detailsData</i> (dict)</dt>
166 <dd>
167 package details
168 </dd>
169 </dl><a NAME="PipPackageDetailsDialog.__sanitize" ID="PipPackageDetailsDialog.__sanitize"></a>
170 <h4>PipPackageDetailsDialog.__sanitize</h4>
171 <b>__sanitize</b>(<i>text, forUrl=False</i>)
172 <p>
173 Private method to clean-up the given text.
174 </p><dl>
175 <dt><i>text</i> (str)</dt>
176 <dd>
177 raw text
178 </dd><dt><i>forUrl</i> (bool)</dt>
179 <dd>
180 flag indicating to sanitize an URL text
181 </dd>
182 </dl><dl>
183 <dt>Returns:</dt>
184 <dd>
185 processed text
186 </dd>
187 </dl><dl>
188 <dt>Return Type:</dt>
189 <dd>
190 str
191 </dd>
192 </dl>
193 <div align="right"><a href="#top">Up</a></div>
194 <hr />
195 </body></html>

eric ide

mercurial