Updated source documentation. eric7

Sat, 04 Jun 2022 16:58:05 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sat, 04 Jun 2022 16:58:05 +0200
branch
eric7
changeset 9123
aefb731a4b4e
parent 9122
ddf8ed8f7387
child 9124
a27836f4ad69

Updated source documentation.

eric7/APIs/Python3/eric7.api file | annotate | diff | comparison | revisions
eric7/Documentation/Help/source.qch file | annotate | diff | comparison | revisions
eric7/Documentation/Help/source.qhp file | annotate | diff | comparison | revisions
eric7/Documentation/Source/eric7.CycloneDXInterface.CycloneDXConfigDialog.html file | annotate | diff | comparison | revisions
eric7/Documentation/Source/eric7.CycloneDXInterface.CycloneDXUtilities.html file | annotate | diff | comparison | revisions
eric7/Documentation/Source/eric7.PipInterface.Pip.html file | annotate | diff | comparison | revisions
--- a/eric7/APIs/Python3/eric7.api	Sat Jun 04 16:57:02 2022 +0200
+++ b/eric7/APIs/Python3/eric7.api	Sat Jun 04 16:58:05 2022 +0200
@@ -175,7 +175,11 @@
 eric7.CycloneDXInterface.CycloneDXConfigDialog.CycloneDXConfigDialog.on_fileFormatComboBox_currentTextChanged?4(fileFormat)
 eric7.CycloneDXInterface.CycloneDXConfigDialog.CycloneDXConfigDialog?1(environment, parent=None)
 eric7.CycloneDXInterface.CycloneDXUtilities.CycloneDXEnvironmentParser?1(venvName)
+eric7.CycloneDXInterface.CycloneDXUtilities._addCycloneDXDependency?5(dependency, components)
+eric7.CycloneDXInterface.CycloneDXUtilities.addCycloneDXDependencies?4(parser, venvName)
+eric7.CycloneDXInterface.CycloneDXUtilities.addCycloneDXVulnerabilities?4(parser)
 eric7.CycloneDXInterface.CycloneDXUtilities.createCycloneDXFile?4(venvName)
+eric7.CycloneDXInterface.CycloneDXUtilities.findCyccloneDXComponent?4(components, name)
 eric7.DataViews.CodeMetrics.COMMENT?7
 eric7.DataViews.CodeMetrics.DEDENT?7
 eric7.DataViews.CodeMetrics.EMPTY?7
@@ -3034,7 +3038,7 @@
 eric7.PipInterface.Pip.Pip.cachePurge?4(venvName)
 eric7.PipInterface.Pip.Pip.cacheRemove?4(venvName)
 eric7.PipInterface.Pip.Pip.checkPackageOutdated?4(packageStart, envName)
-eric7.PipInterface.Pip.Pip.getDependecyTree?4(envName, localPackages=True, usersite=False, reverse=False)
+eric7.PipInterface.Pip.Pip.getDependencyTree?4(envName, localPackages=True, usersite=False, reverse=False)
 eric7.PipInterface.Pip.Pip.getFrozenPackages?4(envName, localPackages=True, usersite=False, requirement=None)
 eric7.PipInterface.Pip.Pip.getIndexUrl?4()
 eric7.PipInterface.Pip.Pip.getIndexUrlPypi?4()
Binary file eric7/Documentation/Help/source.qch has changed
--- a/eric7/Documentation/Help/source.qhp	Sat Jun 04 16:57:02 2022 +0200
+++ b/eric7/Documentation/Help/source.qhp	Sat Jun 04 16:58:05 2022 +0200
@@ -3294,6 +3294,7 @@
       <keyword name="CycloneDXConfigDialog" id="CycloneDXConfigDialog" ref="eric7.CycloneDXInterface.CycloneDXConfigDialog.html#CycloneDXConfigDialog" />
       <keyword name="CycloneDXConfigDialog (Constructor)" id="CycloneDXConfigDialog (Constructor)" ref="eric7.CycloneDXInterface.CycloneDXConfigDialog.html#CycloneDXConfigDialog.__init__" />
       <keyword name="CycloneDXConfigDialog (Module)" id="CycloneDXConfigDialog (Module)" ref="eric7.CycloneDXInterface.CycloneDXConfigDialog.html" />
+      <keyword name="CycloneDXConfigDialog.__repopulateSchemaVersionComboBox" id="CycloneDXConfigDialog.__repopulateSchemaVersionComboBox" ref="eric7.CycloneDXInterface.CycloneDXConfigDialog.html#CycloneDXConfigDialog.__repopulateSchemaVersionComboBox" />
       <keyword name="CycloneDXConfigDialog.getData" id="CycloneDXConfigDialog.getData" ref="eric7.CycloneDXInterface.CycloneDXConfigDialog.html#CycloneDXConfigDialog.getData" />
       <keyword name="CycloneDXConfigDialog.on_fileFormatComboBox_currentTextChanged" id="CycloneDXConfigDialog.on_fileFormatComboBox_currentTextChanged" ref="eric7.CycloneDXInterface.CycloneDXConfigDialog.html#CycloneDXConfigDialog.on_fileFormatComboBox_currentTextChanged" />
       <keyword name="CycloneDXEnvironmentParser" id="CycloneDXEnvironmentParser" ref="eric7.CycloneDXInterface.CycloneDXUtilities.html#CycloneDXEnvironmentParser" />
@@ -11288,7 +11289,7 @@
       <keyword name="Pip.cachePurge" id="Pip.cachePurge" ref="eric7.PipInterface.Pip.html#Pip.cachePurge" />
       <keyword name="Pip.cacheRemove" id="Pip.cacheRemove" ref="eric7.PipInterface.Pip.html#Pip.cacheRemove" />
       <keyword name="Pip.checkPackageOutdated" id="Pip.checkPackageOutdated" ref="eric7.PipInterface.Pip.html#Pip.checkPackageOutdated" />
-      <keyword name="Pip.getDependecyTree" id="Pip.getDependecyTree" ref="eric7.PipInterface.Pip.html#Pip.getDependecyTree" />
+      <keyword name="Pip.getDependencyTree" id="Pip.getDependencyTree" ref="eric7.PipInterface.Pip.html#Pip.getDependencyTree" />
       <keyword name="Pip.getFrozenPackages" id="Pip.getFrozenPackages" ref="eric7.PipInterface.Pip.html#Pip.getFrozenPackages" />
       <keyword name="Pip.getIndexUrl" id="Pip.getIndexUrl" ref="eric7.PipInterface.Pip.html#Pip.getIndexUrl" />
       <keyword name="Pip.getIndexUrlPypi" id="Pip.getIndexUrlPypi" ref="eric7.PipInterface.Pip.html#Pip.getIndexUrlPypi" />
@@ -18158,6 +18159,7 @@
       <keyword name="__syntaxAndPyflakesCheck" id="__syntaxAndPyflakesCheck" ref="eric7.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheck.html#__syntaxAndPyflakesCheck" />
       <keyword name="__tomlSyntaxCheck" id="__tomlSyntaxCheck" ref="eric7.Plugins.CheckerPlugins.SyntaxChecker.tomlCheckSyntax.html#__tomlSyntaxCheck" />
       <keyword name="__yamlSyntaxCheck" id="__yamlSyntaxCheck" ref="eric7.Plugins.CheckerPlugins.SyntaxChecker.yamlCheckSyntax.html#__yamlSyntaxCheck" />
+      <keyword name="_addCycloneDXDependency" id="_addCycloneDXDependency" ref="eric7.CycloneDXInterface.CycloneDXUtilities.html#_addCycloneDXDependency" />
       <keyword name="_add_check" id="_add_check" ref="eric7.Plugins.CheckerPlugins.CodeStyleChecker.pycodestyle.html#_add_check" />
       <keyword name="_assembleTestCasesList" id="_assembleTestCasesList" ref="eric7.Testing.Interfaces.UnittestRunner.html#_assembleTestCasesList" />
       <keyword name="_break_around_binary_operators" id="_break_around_binary_operators" ref="eric7.Plugins.CheckerPlugins.CodeStyleChecker.pycodestyle.html#_break_around_binary_operators" />
@@ -18185,6 +18187,8 @@
       <keyword name="absolutePath" id="absolutePath" ref="eric7.Utilities.__init__.html#absolutePath" />
       <keyword name="absoluteUniversalPath" id="absoluteUniversalPath" ref="eric7.Utilities.__init__.html#absoluteUniversalPath" />
       <keyword name="addActions" id="addActions" ref="eric7.EricGui.EricAction.html#addActions" />
+      <keyword name="addCycloneDXDependencies" id="addCycloneDXDependencies" ref="eric7.CycloneDXInterface.CycloneDXUtilities.html#addCycloneDXDependencies" />
+      <keyword name="addCycloneDXVulnerabilities" id="addCycloneDXVulnerabilities" ref="eric7.CycloneDXInterface.CycloneDXUtilities.html#addCycloneDXVulnerabilities" />
       <keyword name="addSearchPath" id="addSearchPath" ref="eric7.UI.PixmapCache.html#addSearchPath" />
       <keyword name="ambiguous_identifier" id="ambiguous_identifier" ref="eric7.Plugins.CheckerPlugins.CodeStyleChecker.pycodestyle.html#ambiguous_identifier" />
       <keyword name="amendConfig" id="amendConfig" ref="eric7.Plugins.VcsPlugins.vcsPySvn.SvnUtilities.html#amendConfig" />
@@ -18513,6 +18517,7 @@
       <keyword name="filterAnsiSequences" id="filterAnsiSequences" ref="eric7.Utilities.__init__.html#filterAnsiSequences" />
       <keyword name="filterCharsFromFilename" id="filterCharsFromFilename" ref="eric7.WebBrowser.Tools.WebBrowserTools.html#filterCharsFromFilename" />
       <keyword name="filterMessage" id="filterMessage" ref="eric7.EricWidgets.EricErrorMessage.html#filterMessage" />
+      <keyword name="findCyccloneDXComponent" id="findCyccloneDXComponent" ref="eric7.CycloneDXInterface.CycloneDXUtilities.html#findCyccloneDXComponent" />
       <keyword name="findVolume" id="findVolume" ref="eric7.Utilities.__init__.html#findVolume" />
       <keyword name="find_license_from_classifier" id="find_license_from_classifier" ref="eric7.PipInterface.piplicenses.html#find_license_from_classifier" />
       <keyword name="find_module" id="find_module" ref="eric7.Utilities.ClassBrowsers.__init__.html#find_module" />
--- a/eric7/Documentation/Source/eric7.CycloneDXInterface.CycloneDXConfigDialog.html	Sat Jun 04 16:57:02 2022 +0200
+++ b/eric7/Documentation/Source/eric7.CycloneDXInterface.CycloneDXConfigDialog.html	Sat Jun 04 16:58:05 2022 +0200
@@ -59,6 +59,10 @@
 <td>Constructor</td>
 </tr>
 <tr>
+<td><a href="#CycloneDXConfigDialog.__repopulateSchemaVersionComboBox">__repopulateSchemaVersionComboBox</a></td>
+<td>Private slot to repopulate the schema version selector.</td>
+</tr>
+<tr>
 <td><a href="#CycloneDXConfigDialog.getData">getData</a></td>
 <td>Public method to get the SBOM configuration data.</td>
 </tr>
@@ -91,6 +95,13 @@
 reference to the parent widget (defaults to None)
 </dd>
 </dl>
+<a NAME="CycloneDXConfigDialog.__repopulateSchemaVersionComboBox" ID="CycloneDXConfigDialog.__repopulateSchemaVersionComboBox"></a>
+<h4>CycloneDXConfigDialog.__repopulateSchemaVersionComboBox</h4>
+<b>__repopulateSchemaVersionComboBox</b>(<i></i>)
+
+<p>
+        Private slot to repopulate the schema version selector.
+</p>
 <a NAME="CycloneDXConfigDialog.getData" ID="CycloneDXConfigDialog.getData"></a>
 <h4>CycloneDXConfigDialog.getData</h4>
 <b>getData</b>(<i></i>)
@@ -102,14 +113,15 @@
 <dt>Return:</dt>
 <dd>
 tuple containing the input source, the input file name, the
-            file format, the schema version and the path of the SBOM file to
-            be written
+            file format, the schema version, the path of the SBOM file to be
+            written, a flag indicating to include vulnerability information
+            and a flag indicating to include dependency information
 </dd>
 </dl>
 <dl>
 <dt>Return Type:</dt>
 <dd>
-tuple of (str, str, str, str, str)
+tuple of (str, str, str, str, str, bool, bool)
 </dd>
 </dl>
 <a NAME="CycloneDXConfigDialog.on_fileFormatComboBox_currentTextChanged" ID="CycloneDXConfigDialog.on_fileFormatComboBox_currentTextChanged"></a>
--- a/eric7/Documentation/Source/eric7.CycloneDXInterface.CycloneDXUtilities.html	Sat Jun 04 16:57:02 2022 +0200
+++ b/eric7/Documentation/Source/eric7.CycloneDXInterface.CycloneDXUtilities.html	Sat Jun 04 16:58:05 2022 +0200
@@ -30,9 +30,25 @@
 <table>
 
 <tr>
+<td><a href="#_addCycloneDXDependency">_addCycloneDXDependency</a></td>
+<td>Function to add a dependency to the given list of components.</td>
+</tr>
+<tr>
+<td><a href="#addCycloneDXDependencies">addCycloneDXDependencies</a></td>
+<td>Function to add dependency data to the list of created components.</td>
+</tr>
+<tr>
+<td><a href="#addCycloneDXVulnerabilities">addCycloneDXVulnerabilities</a></td>
+<td>Function to add vulnerability data to the list of created components.</td>
+</tr>
+<tr>
 <td><a href="#createCycloneDXFile">createCycloneDXFile</a></td>
 <td>Function to create a CyccloneDX SBOM file.</td>
 </tr>
+<tr>
+<td><a href="#findCyccloneDXComponent">findCyccloneDXComponent</a></td>
+<td>Function to find a component in a given list of components.</td>
+</tr>
 </table>
 <hr />
 <hr />
@@ -86,6 +102,67 @@
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
+<a NAME="_addCycloneDXDependency" ID="_addCycloneDXDependency"></a>
+<h2>_addCycloneDXDependency</h2>
+<b>_addCycloneDXDependency</b>(<i>dependency, components</i>)
+
+<p>
+    Function to add a dependency to the given list of components.
+</p>
+<dl>
+
+<dt><i>dependency</i> (dict)</dt>
+<dd>
+dependency to be added
+</dd>
+<dt><i>components</i> (list of Component)</dt>
+<dd>
+list of components
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="addCycloneDXDependencies" ID="addCycloneDXDependencies"></a>
+<h2>addCycloneDXDependencies</h2>
+<b>addCycloneDXDependencies</b>(<i>parser, venvName</i>)
+
+<p>
+    Function to add dependency data to the list of created components.
+</p>
+<dl>
+
+<dt><i>parser</i> (BaseParser)</dt>
+<dd>
+reference to the parser object containing the list of
+        components
+</dd>
+<dt><i>venvName</i> (str)</dt>
+<dd>
+name of the virtual environment
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="addCycloneDXVulnerabilities" ID="addCycloneDXVulnerabilities"></a>
+<h2>addCycloneDXVulnerabilities</h2>
+<b>addCycloneDXVulnerabilities</b>(<i>parser</i>)
+
+<p>
+    Function to add vulnerability data to the list of created components.
+</p>
+<dl>
+
+<dt><i>parser</i> (BaseParser)</dt>
+<dd>
+reference to the parser object containing the list of
+        components
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
 <a NAME="createCycloneDXFile" ID="createCycloneDXFile"></a>
 <h2>createCycloneDXFile</h2>
 <b>createCycloneDXFile</b>(<i>venvName</i>)
@@ -109,4 +186,37 @@
 </dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
+<hr />
+<a NAME="findCyccloneDXComponent" ID="findCyccloneDXComponent"></a>
+<h2>findCyccloneDXComponent</h2>
+<b>findCyccloneDXComponent</b>(<i>components, name</i>)
+
+<p>
+    Function to find a component in a given list of components.
+</p>
+<dl>
+
+<dt><i>components</i> (list of Component)</dt>
+<dd>
+list of components to scan
+</dd>
+<dt><i>name</i> (str)</dt>
+<dd>
+name of the component to search for
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+reference to the found component or None
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+Component or None
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
 </body></html>
\ No newline at end of file
--- a/eric7/Documentation/Source/eric7.PipInterface.Pip.html	Sat Jun 04 16:57:02 2022 +0200
+++ b/eric7/Documentation/Source/eric7.PipInterface.Pip.html	Sat Jun 04 16:58:05 2022 +0200
@@ -83,7 +83,7 @@
 <td>Public method to check, if a group of packages is outdated.</td>
 </tr>
 <tr>
-<td><a href="#Pip.getDependecyTree">getDependecyTree</a></td>
+<td><a href="#Pip.getDependencyTree">getDependencyTree</a></td>
 <td>Public method to get the dependency tree of installed packages.</td>
 </tr>
 <tr>
@@ -339,9 +339,9 @@
 tuple of (bool, (str, str, str))
 </dd>
 </dl>
-<a NAME="Pip.getDependecyTree" ID="Pip.getDependecyTree"></a>
-<h4>Pip.getDependecyTree</h4>
-<b>getDependecyTree</b>(<i>envName, localPackages=True, usersite=False, reverse=False</i>)
+<a NAME="Pip.getDependencyTree" ID="Pip.getDependencyTree"></a>
+<h4>Pip.getDependencyTree</h4>
+<b>getDependencyTree</b>(<i>envName, localPackages=True, usersite=False, reverse=False</i>)
 
 <p>
         Public method to get the dependency tree of installed packages.

eric ide

mercurial