Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.html

<!DOCTYPE html>
<html><head>
<title>eric6.Plugins.UiExtensionPlugins.PipInterface.Pip</title>
<meta charset="UTF-8">
<style>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</style>
</head>
<body><a NAME="top" ID="top"></a>
<h1>eric6.Plugins.UiExtensionPlugins.PipInterface.Pip</h1>
<p>
Package implementing the pip GUI logic.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#Pip">Pip</a></td>
<td>Class implementing the pip GUI logic.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="Pip" ID="Pip"></a>
<h2>Pip</h2>
<p>
    Class implementing the pip GUI logic.
</p>
<h3>Derived from</h3>
QObject
<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="#Pip.__init__">Pip</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#Pip.__aboutToShowMenu">__aboutToShowMenu</a></td>
<td>Private slot to set the action enabled status.</td>
</tr><tr>
<td><a href="#Pip.__checkUpgradePyQt">__checkUpgradePyQt</a></td>
<td>Private method to check, if an upgrade of PyQt packages is attempted.</td>
</tr><tr>
<td><a href="#Pip.__editConfiguration">__editConfiguration</a></td>
<td>Private method to edit a configuration.</td>
</tr><tr>
<td><a href="#Pip.__editUserConfiguration">__editUserConfiguration</a></td>
<td>Private slot to edit the user configuration.</td>
</tr><tr>
<td><a href="#Pip.__editVirtualenvConfiguration">__editVirtualenvConfiguration</a></td>
<td>Private slot to edit the current virtualenv configuration.</td>
</tr><tr>
<td><a href="#Pip.__generateRequirements">__generateRequirements</a></td>
<td>Private slot to generate the contents for a requirements file.</td>
</tr><tr>
<td><a href="#Pip.__getPython">__getPython</a></td>
<td>Private method to derive the path to the python executable given the path to the pip executable.</td>
</tr><tr>
<td><a href="#Pip.__getUserConfig">__getUserConfig</a></td>
<td>Private method to get the name of the user configuration file.</td>
</tr><tr>
<td><a href="#Pip.__getVirtualenvConfig">__getVirtualenvConfig</a></td>
<td>Private method to get the name of the virtualenv configuration file.</td>
</tr><tr>
<td><a href="#Pip.__handleTearOffMenu">__handleTearOffMenu</a></td>
<td>Private slot to handle a change of the pip executable.</td>
</tr><tr>
<td><a href="#Pip.__installLocalPackage">__installLocalPackage</a></td>
<td>Private slot to install a package available on local storage.</td>
</tr><tr>
<td><a href="#Pip.__installPackages">__installPackages</a></td>
<td>Private slot to install packages to be given by the user.</td>
</tr><tr>
<td><a href="#Pip.__installPip">__installPip</a></td>
<td>Private slot to install pip.</td>
</tr><tr>
<td><a href="#Pip.__installRequirements">__installRequirements</a></td>
<td>Private slot to install packages as given in a requirements file.</td>
</tr><tr>
<td><a href="#Pip.__listOutdatedPackages">__listOutdatedPackages</a></td>
<td>Private slot to list all installed, up-to-date packages.</td>
</tr><tr>
<td><a href="#Pip.__listPackages">__listPackages</a></td>
<td>Private slot to list all installed packages.</td>
</tr><tr>
<td><a href="#Pip.__listUptodatePackages">__listUptodatePackages</a></td>
<td>Private slot to list all installed, up-to-date packages.</td>
</tr><tr>
<td><a href="#Pip.__pipConfigure">__pipConfigure</a></td>
<td>Private slot to open the configuration page.</td>
</tr><tr>
<td><a href="#Pip.__repairPip">__repairPip</a></td>
<td>Private method to repair the pip installation.</td>
</tr><tr>
<td><a href="#Pip.__searchPyPI">__searchPyPI</a></td>
<td>Private slot to search the Python Package Index.</td>
</tr><tr>
<td><a href="#Pip.__selectPipExecutable">__selectPipExecutable</a></td>
<td>Private method to select the pip executable to be used.</td>
</tr><tr>
<td><a href="#Pip.__uninstallPackages">__uninstallPackages</a></td>
<td>Private slot to uninstall packages to be given by the user.</td>
</tr><tr>
<td><a href="#Pip.__uninstallRequirements">__uninstallRequirements</a></td>
<td>Private slot to uninstall packages as given in a requirements file.</td>
</tr><tr>
<td><a href="#Pip.__upgradePackages">__upgradePackages</a></td>
<td>Private slot to upgrade packages to be given by the user.</td>
</tr><tr>
<td><a href="#Pip.getMenu">getMenu</a></td>
<td>Public method to get a reference to the requested menu.</td>
</tr><tr>
<td><a href="#Pip.getMenuNames">getMenuNames</a></td>
<td>Public method to get the names of all menus.</td>
</tr><tr>
<td><a href="#Pip.initActions">initActions</a></td>
<td>Public method to define the Django actions.</td>
</tr><tr>
<td><a href="#Pip.initMenu">initMenu</a></td>
<td>Public slot to initialize the Django menu.</td>
</tr><tr>
<td><a href="#Pip.installPackages">installPackages</a></td>
<td>Public method to install the given list of packages.</td>
</tr><tr>
<td><a href="#Pip.runProcess">runProcess</a></td>
<td>Public method to execute the current pip with the given arguments.</td>
</tr><tr>
<td><a href="#Pip.uninstallPackages">uninstallPackages</a></td>
<td>Public method to uninstall the given list of packages.</td>
</tr><tr>
<td><a href="#Pip.upgradePackages">upgradePackages</a></td>
<td>Public method to upgrade the given list of packages.</td>
</tr><tr>
<td><a href="#Pip.upgradePip">upgradePip</a></td>
<td>Public method to upgrade pip itself.</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="Pip.__init__" ID="Pip.__init__"></a>
<h4>Pip (Constructor)</h4>
<b>Pip</b>(<i>plugin, parent=None</i>)
<p>
        Constructor
</p><dl>
<dt><i>plugin</i></dt>
<dd>
reference to the plugin object
</dd><dt><i>parent</i></dt>
<dd>
parent (QObject)
</dd>
</dl><a NAME="Pip.__aboutToShowMenu" ID="Pip.__aboutToShowMenu"></a>
<h4>Pip.__aboutToShowMenu</h4>
<b>__aboutToShowMenu</b>(<i></i>)
<p>
        Private slot to set the action enabled status.
</p><a NAME="Pip.__checkUpgradePyQt" ID="Pip.__checkUpgradePyQt"></a>
<h4>Pip.__checkUpgradePyQt</h4>
<b>__checkUpgradePyQt</b>(<i>packages</i>)
<p>
        Private method to check, if an upgrade of PyQt packages is attempted.
</p><dl>
<dt><i>packages</i> (list of str)</dt>
<dd>
list of packages to upgrade
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
flag indicating to abort the upgrade attempt
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl><a NAME="Pip.__editConfiguration" ID="Pip.__editConfiguration"></a>
<h4>Pip.__editConfiguration</h4>
<b>__editConfiguration</b>(<i>virtualenv=False</i>)
<p>
        Private method to edit a configuration.
</p><dl>
<dt><i>virtualenv</i></dt>
<dd>
flag indicating to edit the current virtualenv
            configuration file (boolean)
</dd>
</dl><a NAME="Pip.__editUserConfiguration" ID="Pip.__editUserConfiguration"></a>
<h4>Pip.__editUserConfiguration</h4>
<b>__editUserConfiguration</b>(<i></i>)
<p>
        Private slot to edit the user configuration.
</p><a NAME="Pip.__editVirtualenvConfiguration" ID="Pip.__editVirtualenvConfiguration"></a>
<h4>Pip.__editVirtualenvConfiguration</h4>
<b>__editVirtualenvConfiguration</b>(<i></i>)
<p>
        Private slot to edit the current virtualenv configuration.
</p><a NAME="Pip.__generateRequirements" ID="Pip.__generateRequirements"></a>
<h4>Pip.__generateRequirements</h4>
<b>__generateRequirements</b>(<i></i>)
<p>
        Private slot to generate the contents for a requirements file.
</p><a NAME="Pip.__getPython" ID="Pip.__getPython"></a>
<h4>Pip.__getPython</h4>
<b>__getPython</b>(<i>cmd</i>)
<p>
        Private method to derive the path to the python executable given the
        path to the pip executable.
</p><dl>
<dt><i>cmd</i> (str)</dt>
<dd>
path of the pip executable
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
path of the python executable
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl><a NAME="Pip.__getUserConfig" ID="Pip.__getUserConfig"></a>
<h4>Pip.__getUserConfig</h4>
<b>__getUserConfig</b>(<i></i>)
<p>
        Private method to get the name of the user configuration file.
</p><dl>
<dt>Returns:</dt>
<dd>
path of the user configuration file (string)
</dd>
</dl><a NAME="Pip.__getVirtualenvConfig" ID="Pip.__getVirtualenvConfig"></a>
<h4>Pip.__getVirtualenvConfig</h4>
<b>__getVirtualenvConfig</b>(<i></i>)
<p>
        Private method to get the name of the virtualenv configuration file.
</p><dl>
<dt>Returns:</dt>
<dd>
path of the virtualenv configuration file (string)
</dd>
</dl><a NAME="Pip.__handleTearOffMenu" ID="Pip.__handleTearOffMenu"></a>
<h4>Pip.__handleTearOffMenu</h4>
<b>__handleTearOffMenu</b>(<i>pip</i>)
<p>
        Private slot to handle a change of the pip executable.
</p><dl>
<dt><i>pip</i> (str)</dt>
<dd>
path of the pip executable
</dd>
</dl><a NAME="Pip.__installLocalPackage" ID="Pip.__installLocalPackage"></a>
<h4>Pip.__installLocalPackage</h4>
<b>__installLocalPackage</b>(<i></i>)
<p>
        Private slot to install a package available on local storage.
</p><a NAME="Pip.__installPackages" ID="Pip.__installPackages"></a>
<h4>Pip.__installPackages</h4>
<b>__installPackages</b>(<i></i>)
<p>
        Private slot to install packages to be given by the user.
</p><a NAME="Pip.__installPip" ID="Pip.__installPip"></a>
<h4>Pip.__installPip</h4>
<b>__installPip</b>(<i>userSite=False</i>)
<p>
        Private slot to install pip.
</p><dl>
<dt><i>userSite</i> (bool)</dt>
<dd>
flag indicating an install to the user install
            directory
</dd>
</dl><a NAME="Pip.__installRequirements" ID="Pip.__installRequirements"></a>
<h4>Pip.__installRequirements</h4>
<b>__installRequirements</b>(<i></i>)
<p>
        Private slot to install packages as given in a requirements file.
</p><a NAME="Pip.__listOutdatedPackages" ID="Pip.__listOutdatedPackages"></a>
<h4>Pip.__listOutdatedPackages</h4>
<b>__listOutdatedPackages</b>(<i></i>)
<p>
        Private slot to list all installed, up-to-date packages.
</p><a NAME="Pip.__listPackages" ID="Pip.__listPackages"></a>
<h4>Pip.__listPackages</h4>
<b>__listPackages</b>(<i></i>)
<p>
        Private slot to list all installed packages.
</p><a NAME="Pip.__listUptodatePackages" ID="Pip.__listUptodatePackages"></a>
<h4>Pip.__listUptodatePackages</h4>
<b>__listUptodatePackages</b>(<i></i>)
<p>
        Private slot to list all installed, up-to-date packages.
</p><a NAME="Pip.__pipConfigure" ID="Pip.__pipConfigure"></a>
<h4>Pip.__pipConfigure</h4>
<b>__pipConfigure</b>(<i></i>)
<p>
        Private slot to open the configuration page.
</p><a NAME="Pip.__repairPip" ID="Pip.__repairPip"></a>
<h4>Pip.__repairPip</h4>
<b>__repairPip</b>(<i></i>)
<p>
        Private method to repair the pip installation.
</p><dl>
<dt>Returns:</dt>
<dd>
flag indicating a successful execution
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl><a NAME="Pip.__searchPyPI" ID="Pip.__searchPyPI"></a>
<h4>Pip.__searchPyPI</h4>
<b>__searchPyPI</b>(<i></i>)
<p>
        Private slot to search the Python Package Index.
</p><a NAME="Pip.__selectPipExecutable" ID="Pip.__selectPipExecutable"></a>
<h4>Pip.__selectPipExecutable</h4>
<b>__selectPipExecutable</b>(<i></i>)
<p>
        Private method to select the pip executable to be used.
</p><a NAME="Pip.__uninstallPackages" ID="Pip.__uninstallPackages"></a>
<h4>Pip.__uninstallPackages</h4>
<b>__uninstallPackages</b>(<i></i>)
<p>
        Private slot to uninstall packages to be given by the user.
</p><a NAME="Pip.__uninstallRequirements" ID="Pip.__uninstallRequirements"></a>
<h4>Pip.__uninstallRequirements</h4>
<b>__uninstallRequirements</b>(<i></i>)
<p>
        Private slot to uninstall packages as given in a requirements file.
</p><a NAME="Pip.__upgradePackages" ID="Pip.__upgradePackages"></a>
<h4>Pip.__upgradePackages</h4>
<b>__upgradePackages</b>(<i></i>)
<p>
        Private slot to upgrade packages to be given by the user.
</p><a NAME="Pip.getMenu" ID="Pip.getMenu"></a>
<h4>Pip.getMenu</h4>
<b>getMenu</b>(<i>name</i>)
<p>
        Public method to get a reference to the requested menu.
</p><dl>
<dt><i>name</i></dt>
<dd>
name of the menu (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
reference to the menu (QMenu) or None, if no
            menu with the given name exists
</dd>
</dl><a NAME="Pip.getMenuNames" ID="Pip.getMenuNames"></a>
<h4>Pip.getMenuNames</h4>
<b>getMenuNames</b>(<i></i>)
<p>
        Public method to get the names of all menus.
</p><dl>
<dt>Returns:</dt>
<dd>
menu names (list of string)
</dd>
</dl><a NAME="Pip.initActions" ID="Pip.initActions"></a>
<h4>Pip.initActions</h4>
<b>initActions</b>(<i></i>)
<p>
        Public method to define the Django actions.
</p><a NAME="Pip.initMenu" ID="Pip.initMenu"></a>
<h4>Pip.initMenu</h4>
<b>initMenu</b>(<i></i>)
<p>
        Public slot to initialize the Django menu.
</p><dl>
<dt>Returns:</dt>
<dd>
the menu generated (QMenu)
</dd>
</dl><a NAME="Pip.installPackages" ID="Pip.installPackages"></a>
<h4>Pip.installPackages</h4>
<b>installPackages</b>(<i>packages, cmd="", userSite=False</i>)
<p>
        Public method to install the given list of packages.
</p><dl>
<dt><i>packages</i> (list of str)</dt>
<dd>
list of packages to install
</dd><dt><i>cmd</i> (str)</dt>
<dd>
pip command to be used
</dd><dt><i>userSite</i> (bool)</dt>
<dd>
flag indicating an install to the user install
            directory
</dd>
</dl><a NAME="Pip.runProcess" ID="Pip.runProcess"></a>
<h4>Pip.runProcess</h4>
<b>runProcess</b>(<i>args, cmd=""</i>)
<p>
        Public method to execute the current pip with the given arguments.
</p><p>
        The selected pip executable is called with the given arguments and
        waited for its end.
</p><dl>
<dt><i>args</i> (list of str)</dt>
<dd>
list of command line arguments
</dd><dt><i>cmd</i> (str)</dt>
<dd>
pip executable to be used
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
tuple containing a flag indicating success and the output
            of the process
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
tuple of (bool, str)
</dd>
</dl><a NAME="Pip.uninstallPackages" ID="Pip.uninstallPackages"></a>
<h4>Pip.uninstallPackages</h4>
<b>uninstallPackages</b>(<i>packages, cmd=""</i>)
<p>
        Public method to uninstall the given list of packages.
</p><dl>
<dt><i>packages</i></dt>
<dd>
list of packages to uninstall (list of string)
</dd><dt><i>cmd</i></dt>
<dd>
pip command to be used (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
flag indicating a successful execution (boolean)
</dd>
</dl><a NAME="Pip.upgradePackages" ID="Pip.upgradePackages"></a>
<h4>Pip.upgradePackages</h4>
<b>upgradePackages</b>(<i>packages, cmd="", userSite=False</i>)
<p>
        Public method to upgrade the given list of packages.
</p><dl>
<dt><i>packages</i> (list of str)</dt>
<dd>
list of packages to upgrade
</dd><dt><i>cmd</i> (str)</dt>
<dd>
pip command to be used
</dd><dt><i>userSite</i> (bool)</dt>
<dd>
flag indicating an install to the user install
            directory
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
flag indicating a successful execution
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl><a NAME="Pip.upgradePip" ID="Pip.upgradePip"></a>
<h4>Pip.upgradePip</h4>
<b>upgradePip</b>(<i>pip="", userSite=False</i>)
<p>
        Public method to upgrade pip itself.
</p><dl>
<dt><i>pip</i> (str)</dt>
<dd>
pip command to be used
</dd><dt><i>userSite</i> (bool)</dt>
<dd>
flag indicating an install to the user install
            directory
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
flag indicating a successful execution
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>