src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.prohibitedImports.html

branch
eric7
changeset 10503
6a37b6ac3928
child 10684
58c7f23ae1cb
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.prohibitedImports.html	Tue Jan 16 14:18:52 2024 +0100
@@ -0,0 +1,85 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.prohibitedImports</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.prohibitedImports</h1>
+<p>
+Module implementing checks for prohibited imports.
+</p>
+
+<h3>Global Attributes</h3>
+<table>
+<tr><td>_prohibitedImports</td></tr>
+</table>
+
+<h3>Classes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Functions</h3>
+<table>
+<tr>
+<td><a href="#checkProhibitedImports">checkProhibitedImports</a></td>
+<td>Function to check for prohibited imports.</td>
+</tr>
+<tr>
+<td><a href="#getChecks">getChecks</a></td>
+<td>Public method to get a dictionary with checks handled by this module.</td>
+</tr>
+</table>
+
+<hr />
+<hr />
+<a NAME="checkProhibitedImports" ID="checkProhibitedImports"></a>
+<h2>checkProhibitedImports</h2>
+<b>checkProhibitedImports</b>(<i>reportError, context, config</i>)
+<p>
+    Function to check for prohibited imports.
+</p>
+
+<dl>
+
+<dt><i>reportError</i> (func)</dt>
+<dd>
+function to be used to report errors
+</dd>
+<dt><i>context</i> (SecurityContext)</dt>
+<dd>
+security context object
+</dd>
+<dt><i>config</i> (dict)</dt>
+<dd>
+dictionary with configuration data
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="getChecks" ID="getChecks"></a>
+<h2>getChecks</h2>
+<b>getChecks</b>(<i></i>)
+<p>
+    Public method to get a dictionary with checks handled by this module.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+dictionary containing checker lists containing checker function and
+        list of codes
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>

eric ide

mercurial