diff -r de9106c55c3d -r 856476537696 src/eric7/Documentation/Source/eric7.PipInterface.PipVulnerabilityChecker.html
--- a/src/eric7/Documentation/Source/eric7.PipInterface.PipVulnerabilityChecker.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.PipInterface.PipVulnerabilityChecker.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,7 +7,6 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.PipInterface.PipVulnerabilityChecker</h1>
-
<p>
Module implementing a Python package vulnerability checker.
</p>
@@ -15,15 +14,14 @@
The vulnerability data is provided by the open Python vulnerability database
<a href="https://github.com/pyupio/safety-db">Safety DB</a>.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#Package">Package</a></td>
<td>Class containing the package data.</td>
@@ -41,67 +39,68 @@
<td>Class defining various vulnerability check error states.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="Package" ID="Package"></a>
<h2>Package</h2>
-
<p>
Class containing the package data.
</p>
+
<h3>Derived from</h3>
None
<h3>Class Attributes</h3>
+<table>
+<tr><td>name</td></tr>
+<tr><td>version</td></tr>
+</table>
-<table>
-<tr><td>name</td></tr><tr><td>version</td></tr>
-</table>
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="PipVulnerabilityChecker" ID="PipVulnerabilityChecker"></a>
<h2>PipVulnerabilityChecker</h2>
-
<p>
Class implementing a Python package vulnerability checker.
</p>
+
<h3>Derived from</h3>
QObject
<h3>Class Attributes</h3>
+<table>
+<tr><td>FullDbFile</td></tr>
+<tr><td>SummaryDbFile</td></tr>
+</table>
-<table>
-<tr><td>FullDbFile</td></tr><tr><td>SummaryDbFile</td></tr>
-</table>
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#PipVulnerabilityChecker.__init__">PipVulnerabilityChecker</a></td>
<td>Constructor</td>
@@ -135,19 +134,20 @@
<td>Public method to update the cache of the vulnerability databases.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="PipVulnerabilityChecker.__init__" ID="PipVulnerabilityChecker.__init__"></a>
<h4>PipVulnerabilityChecker (Constructor)</h4>
<b>PipVulnerabilityChecker</b>(<i>pip, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>pip</i> (Pip)</dt>
@@ -162,7 +162,6 @@
<a NAME="PipVulnerabilityChecker.__createCacheFile" ID="PipVulnerabilityChecker.__createCacheFile"></a>
<h4>PipVulnerabilityChecker.__createCacheFile</h4>
<b>__createCacheFile</b>(<i></i>)
-
<p>
Private method to create the cache file.
</p>
@@ -179,10 +178,10 @@
},
}
</p>
+
<a NAME="PipVulnerabilityChecker.__fetchVulnerabilityDatabase" ID="PipVulnerabilityChecker.__fetchVulnerabilityDatabase"></a>
<h4>PipVulnerabilityChecker.__fetchVulnerabilityDatabase</h4>
<b>__fetchVulnerabilityDatabase</b>(<i>full=False, forceUpdate=False</i>)
-
<p>
Private method to get the data of the vulnerability database.
</p>
@@ -191,6 +190,7 @@
Otherwise a copy of the requested database will be downloaded
and cached.
</p>
+
<dl>
<dt><i>full</i> (bool (optional))</dt>
@@ -220,10 +220,10 @@
<a NAME="PipVulnerabilityChecker.__getDataFromCache" ID="PipVulnerabilityChecker.__getDataFromCache"></a>
<h4>PipVulnerabilityChecker.__getDataFromCache</h4>
<b>__getDataFromCache</b>(<i>dbName</i>)
-
<p>
Private method to get the vulnerability database from the cache.
</p>
+
<dl>
<dt><i>dbName</i> (str)</dt>
@@ -246,10 +246,10 @@
<a NAME="PipVulnerabilityChecker.__getVulnerabilities" ID="PipVulnerabilityChecker.__getVulnerabilities"></a>
<h4>PipVulnerabilityChecker.__getVulnerabilities</h4>
<b>__getVulnerabilities</b>(<i>package, specifier, db</i>)
-
<p>
Private method to get the vulnerabilities for a package.
</p>
+
<dl>
<dt><i>package</i> (str)</dt>
@@ -280,11 +280,11 @@
<a NAME="PipVulnerabilityChecker.__writeDataToCache" ID="PipVulnerabilityChecker.__writeDataToCache"></a>
<h4>PipVulnerabilityChecker.__writeDataToCache</h4>
<b>__writeDataToCache</b>(<i>dbName, data</i>)
-
<p>
Private method to write the vulnerability data for a database to the
cache.
</p>
+
<dl>
<dt><i>dbName</i> (str)</dt>
@@ -299,10 +299,10 @@
<a NAME="PipVulnerabilityChecker.check" ID="PipVulnerabilityChecker.check"></a>
<h4>PipVulnerabilityChecker.check</h4>
<b>check</b>(<i>packages</i>)
-
<p>
Public method to check the given packages for vulnerabilities.
</p>
+
<dl>
<dt><i>packages</i> (Package)</dt>
@@ -326,74 +326,81 @@
<a NAME="PipVulnerabilityChecker.updateVulnerabilityDb" ID="PipVulnerabilityChecker.updateVulnerabilityDb"></a>
<h4>PipVulnerabilityChecker.updateVulnerabilityDb</h4>
<b>updateVulnerabilityDb</b>(<i></i>)
-
<p>
Public method to update the cache of the vulnerability databases.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="Vulnerability" ID="Vulnerability"></a>
<h2>Vulnerability</h2>
-
<p>
Class containing the vulnerability data.
</p>
+
<h3>Derived from</h3>
None
<h3>Class Attributes</h3>
+<table>
+<tr><td>advisory</td></tr>
+<tr><td>cve</td></tr>
+<tr><td>name</td></tr>
+<tr><td>spec</td></tr>
+<tr><td>version</td></tr>
+<tr><td>vulnerabilityId</td></tr>
+</table>
-<table>
-<tr><td>advisory</td></tr><tr><td>cve</td></tr><tr><td>name</td></tr><tr><td>spec</td></tr><tr><td>version</td></tr><tr><td>vulnerabilityId</td></tr>
-</table>
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="VulnerabilityCheckError" ID="VulnerabilityCheckError"></a>
<h2>VulnerabilityCheckError</h2>
-
<p>
Class defining various vulnerability check error states.
</p>
+
<h3>Derived from</h3>
enum.Enum
<h3>Class Attributes</h3>
-
<table>
-<tr><td>FullDbUnavailable</td></tr><tr><td>OK</td></tr><tr><td>SummaryDbUnavailable</td></tr>
+<tr><td>FullDbUnavailable</td></tr>
+<tr><td>OK</td></tr>
+<tr><td>SummaryDbUnavailable</td></tr>
</table>
-<h3>Class Methods</h3>
-<table>
-<tr><td>None</td></tr>
-</table>
-<h3>Methods</h3>
-
-<table>
-<tr><td>None</td></tr>
-</table>
-<h3>Static Methods</h3>
-
+<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
+<h3>Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
