Updated the source code documentation. eric7

Mon, 04 Mar 2024 11:46:04 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Mon, 04 Mar 2024 11:46:04 +0100
branch
eric7
changeset 10623
56eb5eb8d0ee
parent 10622
eb5303a42b4b
child 10624
cf6185def935

Updated the source code documentation.

src/eric7/APIs/Python3/eric7.api file | annotate | diff | comparison | revisions
src/eric7/Documentation/Help/source.qch file | annotate | diff | comparison | revisions
src/eric7/Documentation/Help/source.qhp file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.PipInterface.Pip.html file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.PipInterface.PipPackagesWidget.html file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.Project.Project.html file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.Project.PropertiesDialog.html file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.QScintilla.Shell.html file | annotate | diff | comparison | revisions
--- a/src/eric7/APIs/Python3/eric7.api	Mon Mar 04 11:45:12 2024 +0100
+++ b/src/eric7/APIs/Python3/eric7.api	Mon Mar 04 11:46:04 2024 +0100
@@ -3708,11 +3708,13 @@
 eric7.PipInterface.Pip.Pip.installEditableProject?4(interpreter, projectPath)
 eric7.PipInterface.Pip.Pip.installPackages?4(packages, venvName="", userSite=False, interpreter="", forceReinstall=False, )
 eric7.PipInterface.Pip.Pip.installPip?4(venvName, userSite=False)
+eric7.PipInterface.Pip.Pip.installPyprojectDependencies?4(venvName)
 eric7.PipInterface.Pip.Pip.installRequirements?4(venvName)
 eric7.PipInterface.Pip.Pip.repairPip?4(venvName)
 eric7.PipInterface.Pip.Pip.runProcess?4(args, interpreter)
 eric7.PipInterface.Pip.Pip.showCacheInfo?4(venvName)
 eric7.PipInterface.Pip.Pip.uninstallPackages?4(packages, venvName)
+eric7.PipInterface.Pip.Pip.uninstallPyprojectDependencies?4(venvName)
 eric7.PipInterface.Pip.Pip.uninstallRequirements?4(venvName)
 eric7.PipInterface.Pip.Pip.upgradePackages?4(packages, venvName, userSite=False)
 eric7.PipInterface.Pip.Pip?1(parent=None)
Binary file src/eric7/Documentation/Help/source.qch has changed
--- a/src/eric7/Documentation/Help/source.qhp	Mon Mar 04 11:45:12 2024 +0100
+++ b/src/eric7/Documentation/Help/source.qhp	Mon Mar 04 11:46:04 2024 +0100
@@ -12476,11 +12476,13 @@
       <keyword name="Pip.installEditableProject" id="Pip.installEditableProject" ref="eric7.PipInterface.Pip.html#Pip.installEditableProject" />
       <keyword name="Pip.installPackages" id="Pip.installPackages" ref="eric7.PipInterface.Pip.html#Pip.installPackages" />
       <keyword name="Pip.installPip" id="Pip.installPip" ref="eric7.PipInterface.Pip.html#Pip.installPip" />
+      <keyword name="Pip.installPyprojectDependencies" id="Pip.installPyprojectDependencies" ref="eric7.PipInterface.Pip.html#Pip.installPyprojectDependencies" />
       <keyword name="Pip.installRequirements" id="Pip.installRequirements" ref="eric7.PipInterface.Pip.html#Pip.installRequirements" />
       <keyword name="Pip.repairPip" id="Pip.repairPip" ref="eric7.PipInterface.Pip.html#Pip.repairPip" />
       <keyword name="Pip.runProcess" id="Pip.runProcess" ref="eric7.PipInterface.Pip.html#Pip.runProcess" />
       <keyword name="Pip.showCacheInfo" id="Pip.showCacheInfo" ref="eric7.PipInterface.Pip.html#Pip.showCacheInfo" />
       <keyword name="Pip.uninstallPackages" id="Pip.uninstallPackages" ref="eric7.PipInterface.Pip.html#Pip.uninstallPackages" />
+      <keyword name="Pip.uninstallPyprojectDependencies" id="Pip.uninstallPyprojectDependencies" ref="eric7.PipInterface.Pip.html#Pip.uninstallPyprojectDependencies" />
       <keyword name="Pip.uninstallRequirements" id="Pip.uninstallRequirements" ref="eric7.PipInterface.Pip.html#Pip.uninstallRequirements" />
       <keyword name="Pip.upgradePackages" id="Pip.upgradePackages" ref="eric7.PipInterface.Pip.html#Pip.upgradePackages" />
       <keyword name="PipDialog" id="PipDialog" ref="eric7.PipInterface.PipDialog.html#PipDialog" />
@@ -12568,6 +12570,7 @@
       <keyword name="PipPackagesWidget.__installPackages" id="PipPackagesWidget.__installPackages" ref="eric7.PipInterface.PipPackagesWidget.html#PipPackagesWidget.__installPackages" />
       <keyword name="PipPackagesWidget.__installPip" id="PipPackagesWidget.__installPip" ref="eric7.PipInterface.PipPackagesWidget.html#PipPackagesWidget.__installPip" />
       <keyword name="PipPackagesWidget.__installPipUser" id="PipPackagesWidget.__installPipUser" ref="eric7.PipInterface.PipPackagesWidget.html#PipPackagesWidget.__installPipUser" />
+      <keyword name="PipPackagesWidget.__installPyprojectDependencies" id="PipPackagesWidget.__installPyprojectDependencies" ref="eric7.PipInterface.PipPackagesWidget.html#PipPackagesWidget.__installPyprojectDependencies" />
       <keyword name="PipPackagesWidget.__installRequirements" id="PipPackagesWidget.__installRequirements" ref="eric7.PipInterface.PipPackagesWidget.html#PipPackagesWidget.__installRequirements" />
       <keyword name="PipPackagesWidget.__isPipAvailable" id="PipPackagesWidget.__isPipAvailable" ref="eric7.PipInterface.PipPackagesWidget.html#PipPackagesWidget.__isPipAvailable" />
       <keyword name="PipPackagesWidget.__pipConfigure" id="PipPackagesWidget.__pipConfigure" ref="eric7.PipInterface.PipPackagesWidget.html#PipPackagesWidget.__pipConfigure" />
@@ -12591,6 +12594,7 @@
       <keyword name="PipPackagesWidget.__showPackageInformation" id="PipPackagesWidget.__showPackageInformation" ref="eric7.PipInterface.PipPackagesWidget.html#PipPackagesWidget.__showPackageInformation" />
       <keyword name="PipPackagesWidget.__showSearchedDetails" id="PipPackagesWidget.__showSearchedDetails" ref="eric7.PipInterface.PipPackagesWidget.html#PipPackagesWidget.__showSearchedDetails" />
       <keyword name="PipPackagesWidget.__showVulnerabilityInformation" id="PipPackagesWidget.__showVulnerabilityInformation" ref="eric7.PipInterface.PipPackagesWidget.html#PipPackagesWidget.__showVulnerabilityInformation" />
+      <keyword name="PipPackagesWidget.__uninstallPyprojectDependencies" id="PipPackagesWidget.__uninstallPyprojectDependencies" ref="eric7.PipInterface.PipPackagesWidget.html#PipPackagesWidget.__uninstallPyprojectDependencies" />
       <keyword name="PipPackagesWidget.__uninstallRequirements" id="PipPackagesWidget.__uninstallRequirements" ref="eric7.PipInterface.PipPackagesWidget.html#PipPackagesWidget.__uninstallRequirements" />
       <keyword name="PipPackagesWidget.__updateActionButtons" id="PipPackagesWidget.__updateActionButtons" ref="eric7.PipInterface.PipPackagesWidget.html#PipPackagesWidget.__updateActionButtons" />
       <keyword name="PipPackagesWidget.__updateDepActionButtons" id="PipPackagesWidget.__updateDepActionButtons" ref="eric7.PipInterface.PipPackagesWidget.html#PipPackagesWidget.__updateDepActionButtons" />
@@ -13026,6 +13030,7 @@
       <keyword name="Project.__checkFilesExist" id="Project.__checkFilesExist" ref="eric7.Project.Project.html#Project.__checkFilesExist" />
       <keyword name="Project.__checkProjectFileGroup" id="Project.__checkProjectFileGroup" ref="eric7.Project.Project.html#Project.__checkProjectFileGroup" />
       <keyword name="Project.__cleanupMake" id="Project.__cleanupMake" ref="eric7.Project.Project.html#Project.__cleanupMake" />
+      <keyword name="Project.__clearByteCodeCaches" id="Project.__clearByteCodeCaches" ref="eric7.Project.Project.html#Project.__clearByteCodeCaches" />
       <keyword name="Project.__closeAllWindows" id="Project.__closeAllWindows" ref="eric7.Project.Project.html#Project.__closeAllWindows" />
       <keyword name="Project.__configureBlack" id="Project.__configureBlack" ref="eric7.Project.Project.html#Project.__configureBlack" />
       <keyword name="Project.__configureEnvironment" id="Project.__configureEnvironment" ref="eric7.Project.Project.html#Project.__configureEnvironment" />
@@ -13585,6 +13590,7 @@
       <keyword name="PropertiesDialog (Module)" id="PropertiesDialog (Module)" ref="eric7.Project.PropertiesDialog.html" />
       <keyword name="PropertiesDialog.__initFileTypesDict" id="PropertiesDialog.__initFileTypesDict" ref="eric7.Project.PropertiesDialog.html#PropertiesDialog.__initFileTypesDict" />
       <keyword name="PropertiesDialog.__populateLicenseComboBox" id="PropertiesDialog.__populateLicenseComboBox" ref="eric7.Project.PropertiesDialog.html#PropertiesDialog.__populateLicenseComboBox" />
+      <keyword name="PropertiesDialog.__setMainScriptPickerFilters" id="PropertiesDialog.__setMainScriptPickerFilters" ref="eric7.Project.PropertiesDialog.html#PropertiesDialog.__setMainScriptPickerFilters" />
       <keyword name="PropertiesDialog.getPPath" id="PropertiesDialog.getPPath" ref="eric7.Project.PropertiesDialog.html#PropertiesDialog.getPPath" />
       <keyword name="PropertiesDialog.getProjectType" id="PropertiesDialog.getProjectType" ref="eric7.Project.PropertiesDialog.html#PropertiesDialog.getProjectType" />
       <keyword name="PropertiesDialog.on_dirPicker_textChanged" id="PropertiesDialog.on_dirPicker_textChanged" ref="eric7.Project.PropertiesDialog.html#PropertiesDialog.on_dirPicker_textChanged" />
@@ -14961,6 +14967,7 @@
       <keyword name="Shell.__showCompletions" id="Shell.__showCompletions" ref="eric7.QScintilla.Shell.html#Shell.__showCompletions" />
       <keyword name="Shell.__showContextMenu" id="Shell.__showContextMenu" ref="eric7.QScintilla.Shell.html#Shell.__showContextMenu" />
       <keyword name="Shell.__showHelp" id="Shell.__showHelp" ref="eric7.QScintilla.Shell.html#Shell.__showHelp" />
+      <keyword name="Shell.__showSource" id="Shell.__showSource" ref="eric7.QScintilla.Shell.html#Shell.__showSource" />
       <keyword name="Shell.__showStartMenu" id="Shell.__showStartMenu" ref="eric7.QScintilla.Shell.html#Shell.__showStartMenu" />
       <keyword name="Shell.__showVenvName" id="Shell.__showVenvName" ref="eric7.QScintilla.Shell.html#Shell.__showVenvName" />
       <keyword name="Shell.__startDebugClient" id="Shell.__startDebugClient" ref="eric7.QScintilla.Shell.html#Shell.__startDebugClient" />
--- a/src/eric7/Documentation/Source/eric7.PipInterface.Pip.html	Mon Mar 04 11:45:12 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.PipInterface.Pip.html	Mon Mar 04 11:46:04 2024 +0100
@@ -175,6 +175,10 @@
 <td>Public method to install pip.</td>
 </tr>
 <tr>
+<td><a href="#Pip.installPyprojectDependencies">installPyprojectDependencies</a></td>
+<td>Public method to install the dependencies listed in a pyproject.toml file.</td>
+</tr>
+<tr>
 <td><a href="#Pip.installRequirements">installRequirements</a></td>
 <td>Public method to install packages as given in a requirements file.</td>
 </tr>
@@ -195,6 +199,10 @@
 <td>Public method to uninstall the given list of packages.</td>
 </tr>
 <tr>
+<td><a href="#Pip.uninstallPyprojectDependencies">uninstallPyprojectDependencies</a></td>
+<td>Public method to uninstall the dependencies listed in a pyproject.toml file.</td>
+</tr>
+<tr>
 <td><a href="#Pip.uninstallRequirements">uninstallRequirements</a></td>
 <td>Public method to uninstall packages as given in a requirements file.</td>
 </tr>
@@ -981,6 +989,20 @@
             directory
 </dd>
 </dl>
+<a NAME="Pip.installPyprojectDependencies" ID="Pip.installPyprojectDependencies"></a>
+<h4>Pip.installPyprojectDependencies</h4>
+<b>installPyprojectDependencies</b>(<i>venvName</i>)
+<p>
+        Public method to install the dependencies listed in a pyproject.toml file.
+</p>
+
+<dl>
+
+<dt><i>venvName</i> (str)</dt>
+<dd>
+name of the virtual environment to be used
+</dd>
+</dl>
 <a NAME="Pip.installRequirements" ID="Pip.installRequirements"></a>
 <h4>Pip.installRequirements</h4>
 <b>installRequirements</b>(<i>venvName</i>)
@@ -1088,6 +1110,20 @@
 bool
 </dd>
 </dl>
+<a NAME="Pip.uninstallPyprojectDependencies" ID="Pip.uninstallPyprojectDependencies"></a>
+<h4>Pip.uninstallPyprojectDependencies</h4>
+<b>uninstallPyprojectDependencies</b>(<i>venvName</i>)
+<p>
+        Public method to uninstall the dependencies listed in a pyproject.toml file.
+</p>
+
+<dl>
+
+<dt><i>venvName</i> (str)</dt>
+<dd>
+name of the virtual environment to be used
+</dd>
+</dl>
 <a NAME="Pip.uninstallRequirements" ID="Pip.uninstallRequirements"></a>
 <h4>Pip.uninstallRequirements</h4>
 <b>uninstallRequirements</b>(<i>venvName</i>)
--- a/src/eric7/Documentation/Source/eric7.PipInterface.PipPackagesWidget.html	Mon Mar 04 11:45:12 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.PipInterface.PipPackagesWidget.html	Mon Mar 04 11:46:04 2024 +0100
@@ -184,6 +184,10 @@
 <td>Private slot to install pip into the user site for the selected environment.</td>
 </tr>
 <tr>
+<td><a href="#PipPackagesWidget.__installPyprojectDependencies">__installPyprojectDependencies</a></td>
+<td>Private slot to install packages as given in a 'pyproject.toml' file.</td>
+</tr>
+<tr>
 <td><a href="#PipPackagesWidget.__installRequirements">__installRequirements</a></td>
 <td>Private slot to install packages as given in a requirements file.</td>
 </tr>
@@ -276,6 +280,10 @@
 <td>Private method to show the detected vulnerability data.</td>
 </tr>
 <tr>
+<td><a href="#PipPackagesWidget.__uninstallPyprojectDependencies">__uninstallPyprojectDependencies</a></td>
+<td>Private slot to uninstall packages as given in a 'pyproject.toml' file.</td>
+</tr>
+<tr>
 <td><a href="#PipPackagesWidget.__uninstallRequirements">__uninstallRequirements</a></td>
 <td>Private slot to uninstall packages as given in a requirements file.</td>
 </tr>
@@ -695,6 +703,13 @@
         environment.
 </p>
 
+<a NAME="PipPackagesWidget.__installPyprojectDependencies" ID="PipPackagesWidget.__installPyprojectDependencies"></a>
+<h4>PipPackagesWidget.__installPyprojectDependencies</h4>
+<b>__installPyprojectDependencies</b>(<i></i>)
+<p>
+        Private slot to install packages as given in a 'pyproject.toml' file.
+</p>
+
 <a NAME="PipPackagesWidget.__installRequirements" ID="PipPackagesWidget.__installRequirements"></a>
 <h4>PipPackagesWidget.__installRequirements</h4>
 <b>__installRequirements</b>(<i></i>)
@@ -962,6 +977,13 @@
 list of vulnerabilities
 </dd>
 </dl>
+<a NAME="PipPackagesWidget.__uninstallPyprojectDependencies" ID="PipPackagesWidget.__uninstallPyprojectDependencies"></a>
+<h4>PipPackagesWidget.__uninstallPyprojectDependencies</h4>
+<b>__uninstallPyprojectDependencies</b>(<i></i>)
+<p>
+        Private slot to uninstall packages as given in a 'pyproject.toml' file.
+</p>
+
 <a NAME="PipPackagesWidget.__uninstallRequirements" ID="PipPackagesWidget.__uninstallRequirements"></a>
 <h4>PipPackagesWidget.__uninstallRequirements</h4>
 <b>__uninstallRequirements</b>(<i></i>)
--- a/src/eric7/Documentation/Source/eric7.Project.Project.html	Mon Mar 04 11:45:12 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Project.Project.html	Mon Mar 04 11:46:04 2024 +0100
@@ -238,6 +238,10 @@
 <td>Private method to clean up make related stuff.</td>
 </tr>
 <tr>
+<td><a href="#Project.__clearByteCodeCaches">__clearByteCodeCaches</a></td>
+<td>Private method to recursively clear the byte code caches of a given directory.</td>
+</tr>
+<tr>
 <td><a href="#Project.__closeAllWindows">__closeAllWindows</a></td>
 <td>Private method to close all project related windows.</td>
 </tr>
@@ -1256,6 +1260,24 @@
         Private method to clean up make related stuff.
 </p>
 
+<a NAME="Project.__clearByteCodeCaches" ID="Project.__clearByteCodeCaches"></a>
+<h4>Project.__clearByteCodeCaches</h4>
+<b>__clearByteCodeCaches</b>(<i>directory=None</i>)
+<p>
+        Private method to recursively clear the byte code caches of a given directory.
+</p>
+<p>
+        Note: The byte code cache directiries are named '__pycache__'.
+</p>
+
+<dl>
+
+<dt><i>directory</i> (str (optional))</dt>
+<dd>
+directory name to clear byte code caches from (defaults to
+            None)
+</dd>
+</dl>
 <a NAME="Project.__closeAllWindows" ID="Project.__closeAllWindows"></a>
 <h4>Project.__closeAllWindows</h4>
 <b>__closeAllWindows</b>(<i></i>)
--- a/src/eric7/Documentation/Source/eric7.Project.PropertiesDialog.html	Mon Mar 04 11:45:12 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Project.PropertiesDialog.html	Mon Mar 04 11:46:04 2024 +0100
@@ -64,6 +64,10 @@
 <td>Private method to populate the license selector with the list of trove license types.</td>
 </tr>
 <tr>
+<td><a href="#PropertiesDialog.__setMainScriptPickerFilters">__setMainScriptPickerFilters</a></td>
+<td>Private method to set the filters for the main script file picker.</td>
+</tr>
+<tr>
 <td><a href="#PropertiesDialog.getPPath">getPPath</a></td>
 <td>Public method to get the project path.</td>
 </tr>
@@ -156,11 +160,18 @@
 </dl>
 <a NAME="PropertiesDialog.__initFileTypesDict" ID="PropertiesDialog.__initFileTypesDict"></a>
 <h4>PropertiesDialog.__initFileTypesDict</h4>
-<b>__initFileTypesDict</b>(<i></i>)
+<b>__initFileTypesDict</b>(<i>force=False</i>)
 <p>
         Private slot to (re-)initialize the filetype dictionary.
 </p>
 
+<dl>
+
+<dt><i>force</i> (bool (optional))</dt>
+<dd>
+flag indicating to force the initialization (defaults to False)
+</dd>
+</dl>
 <a NAME="PropertiesDialog.__populateLicenseComboBox" ID="PropertiesDialog.__populateLicenseComboBox"></a>
 <h4>PropertiesDialog.__populateLicenseComboBox</h4>
 <b>__populateLicenseComboBox</b>(<i></i>)
@@ -169,6 +180,13 @@
         license types.
 </p>
 
+<a NAME="PropertiesDialog.__setMainScriptPickerFilters" ID="PropertiesDialog.__setMainScriptPickerFilters"></a>
+<h4>PropertiesDialog.__setMainScriptPickerFilters</h4>
+<b>__setMainScriptPickerFilters</b>(<i></i>)
+<p>
+        Private method to set the filters for the main script file picker.
+</p>
+
 <a NAME="PropertiesDialog.getPPath" ID="PropertiesDialog.getPPath"></a>
 <h4>PropertiesDialog.getPPath</h4>
 <b>getPPath</b>(<i></i>)
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Shell.html	Mon Mar 04 11:45:12 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.QScintilla.Shell.html	Mon Mar 04 11:46:04 2024 +0100
@@ -371,6 +371,10 @@
 <td>Private slot to show the list of supported special commands (i.e.</td>
 </tr>
 <tr>
+<td><a href="#Shell.__showSource">__showSource</a></td>
+<td>Private method to open an editor for an exception line.</td>
+</tr>
+<tr>
 <td><a href="#Shell.__showStartMenu">__showStartMenu</a></td>
 <td>Private slot to prepare the start submenu.</td>
 </tr>
@@ -1488,6 +1492,16 @@
         starting with a '%' character.
 </p>
 
+<a NAME="Shell.__showSource" ID="Shell.__showSource"></a>
+<h4>Shell.__showSource</h4>
+<b>__showSource</b>(<i></i>)
+<p>
+        Private method to open an editor for an exception line.
+</p>
+<p>
+        Note: The exception line looks like 'File: /path/of/file.py, Line: 111'.
+</p>
+
 <a NAME="Shell.__showStartMenu" ID="Shell.__showStartMenu"></a>
 <h4>Shell.__showStartMenu</h4>
 <b>__showStartMenu</b>(<i></i>)

eric ide

mercurial