--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Logging.LoggingChecker.html Fri Dec 01 16:22:02 2023 +0100 @@ -0,0 +1,195 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.Plugins.CheckerPlugins.CodeStyleChecker.Logging.LoggingChecker</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.Plugins.CheckerPlugins.CodeStyleChecker.Logging.LoggingChecker</h1> + +<p> +Module implementing a checker for logging related issues. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#LoggingChecker">LoggingChecker</a></td> +<td>Class implementing a checker for logging related issues.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="LoggingChecker" ID="LoggingChecker"></a> +<h2>LoggingChecker</h2> + +<p> + Class implementing a checker for logging related issues. +</p> +<h3>Derived from</h3> +None +<h3>Class Attributes</h3> + +<table> +<tr><td>Codes</td></tr> +</table> +<h3>Class Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> + +<table> + +<tr> +<td><a href="#LoggingChecker.__init__">LoggingChecker</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#LoggingChecker.__checkLogging">__checkLogging</a></td> +<td>Private method to check logging statements.</td> +</tr> +<tr> +<td><a href="#LoggingChecker.__error">__error</a></td> +<td>Private method to record an issue.</td> +</tr> +<tr> +<td><a href="#LoggingChecker.__ignoreCode">__ignoreCode</a></td> +<td>Private method to check if the message code should be ignored.</td> +</tr> +<tr> +<td><a href="#LoggingChecker.run">run</a></td> +<td>Public method to check the given source against miscellaneous conditions.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="LoggingChecker.__init__" ID="LoggingChecker.__init__"></a> +<h4>LoggingChecker (Constructor)</h4> +<b>LoggingChecker</b>(<i>source, filename, tree, select, ignore, expected, repeat, args</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>source</i> (list of str)</dt> +<dd> +source code to be checked +</dd> +<dt><i>filename</i> (str)</dt> +<dd> +name of the source file +</dd> +<dt><i>tree</i> (ast.Module)</dt> +<dd> +AST tree of the source code +</dd> +<dt><i>select</i> (list of str)</dt> +<dd> +list of selected codes +</dd> +<dt><i>ignore</i> (list of str)</dt> +<dd> +list of codes to be ignored +</dd> +<dt><i>expected</i> (list of str)</dt> +<dd> +list of expected codes +</dd> +<dt><i>repeat</i> (bool)</dt> +<dd> +flag indicating to report each occurrence of a code +</dd> +<dt><i>args</i> (dict)</dt> +<dd> +dictionary of arguments for the various checks +</dd> +</dl> +<a NAME="LoggingChecker.__checkLogging" ID="LoggingChecker.__checkLogging"></a> +<h4>LoggingChecker.__checkLogging</h4> +<b>__checkLogging</b>(<i></i>) + +<p> + Private method to check logging statements. +</p> +<a NAME="LoggingChecker.__error" ID="LoggingChecker.__error"></a> +<h4>LoggingChecker.__error</h4> +<b>__error</b>(<i>lineNumber, offset, code, *args</i>) + +<p> + Private method to record an issue. +</p> +<dl> + +<dt><i>lineNumber</i> (int)</dt> +<dd> +line number of the issue +</dd> +<dt><i>offset</i> (int)</dt> +<dd> +position within line of the issue +</dd> +<dt><i>code</i> (str)</dt> +<dd> +message code +</dd> +<dt><i>args</i> (list)</dt> +<dd> +arguments for the message +</dd> +</dl> +<a NAME="LoggingChecker.__ignoreCode" ID="LoggingChecker.__ignoreCode"></a> +<h4>LoggingChecker.__ignoreCode</h4> +<b>__ignoreCode</b>(<i>code</i>) + +<p> + Private method to check if the message code should be ignored. +</p> +<dl> + +<dt><i>code</i> (str)</dt> +<dd> +message code to check for +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating to ignore the given code +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="LoggingChecker.run" ID="LoggingChecker.run"></a> +<h4>LoggingChecker.run</h4> +<b>run</b>(<i></i>) + +<p> + Public method to check the given source against miscellaneous + conditions. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file