Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Logging.LoggingChecker.html
src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Logging.LoggingChecker.html
- branch
- eric7
- changeset 10479
- 856476537696
- parent 10368
- 8765229e7cc8
- child 11150
- 73d80859079c
equal
deleted
inserted
replaced
| 10478:de9106c55c3d | 10479:856476537696 |
|---|---|
| 5 <link rel="stylesheet" href="styles.css"> | 5 <link rel="stylesheet" href="styles.css"> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <a NAME="top" ID="top"></a> | 8 <a NAME="top" ID="top"></a> |
| 9 <h1>eric7.Plugins.CheckerPlugins.CodeStyleChecker.Logging.LoggingChecker</h1> | 9 <h1>eric7.Plugins.CheckerPlugins.CodeStyleChecker.Logging.LoggingChecker</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing a checker for logging related issues. | 11 Module implementing a checker for logging related issues. |
| 13 </p> | 12 </p> |
| 13 | |
| 14 <h3>Global Attributes</h3> | 14 <h3>Global Attributes</h3> |
| 15 | |
| 16 <table> | 15 <table> |
| 17 <tr><td>None</td></tr> | 16 <tr><td>None</td></tr> |
| 18 </table> | 17 </table> |
| 18 | |
| 19 <h3>Classes</h3> | 19 <h3>Classes</h3> |
| 20 | |
| 21 <table> | 20 <table> |
| 22 | |
| 23 <tr> | 21 <tr> |
| 24 <td><a href="#LoggingChecker">LoggingChecker</a></td> | 22 <td><a href="#LoggingChecker">LoggingChecker</a></td> |
| 25 <td>Class implementing a checker for logging related issues.</td> | 23 <td>Class implementing a checker for logging related issues.</td> |
| 26 </tr> | 24 </tr> |
| 27 </table> | 25 </table> |
| 26 | |
| 28 <h3>Functions</h3> | 27 <h3>Functions</h3> |
| 29 | |
| 30 <table> | 28 <table> |
| 31 <tr><td>None</td></tr> | 29 <tr><td>None</td></tr> |
| 32 </table> | 30 </table> |
| 31 | |
| 33 <hr /> | 32 <hr /> |
| 34 <hr /> | 33 <hr /> |
| 35 <a NAME="LoggingChecker" ID="LoggingChecker"></a> | 34 <a NAME="LoggingChecker" ID="LoggingChecker"></a> |
| 36 <h2>LoggingChecker</h2> | 35 <h2>LoggingChecker</h2> |
| 37 | |
| 38 <p> | 36 <p> |
| 39 Class implementing a checker for logging related issues. | 37 Class implementing a checker for logging related issues. |
| 40 </p> | 38 </p> |
| 39 | |
| 41 <h3>Derived from</h3> | 40 <h3>Derived from</h3> |
| 42 None | 41 None |
| 43 <h3>Class Attributes</h3> | 42 <h3>Class Attributes</h3> |
| 44 | |
| 45 <table> | 43 <table> |
| 46 <tr><td>Codes</td></tr> | 44 <tr><td>Codes</td></tr> |
| 47 </table> | 45 </table> |
| 46 | |
| 48 <h3>Class Methods</h3> | 47 <h3>Class Methods</h3> |
| 49 | |
| 50 <table> | 48 <table> |
| 51 <tr><td>None</td></tr> | 49 <tr><td>None</td></tr> |
| 52 </table> | 50 </table> |
| 51 | |
| 53 <h3>Methods</h3> | 52 <h3>Methods</h3> |
| 54 | |
| 55 <table> | 53 <table> |
| 56 | |
| 57 <tr> | 54 <tr> |
| 58 <td><a href="#LoggingChecker.__init__">LoggingChecker</a></td> | 55 <td><a href="#LoggingChecker.__init__">LoggingChecker</a></td> |
| 59 <td>Constructor</td> | 56 <td>Constructor</td> |
| 60 </tr> | 57 </tr> |
| 61 <tr> | 58 <tr> |
| 73 <tr> | 70 <tr> |
| 74 <td><a href="#LoggingChecker.run">run</a></td> | 71 <td><a href="#LoggingChecker.run">run</a></td> |
| 75 <td>Public method to check the given source against miscellaneous conditions.</td> | 72 <td>Public method to check the given source against miscellaneous conditions.</td> |
| 76 </tr> | 73 </tr> |
| 77 </table> | 74 </table> |
| 75 | |
| 78 <h3>Static Methods</h3> | 76 <h3>Static Methods</h3> |
| 79 | |
| 80 <table> | 77 <table> |
| 81 <tr><td>None</td></tr> | 78 <tr><td>None</td></tr> |
| 82 </table> | 79 </table> |
| 83 | 80 |
| 81 | |
| 84 <a NAME="LoggingChecker.__init__" ID="LoggingChecker.__init__"></a> | 82 <a NAME="LoggingChecker.__init__" ID="LoggingChecker.__init__"></a> |
| 85 <h4>LoggingChecker (Constructor)</h4> | 83 <h4>LoggingChecker (Constructor)</h4> |
| 86 <b>LoggingChecker</b>(<i>source, filename, tree, select, ignore, expected, repeat, args</i>) | 84 <b>LoggingChecker</b>(<i>source, filename, tree, select, ignore, expected, repeat, args</i>) |
| 87 | |
| 88 <p> | 85 <p> |
| 89 Constructor | 86 Constructor |
| 90 </p> | 87 </p> |
| 88 | |
| 91 <dl> | 89 <dl> |
| 92 | 90 |
| 93 <dt><i>source</i> (list of str)</dt> | 91 <dt><i>source</i> (list of str)</dt> |
| 94 <dd> | 92 <dd> |
| 95 source code to be checked | 93 source code to be checked |
| 124 </dd> | 122 </dd> |
| 125 </dl> | 123 </dl> |
| 126 <a NAME="LoggingChecker.__checkLogging" ID="LoggingChecker.__checkLogging"></a> | 124 <a NAME="LoggingChecker.__checkLogging" ID="LoggingChecker.__checkLogging"></a> |
| 127 <h4>LoggingChecker.__checkLogging</h4> | 125 <h4>LoggingChecker.__checkLogging</h4> |
| 128 <b>__checkLogging</b>(<i></i>) | 126 <b>__checkLogging</b>(<i></i>) |
| 129 | |
| 130 <p> | 127 <p> |
| 131 Private method to check logging statements. | 128 Private method to check logging statements. |
| 132 </p> | 129 </p> |
| 130 | |
| 133 <a NAME="LoggingChecker.__error" ID="LoggingChecker.__error"></a> | 131 <a NAME="LoggingChecker.__error" ID="LoggingChecker.__error"></a> |
| 134 <h4>LoggingChecker.__error</h4> | 132 <h4>LoggingChecker.__error</h4> |
| 135 <b>__error</b>(<i>lineNumber, offset, code, *args</i>) | 133 <b>__error</b>(<i>lineNumber, offset, code, *args</i>) |
| 136 | |
| 137 <p> | 134 <p> |
| 138 Private method to record an issue. | 135 Private method to record an issue. |
| 139 </p> | 136 </p> |
| 137 | |
| 140 <dl> | 138 <dl> |
| 141 | 139 |
| 142 <dt><i>lineNumber</i> (int)</dt> | 140 <dt><i>lineNumber</i> (int)</dt> |
| 143 <dd> | 141 <dd> |
| 144 line number of the issue | 142 line number of the issue |
| 157 </dd> | 155 </dd> |
| 158 </dl> | 156 </dl> |
| 159 <a NAME="LoggingChecker.__ignoreCode" ID="LoggingChecker.__ignoreCode"></a> | 157 <a NAME="LoggingChecker.__ignoreCode" ID="LoggingChecker.__ignoreCode"></a> |
| 160 <h4>LoggingChecker.__ignoreCode</h4> | 158 <h4>LoggingChecker.__ignoreCode</h4> |
| 161 <b>__ignoreCode</b>(<i>code</i>) | 159 <b>__ignoreCode</b>(<i>code</i>) |
| 162 | |
| 163 <p> | 160 <p> |
| 164 Private method to check if the message code should be ignored. | 161 Private method to check if the message code should be ignored. |
| 165 </p> | 162 </p> |
| 163 | |
| 166 <dl> | 164 <dl> |
| 167 | 165 |
| 168 <dt><i>code</i> (str)</dt> | 166 <dt><i>code</i> (str)</dt> |
| 169 <dd> | 167 <dd> |
| 170 message code to check for | 168 message code to check for |
| 183 </dd> | 181 </dd> |
| 184 </dl> | 182 </dl> |
| 185 <a NAME="LoggingChecker.run" ID="LoggingChecker.run"></a> | 183 <a NAME="LoggingChecker.run" ID="LoggingChecker.run"></a> |
| 186 <h4>LoggingChecker.run</h4> | 184 <h4>LoggingChecker.run</h4> |
| 187 <b>run</b>(<i></i>) | 185 <b>run</b>(<i></i>) |
| 188 | |
| 189 <p> | 186 <p> |
| 190 Public method to check the given source against miscellaneous | 187 Public method to check the given source against miscellaneous |
| 191 conditions. | 188 conditions. |
| 192 </p> | 189 </p> |
| 190 | |
| 193 <div align="right"><a href="#top">Up</a></div> | 191 <div align="right"><a href="#top">Up</a></div> |
| 194 <hr /> | 192 <hr /> |
| 195 </body></html> | 193 </body></html> |
