diff -r 1779dc278077 -r 391d6b7b1eff eric6/Documentation/Source/eric6.PipInterface.PipPackageDetailsDialog.html --- a/eric6/Documentation/Source/eric6.PipInterface.PipPackageDetailsDialog.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.PipInterface.PipPackageDetailsDialog.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,173 +18,228 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.PipInterface.PipPackageDetailsDialog</h1> + <p> Module implementing a dialog to show details about a package. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#PipPackageDetailsDialog">PipPackageDetailsDialog</a></td> <td>Class implementing a dialog to show details about a package.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="PipPackageDetailsDialog" ID="PipPackageDetailsDialog"></a> <h2>PipPackageDetailsDialog</h2> + <p> Class implementing a dialog to show details about a package. </p> <h3>Derived from</h3> QDialog, Ui_PipPackageDetailsDialog <h3>Class Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Class Methods</h3> + <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> + <table> + <tr> <td><a href="#PipPackageDetailsDialog.__init__">PipPackageDetailsDialog</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#PipPackageDetailsDialog.__formatSize">__formatSize</a></td> <td>Private slot to format the size.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PipPackageDetailsDialog.__formatUploadDate">__formatUploadDate</a></td> <td>Private method to format the upload date.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PipPackageDetailsDialog.__populateDetails">__populateDetails</a></td> <td>Private method to populate the details tab.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PipPackageDetailsDialog.__populateDownloadUrls">__populateDownloadUrls</a></td> <td>Private method to populate the download URLs tab.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PipPackageDetailsDialog.__populateRequiresProvides">__populateRequiresProvides</a></td> <td>Private method to populate the requires/provides tab.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PipPackageDetailsDialog.__sanitize">__sanitize</a></td> <td>Private method to clean-up the given text.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="PipPackageDetailsDialog.__init__" ID="PipPackageDetailsDialog.__init__"></a> <h4>PipPackageDetailsDialog (Constructor)</h4> <b>PipPackageDetailsDialog</b>(<i>detailsData, parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>detailsData</i> (dict)</dt> <dd> package details -</dd><dt><i>parent</i> (QWidget)</dt> +</dd> +<dt><i>parent</i> (QWidget)</dt> <dd> reference to the parent widget </dd> -</dl><a NAME="PipPackageDetailsDialog.__formatSize" ID="PipPackageDetailsDialog.__formatSize"></a> +</dl> +<a NAME="PipPackageDetailsDialog.__formatSize" ID="PipPackageDetailsDialog.__formatSize"></a> <h4>PipPackageDetailsDialog.__formatSize</h4> <b>__formatSize</b>(<i>size</i>) + <p> Private slot to format the size. -</p><dl> +</p> +<dl> + <dt><i>size</i> (int)</dt> <dd> size to be formatted </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> formatted size </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> str </dd> -</dl><a NAME="PipPackageDetailsDialog.__formatUploadDate" ID="PipPackageDetailsDialog.__formatUploadDate"></a> +</dl> +<a NAME="PipPackageDetailsDialog.__formatUploadDate" ID="PipPackageDetailsDialog.__formatUploadDate"></a> <h4>PipPackageDetailsDialog.__formatUploadDate</h4> <b>__formatUploadDate</b>(<i>datetime</i>) + <p> Private method to format the upload date. -</p><dl> +</p> +<dl> + <dt><i>datetime</i> (xmlrpc.DateTime or str)</dt> <dd> upload date and time </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> formatted date string </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> str </dd> -</dl><a NAME="PipPackageDetailsDialog.__populateDetails" ID="PipPackageDetailsDialog.__populateDetails"></a> +</dl> +<a NAME="PipPackageDetailsDialog.__populateDetails" ID="PipPackageDetailsDialog.__populateDetails"></a> <h4>PipPackageDetailsDialog.__populateDetails</h4> <b>__populateDetails</b>(<i>detailsData</i>) + <p> Private method to populate the details tab. -</p><dl> +</p> +<dl> + <dt><i>detailsData</i> (dict)</dt> <dd> package details </dd> -</dl><a NAME="PipPackageDetailsDialog.__populateDownloadUrls" ID="PipPackageDetailsDialog.__populateDownloadUrls"></a> +</dl> +<a NAME="PipPackageDetailsDialog.__populateDownloadUrls" ID="PipPackageDetailsDialog.__populateDownloadUrls"></a> <h4>PipPackageDetailsDialog.__populateDownloadUrls</h4> <b>__populateDownloadUrls</b>(<i>downloadsData</i>) + <p> Private method to populate the download URLs tab. -</p><dl> +</p> +<dl> + <dt><i>downloadsData</i> (dict)</dt> <dd> downloads information </dd> -</dl><a NAME="PipPackageDetailsDialog.__populateRequiresProvides" ID="PipPackageDetailsDialog.__populateRequiresProvides"></a> +</dl> +<a NAME="PipPackageDetailsDialog.__populateRequiresProvides" ID="PipPackageDetailsDialog.__populateRequiresProvides"></a> <h4>PipPackageDetailsDialog.__populateRequiresProvides</h4> <b>__populateRequiresProvides</b>(<i>detailsData</i>) + <p> Private method to populate the requires/provides tab. -</p><dl> +</p> +<dl> + <dt><i>detailsData</i> (dict)</dt> <dd> package details </dd> -</dl><a NAME="PipPackageDetailsDialog.__sanitize" ID="PipPackageDetailsDialog.__sanitize"></a> +</dl> +<a NAME="PipPackageDetailsDialog.__sanitize" ID="PipPackageDetailsDialog.__sanitize"></a> <h4>PipPackageDetailsDialog.__sanitize</h4> <b>__sanitize</b>(<i>text, forUrl=False</i>) + <p> Private method to clean-up the given text. -</p><dl> +</p> +<dl> + <dt><i>text</i> (str)</dt> <dd> raw text -</dd><dt><i>forUrl</i> (bool)</dt> +</dd> +<dt><i>forUrl</i> (bool)</dt> <dd> flag indicating to sanitize an URL text </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> processed text </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> str