src/eric7/Documentation/Source/eric7.PipInterface.PipPackagesWidget.html

branch
eric7
changeset 11093
e8932a99beb4
parent 11091
3a1ba42ac50a
child 11128
04a9579c9c54
diff -r e2aaf07ef8fd -r e8932a99beb4 src/eric7/Documentation/Source/eric7.PipInterface.PipPackagesWidget.html
--- a/src/eric7/Documentation/Source/eric7.PipInterface.PipPackagesWidget.html	Thu Dec 12 11:42:04 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.PipInterface.PipPackagesWidget.html	Sat Dec 14 13:03:11 2024 +0100
@@ -26,10 +26,6 @@
 <td><a href="#PipPackagesWidget">PipPackagesWidget</a></td>
 <td>Class implementing the pip packages management widget.</td>
 </tr>
-<tr>
-<td><a href="#PypiSearchResultsParser">PypiSearchResultsParser</a></td>
-<td>Class implementing the parser for the PyPI search result page.</td>
-</tr>
 </table>
 
 <h3>Functions</h3>
@@ -152,10 +148,6 @@
 <td>Private slot to edit the configuration of the selected environment.</td>
 </tr>
 <tr>
-<td><a href="#PipPackagesWidget.__finishSearch">__finishSearch</a></td>
-<td>Private slot performing the search finishing actions.</td>
-</tr>
-<tr>
 <td><a href="#PipPackagesWidget.__generateConstraints">__generateConstraints</a></td>
 <td>Private slot to generate the contents for a constraints file.</td>
 </tr>
@@ -236,18 +228,6 @@
 <td>Private slot to repair the pip installation of the selected environment.</td>
 </tr>
 <tr>
-<td><a href="#PipPackagesWidget.__search">__search</a></td>
-<td>Private method to perform the search by calling the PyPI search URL.</td>
-</tr>
-<tr>
-<td><a href="#PipPackagesWidget.__searchFirst">__searchFirst</a></td>
-<td>Private method to perform the search for packages.</td>
-</tr>
-<tr>
-<td><a href="#PipPackagesWidget.__searchResponse">__searchResponse</a></td>
-<td>Private method to extract the search result data from the response.</td>
-</tr>
-<tr>
 <td><a href="#PipPackagesWidget.__selectedUpdateableItems">__selectedUpdateableItems</a></td>
 <td>Private method to get a list of selected items that can be updated.</td>
 </tr>
@@ -272,10 +252,6 @@
 <td>Private method to show information for a package.</td>
 </tr>
 <tr>
-<td><a href="#PipPackagesWidget.__showSearchedDetails">__showSearchedDetails</a></td>
-<td>Private slot to show details about the selected search result package.</td>
-</tr>
-<tr>
 <td><a href="#PipPackagesWidget.__showVulnerabilityInformation">__showVulnerabilityInformation</a></td>
 <td>Private method to show the detected vulnerability data.</td>
 </tr>
@@ -300,18 +276,6 @@
 <td>Private method to process the list of outdated packages.</td>
 </tr>
 <tr>
-<td><a href="#PipPackagesWidget.__updateSearchActionButtons">__updateSearchActionButtons</a></td>
-<td>Private method to update the action button states of the search widget.</td>
-</tr>
-<tr>
-<td><a href="#PipPackagesWidget.__updateSearchButton">__updateSearchButton</a></td>
-<td>Private method to update the state of the search button.</td>
-</tr>
-<tr>
-<td><a href="#PipPackagesWidget.__updateSearchMoreButton">__updateSearchMoreButton</a></td>
-<td>Private method to update the state of the search more button.</td>
-</tr>
-<tr>
 <td><a href="#PipPackagesWidget.__updateVulnerabilityData">__updateVulnerabilityData</a></td>
 <td>Private slot to update the shown vulnerability info.</td>
 </tr>
@@ -364,14 +328,6 @@
 <td>Private slot handling the selection of a Python environment.</td>
 </tr>
 <tr>
-<td><a href="#PipPackagesWidget.on_installButton_clicked">on_installButton_clicked</a></td>
-<td>Private slot to handle pressing the Install button..</td>
-</tr>
-<tr>
-<td><a href="#PipPackagesWidget.on_installUserSiteButton_clicked">on_installUserSiteButton_clicked</a></td>
-<td>Private slot to handle pressing the Install to User-Site button..</td>
-</tr>
-<tr>
 <td><a href="#PipPackagesWidget.on_installedFilesCheckBox_clicked">on_installedFilesCheckBox_clicked</a></td>
 <td>Private slot to handle a change of the installed files information checkbox.</td>
 </tr>
@@ -409,45 +365,17 @@
 </tr>
 <tr>
 <td><a href="#PipPackagesWidget.on_searchButton_clicked">on_searchButton_clicked</a></td>
-<td>Private slot handling a press of the search button.</td>
-</tr>
-<tr>
-<td><a href="#PipPackagesWidget.on_searchMoreButton_clicked">on_searchMoreButton_clicked</a></td>
-<td>Private slot handling a press of the search more button.</td>
-</tr>
-<tr>
-<td><a href="#PipPackagesWidget.on_searchNameEdit_returnPressed">on_searchNameEdit_returnPressed</a></td>
-<td>Private slot initiating a search via a press of the Return key.</td>
-</tr>
-<tr>
-<td><a href="#PipPackagesWidget.on_searchNameEdit_textChanged">on_searchNameEdit_textChanged</a></td>
-<td>Private slot handling a change of the search term.</td>
+<td>Private slot to open a web browser for package searching.</td>
 </tr>
 <tr>
-<td><a href="#PipPackagesWidget.on_searchResultList_itemActivated">on_searchResultList_itemActivated</a></td>
-<td>Private slot reacting on an search result item activation.</td>
-</tr>
-<tr>
-<td><a href="#PipPackagesWidget.on_searchResultList_itemSelectionChanged">on_searchResultList_itemSelectionChanged</a></td>
-<td>Private slot handling changes of the search result selection.</td>
-</tr>
-<tr>
-<td><a href="#PipPackagesWidget.on_searchToggleButton_1_toggled">on_searchToggleButton_1_toggled</a></td>
-<td>Private slot to toggle the search widget.</td>
-</tr>
-<tr>
-<td><a href="#PipPackagesWidget.on_searchToggleButton_2_toggled">on_searchToggleButton_2_toggled</a></td>
-<td>Private slot to toggle the search widget.</td>
+<td><a href="#PipPackagesWidget.on_searchEdit_returnPressed">on_searchEdit_returnPressed</a></td>
+<td>Private slot to handle the press of the Return key in the search line edit.</td>
 </tr>
 <tr>
 <td><a href="#PipPackagesWidget.on_showDepPackageDetailsButton_clicked">on_showDepPackageDetailsButton_clicked</a></td>
 <td>Private slot to show information for the selected package of the dependency tree.</td>
 </tr>
 <tr>
-<td><a href="#PipPackagesWidget.on_showDetailsButton_clicked">on_showDetailsButton_clicked</a></td>
-<td>Private slot to handle pressing the Show Details button.</td>
-</tr>
-<tr>
 <td><a href="#PipPackagesWidget.on_showPackageDetailsButton_clicked">on_showPackageDetailsButton_clicked</a></td>
 <td>Private slot to show information for the selected package.</td>
 </tr>
@@ -649,13 +577,6 @@
         Private slot to edit the configuration of the selected environment.
 </p>
 
-<a NAME="PipPackagesWidget.__finishSearch" ID="PipPackagesWidget.__finishSearch"></a>
-<h4>PipPackagesWidget.__finishSearch</h4>
-<b>__finishSearch</b>(<i></i>)
-<p>
-        Private slot performing the search finishing actions.
-</p>
-
 <a NAME="PipPackagesWidget.__generateConstraints" ID="PipPackagesWidget.__generateConstraints"></a>
 <h4>PipPackagesWidget.__generateConstraints</h4>
 <b>__generateConstraints</b>(<i></i>)
@@ -819,41 +740,6 @@
         environment.
 </p>
 
-<a NAME="PipPackagesWidget.__search" ID="PipPackagesWidget.__search"></a>
-<h4>PipPackagesWidget.__search</h4>
-<b>__search</b>(<i>page=1</i>)
-<p>
-        Private method to perform the search by calling the PyPI search URL.
-</p>
-
-<dl>
-
-<dt><i>page</i> (int (optional))</dt>
-<dd>
-search page to retrieve (defaults to 1)
-</dd>
-</dl>
-<a NAME="PipPackagesWidget.__searchFirst" ID="PipPackagesWidget.__searchFirst"></a>
-<h4>PipPackagesWidget.__searchFirst</h4>
-<b>__searchFirst</b>(<i></i>)
-<p>
-        Private method to perform the search for packages.
-</p>
-
-<a NAME="PipPackagesWidget.__searchResponse" ID="PipPackagesWidget.__searchResponse"></a>
-<h4>PipPackagesWidget.__searchResponse</h4>
-<b>__searchResponse</b>(<i>reply</i>)
-<p>
-        Private method to extract the search result data from the response.
-</p>
-
-<dl>
-
-<dt><i>reply</i> (QNetworkReply)</dt>
-<dd>
-reference to the reply object containing the data
-</dd>
-</dl>
 <a NAME="PipPackagesWidget.__selectedUpdateableItems" ID="PipPackagesWidget.__selectedUpdateableItems"></a>
 <h4>PipPackagesWidget.__selectedUpdateableItems</h4>
 <b>__selectedUpdateableItems</b>(<i></i>)
@@ -945,20 +831,6 @@
 reference to the widget to contain the information
 </dd>
 </dl>
-<a NAME="PipPackagesWidget.__showSearchedDetails" ID="PipPackagesWidget.__showSearchedDetails"></a>
-<h4>PipPackagesWidget.__showSearchedDetails</h4>
-<b>__showSearchedDetails</b>(<i>item=None</i>)
-<p>
-        Private slot to show details about the selected search result package.
-</p>
-
-<dl>
-
-<dt><i>item</i> (QTreeWidgetItem)</dt>
-<dd>
-reference to the search result item to show details for
-</dd>
-</dl>
 <a NAME="PipPackagesWidget.__showVulnerabilityInformation" ID="PipPackagesWidget.__showVulnerabilityInformation"></a>
 <h4>PipPackagesWidget.__showVulnerabilityInformation</h4>
 <b>__showVulnerabilityInformation</b>(<i>packageName, packageVersion, vulnerabilities</i>)
@@ -1024,34 +896,6 @@
             a tuple containing the installed and available version as the value
 </dd>
 </dl>
-<a NAME="PipPackagesWidget.__updateSearchActionButtons" ID="PipPackagesWidget.__updateSearchActionButtons"></a>
-<h4>PipPackagesWidget.__updateSearchActionButtons</h4>
-<b>__updateSearchActionButtons</b>(<i></i>)
-<p>
-        Private method to update the action button states of the search widget.
-</p>
-
-<a NAME="PipPackagesWidget.__updateSearchButton" ID="PipPackagesWidget.__updateSearchButton"></a>
-<h4>PipPackagesWidget.__updateSearchButton</h4>
-<b>__updateSearchButton</b>(<i></i>)
-<p>
-        Private method to update the state of the search button.
-</p>
-
-<a NAME="PipPackagesWidget.__updateSearchMoreButton" ID="PipPackagesWidget.__updateSearchMoreButton"></a>
-<h4>PipPackagesWidget.__updateSearchMoreButton</h4>
-<b>__updateSearchMoreButton</b>(<i>enable</i>)
-<p>
-        Private method to update the state of the search more button.
-</p>
-
-<dl>
-
-<dt><i>enable</i> (bool)</dt>
-<dd>
-flag indicating the desired enable state
-</dd>
-</dl>
 <a NAME="PipPackagesWidget.__updateVulnerabilityData" ID="PipPackagesWidget.__updateVulnerabilityData"></a>
 <h4>PipPackagesWidget.__updateVulnerabilityData</h4>
 <b>__updateVulnerabilityData</b>(<i>clearFirst=True</i>)
@@ -1222,20 +1066,6 @@
 name of the selected Python environment
 </dd>
 </dl>
-<a NAME="PipPackagesWidget.on_installButton_clicked" ID="PipPackagesWidget.on_installButton_clicked"></a>
-<h4>PipPackagesWidget.on_installButton_clicked</h4>
-<b>on_installButton_clicked</b>(<i></i>)
-<p>
-        Private slot to handle pressing the Install button..
-</p>
-
-<a NAME="PipPackagesWidget.on_installUserSiteButton_clicked" ID="PipPackagesWidget.on_installUserSiteButton_clicked"></a>
-<h4>PipPackagesWidget.on_installUserSiteButton_clicked</h4>
-<b>on_installUserSiteButton_clicked</b>(<i></i>)
-<p>
-        Private slot to handle pressing the Install to User-Site button..
-</p>
-
 <a NAME="PipPackagesWidget.on_installedFilesCheckBox_clicked" ID="PipPackagesWidget.on_installedFilesCheckBox_clicked"></a>
 <h4>PipPackagesWidget.on_installedFilesCheckBox_clicked</h4>
 <b>on_installedFilesCheckBox_clicked</b>(<i>checked</i>)
@@ -1329,90 +1159,16 @@
 <h4>PipPackagesWidget.on_searchButton_clicked</h4>
 <b>on_searchButton_clicked</b>(<i></i>)
 <p>
-        Private slot handling a press of the search button.
-</p>
-
-<a NAME="PipPackagesWidget.on_searchMoreButton_clicked" ID="PipPackagesWidget.on_searchMoreButton_clicked"></a>
-<h4>PipPackagesWidget.on_searchMoreButton_clicked</h4>
-<b>on_searchMoreButton_clicked</b>(<i></i>)
-<p>
-        Private slot handling a press of the search more button.
-</p>
-
-<a NAME="PipPackagesWidget.on_searchNameEdit_returnPressed" ID="PipPackagesWidget.on_searchNameEdit_returnPressed"></a>
-<h4>PipPackagesWidget.on_searchNameEdit_returnPressed</h4>
-<b>on_searchNameEdit_returnPressed</b>(<i></i>)
-<p>
-        Private slot initiating a search via a press of the Return key.
-</p>
-
-<a NAME="PipPackagesWidget.on_searchNameEdit_textChanged" ID="PipPackagesWidget.on_searchNameEdit_textChanged"></a>
-<h4>PipPackagesWidget.on_searchNameEdit_textChanged</h4>
-<b>on_searchNameEdit_textChanged</b>(<i>_txt</i>)
-<p>
-        Private slot handling a change of the search term.
-</p>
-
-<dl>
-
-<dt><i>_txt</i> (str)</dt>
-<dd>
-search term (unused)
-</dd>
-</dl>
-<a NAME="PipPackagesWidget.on_searchResultList_itemActivated" ID="PipPackagesWidget.on_searchResultList_itemActivated"></a>
-<h4>PipPackagesWidget.on_searchResultList_itemActivated</h4>
-<b>on_searchResultList_itemActivated</b>(<i>item, column</i>)
-<p>
-        Private slot reacting on an search result item activation.
+        Private slot to open a web browser for package searching.
 </p>
 
-<dl>
-
-<dt><i>item</i> (QTreeWidgetItem)</dt>
-<dd>
-reference to the activated item
-</dd>
-<dt><i>column</i> (int)</dt>
-<dd>
-activated column
-</dd>
-</dl>
-<a NAME="PipPackagesWidget.on_searchResultList_itemSelectionChanged" ID="PipPackagesWidget.on_searchResultList_itemSelectionChanged"></a>
-<h4>PipPackagesWidget.on_searchResultList_itemSelectionChanged</h4>
-<b>on_searchResultList_itemSelectionChanged</b>(<i></i>)
+<a NAME="PipPackagesWidget.on_searchEdit_returnPressed" ID="PipPackagesWidget.on_searchEdit_returnPressed"></a>
+<h4>PipPackagesWidget.on_searchEdit_returnPressed</h4>
+<b>on_searchEdit_returnPressed</b>(<i></i>)
 <p>
-        Private slot handling changes of the search result selection.
+        Private slot to handle the press of the Return key in the search line edit.
 </p>
 
-<a NAME="PipPackagesWidget.on_searchToggleButton_1_toggled" ID="PipPackagesWidget.on_searchToggleButton_1_toggled"></a>
-<h4>PipPackagesWidget.on_searchToggleButton_1_toggled</h4>
-<b>on_searchToggleButton_1_toggled</b>(<i>checked</i>)
-<p>
-        Private slot to toggle the search widget.
-</p>
-
-<dl>
-
-<dt><i>checked</i> (bool)</dt>
-<dd>
-state of the search widget button
-</dd>
-</dl>
-<a NAME="PipPackagesWidget.on_searchToggleButton_2_toggled" ID="PipPackagesWidget.on_searchToggleButton_2_toggled"></a>
-<h4>PipPackagesWidget.on_searchToggleButton_2_toggled</h4>
-<b>on_searchToggleButton_2_toggled</b>(<i>checked</i>)
-<p>
-        Private slot to toggle the search widget.
-</p>
-
-<dl>
-
-<dt><i>checked</i> (bool)</dt>
-<dd>
-state of the search widget button
-</dd>
-</dl>
 <a NAME="PipPackagesWidget.on_showDepPackageDetailsButton_clicked" ID="PipPackagesWidget.on_showDepPackageDetailsButton_clicked"></a>
 <h4>PipPackagesWidget.on_showDepPackageDetailsButton_clicked</h4>
 <b>on_showDepPackageDetailsButton_clicked</b>(<i></i>)
@@ -1421,13 +1177,6 @@
         dependency tree.
 </p>
 
-<a NAME="PipPackagesWidget.on_showDetailsButton_clicked" ID="PipPackagesWidget.on_showDetailsButton_clicked"></a>
-<h4>PipPackagesWidget.on_showDetailsButton_clicked</h4>
-<b>on_showDetailsButton_clicked</b>(<i></i>)
-<p>
-        Private slot to handle pressing the Show Details button.
-</p>
-
 <a NAME="PipPackagesWidget.on_showPackageDetailsButton_clicked" ID="PipPackagesWidget.on_showPackageDetailsButton_clicked"></a>
 <h4>PipPackagesWidget.on_showPackageDetailsButton_clicked</h4>
 <b>on_showPackageDetailsButton_clicked</b>(<i></i>)
@@ -1536,196 +1285,4 @@
 </dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
-<hr />
-<a NAME="PypiSearchResultsParser" ID="PypiSearchResultsParser"></a>
-<h2>PypiSearchResultsParser</h2>
-<p>
-    Class implementing the parser for the PyPI search result page.
-</p>
-
-<h3>Derived from</h3>
-html.parser.HTMLParser
-<h3>Class Attributes</h3>
-<table>
-<tr><td>ClassPrefix</td></tr>
-</table>
-
-<h3>Class Methods</h3>
-<table>
-<tr><td>None</td></tr>
-</table>
-
-<h3>Methods</h3>
-<table>
-<tr>
-<td><a href="#PypiSearchResultsParser.__init__">PypiSearchResultsParser</a></td>
-<td>Constructor</td>
-</tr>
-<tr>
-<td><a href="#PypiSearchResultsParser.__getClass">__getClass</a></td>
-<td>Private method to extract the class attribute out of the list of attributes.</td>
-</tr>
-<tr>
-<td><a href="#PypiSearchResultsParser.__getDate">__getDate</a></td>
-<td>Private method to extract the datetime attribute out of the list of attributes and process it.</td>
-</tr>
-<tr>
-<td><a href="#PypiSearchResultsParser.getResults">getResults</a></td>
-<td>Public method to get the extracted search results.</td>
-</tr>
-<tr>
-<td><a href="#PypiSearchResultsParser.handle_data">handle_data</a></td>
-<td>Public method process arbitrary data.</td>
-</tr>
-<tr>
-<td><a href="#PypiSearchResultsParser.handle_endtag">handle_endtag</a></td>
-<td>Public method to process the end tag.</td>
-</tr>
-<tr>
-<td><a href="#PypiSearchResultsParser.handle_starttag">handle_starttag</a></td>
-<td>Public method to process the start tag.</td>
-</tr>
-</table>
-
-<h3>Static Methods</h3>
-<table>
-<tr><td>None</td></tr>
-</table>
-
-
-<a NAME="PypiSearchResultsParser.__init__" ID="PypiSearchResultsParser.__init__"></a>
-<h4>PypiSearchResultsParser (Constructor)</h4>
-<b>PypiSearchResultsParser</b>(<i>data</i>)
-<p>
-        Constructor
-</p>
-
-<dl>
-
-<dt><i>data</i> (str)</dt>
-<dd>
-data to be parsed
-</dd>
-</dl>
-<a NAME="PypiSearchResultsParser.__getClass" ID="PypiSearchResultsParser.__getClass"></a>
-<h4>PypiSearchResultsParser.__getClass</h4>
-<b>__getClass</b>(<i>attrs</i>)
-<p>
-        Private method to extract the class attribute out of the list of
-        attributes.
-</p>
-
-<dl>
-
-<dt><i>attrs</i> (list of tuple of (str, str))</dt>
-<dd>
-list of tag attributes as (name, value) tuples
-</dd>
-</dl>
-<dl>
-<dt>Return:</dt>
-<dd>
-value of the 'class' attribute or None
-</dd>
-</dl>
-<dl>
-<dt>Return Type:</dt>
-<dd>
-str
-</dd>
-</dl>
-<a NAME="PypiSearchResultsParser.__getDate" ID="PypiSearchResultsParser.__getDate"></a>
-<h4>PypiSearchResultsParser.__getDate</h4>
-<b>__getDate</b>(<i>attrs</i>)
-<p>
-        Private method to extract the datetime attribute out of the list of
-        attributes and process it.
-</p>
-
-<dl>
-
-<dt><i>attrs</i> (list of tuple of (str, str))</dt>
-<dd>
-list of tag attributes as (name, value) tuples
-</dd>
-</dl>
-<dl>
-<dt>Return:</dt>
-<dd>
-value of the 'class' attribute or None
-</dd>
-</dl>
-<dl>
-<dt>Return Type:</dt>
-<dd>
-str
-</dd>
-</dl>
-<a NAME="PypiSearchResultsParser.getResults" ID="PypiSearchResultsParser.getResults"></a>
-<h4>PypiSearchResultsParser.getResults</h4>
-<b>getResults</b>(<i></i>)
-<p>
-        Public method to get the extracted search results.
-</p>
-
-<dl>
-<dt>Return:</dt>
-<dd>
-extracted result data
-</dd>
-</dl>
-<dl>
-<dt>Return Type:</dt>
-<dd>
-list of dict
-</dd>
-</dl>
-<a NAME="PypiSearchResultsParser.handle_data" ID="PypiSearchResultsParser.handle_data"></a>
-<h4>PypiSearchResultsParser.handle_data</h4>
-<b>handle_data</b>(<i>data</i>)
-<p>
-        Public method process arbitrary data.
-</p>
-
-<dl>
-
-<dt><i>data</i> (str)</dt>
-<dd>
-data to be processed
-</dd>
-</dl>
-<a NAME="PypiSearchResultsParser.handle_endtag" ID="PypiSearchResultsParser.handle_endtag"></a>
-<h4>PypiSearchResultsParser.handle_endtag</h4>
-<b>handle_endtag</b>(<i>_tag</i>)
-<p>
-        Public method to process the end tag.
-</p>
-
-<dl>
-
-<dt><i>_tag</i> (str)</dt>
-<dd>
-tag name (all lowercase) (unused)
-</dd>
-</dl>
-<a NAME="PypiSearchResultsParser.handle_starttag" ID="PypiSearchResultsParser.handle_starttag"></a>
-<h4>PypiSearchResultsParser.handle_starttag</h4>
-<b>handle_starttag</b>(<i>tag, attrs</i>)
-<p>
-        Public method to process the start tag.
-</p>
-
-<dl>
-
-<dt><i>tag</i> (str)</dt>
-<dd>
-tag name (all lowercase)
-</dd>
-<dt><i>attrs</i> (list of tuple of (str, str))</dt>
-<dd>
-list of tag attributes as (name, value) tuples
-</dd>
-</dl>
-<div align="right"><a href="#top">Up</a></div>
-<hr />
 </body></html>

eric ide

mercurial