Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.SecurityChecker.html

src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.SecurityChecker.html

branch
eric7
changeset 10479
856476537696
parent 9209
b99e7fd55fd3
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.Security.SecurityChecker</h1> 9 <h1>eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.SecurityChecker</h1>
10
11 <p> 10 <p>
12 Module implementing the security checker. 11 Module implementing the security checker.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#SecurityChecker">SecurityChecker</a></td> 22 <td><a href="#SecurityChecker">SecurityChecker</a></td>
25 <td>Class implementing a checker for security issues.</td> 23 <td>Class implementing a checker for security issues.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table> 29 <tr><td>None</td></tr>
31 <tr><td>None</td></tr> 30 </table>
32 </table> 31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="SecurityChecker" ID="SecurityChecker"></a> 34 <a NAME="SecurityChecker" ID="SecurityChecker"></a>
36 <h2>SecurityChecker</h2> 35 <h2>SecurityChecker</h2>
37
38 <p> 36 <p>
39 Class implementing a checker for security issues. 37 Class implementing a checker for security 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 48 <table>
50 <table> 49 <tr><td>None</td></tr>
51 <tr><td>None</td></tr> 50 </table>
52 </table> 51
53 <h3>Methods</h3> 52 <h3>Methods</h3>
54 53 <table>
55 <table>
56
57 <tr> 54 <tr>
58 <td><a href="#SecurityChecker.__init__">SecurityChecker</a></td> 55 <td><a href="#SecurityChecker.__init__">SecurityChecker</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="#SecurityChecker.run">run</a></td> 71 <td><a href="#SecurityChecker.run">run</a></td>
75 <td>Public method to check the given source against security related conditions.</td> 72 <td>Public method to check the given source against security related conditions.</td>
76 </tr> 73 </tr>
77 </table> 74 </table>
75
78 <h3>Static Methods</h3> 76 <h3>Static Methods</h3>
79 77 <table>
80 <table> 78 <tr><td>None</td></tr>
81 <tr><td>None</td></tr> 79 </table>
82 </table> 80
83 81
84 <a NAME="SecurityChecker.__init__" ID="SecurityChecker.__init__"></a> 82 <a NAME="SecurityChecker.__init__" ID="SecurityChecker.__init__"></a>
85 <h4>SecurityChecker (Constructor)</h4> 83 <h4>SecurityChecker (Constructor)</h4>
86 <b>SecurityChecker</b>(<i>source, filename, tree, select, ignore, expected, repeat, args</i>) 84 <b>SecurityChecker</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="SecurityChecker.__ignoreCode" ID="SecurityChecker.__ignoreCode"></a> 124 <a NAME="SecurityChecker.__ignoreCode" ID="SecurityChecker.__ignoreCode"></a>
127 <h4>SecurityChecker.__ignoreCode</h4> 125 <h4>SecurityChecker.__ignoreCode</h4>
128 <b>__ignoreCode</b>(<i>code</i>) 126 <b>__ignoreCode</b>(<i>code</i>)
129
130 <p> 127 <p>
131 Private method to check if the message code should be ignored. 128 Private method to check if the message code should be ignored.
132 </p> 129 </p>
130
133 <dl> 131 <dl>
134 132
135 <dt><i>code</i> (str)</dt> 133 <dt><i>code</i> (str)</dt>
136 <dd> 134 <dd>
137 message code to check for 135 message code to check for
150 </dd> 148 </dd>
151 </dl> 149 </dl>
152 <a NAME="SecurityChecker.getConfig" ID="SecurityChecker.getConfig"></a> 150 <a NAME="SecurityChecker.getConfig" ID="SecurityChecker.getConfig"></a>
153 <h4>SecurityChecker.getConfig</h4> 151 <h4>SecurityChecker.getConfig</h4>
154 <b>getConfig</b>(<i></i>) 152 <b>getConfig</b>(<i></i>)
155
156 <p> 153 <p>
157 Public method to get the configuration dictionary. 154 Public method to get the configuration dictionary.
158 </p> 155 </p>
156
159 <dl> 157 <dl>
160 <dt>Return:</dt> 158 <dt>Return:</dt>
161 <dd> 159 <dd>
162 dictionary containing the configuration 160 dictionary containing the configuration
163 </dd> 161 </dd>
169 </dd> 167 </dd>
170 </dl> 168 </dl>
171 <a NAME="SecurityChecker.reportError" ID="SecurityChecker.reportError"></a> 169 <a NAME="SecurityChecker.reportError" ID="SecurityChecker.reportError"></a>
172 <h4>SecurityChecker.reportError</h4> 170 <h4>SecurityChecker.reportError</h4>
173 <b>reportError</b>(<i>lineNumber, offset, code, severity, confidence, *args</i>) 171 <b>reportError</b>(<i>lineNumber, offset, code, severity, confidence, *args</i>)
174
175 <p> 172 <p>
176 Public method to record an issue. 173 Public method to record an issue.
177 </p> 174 </p>
175
178 <dl> 176 <dl>
179 177
180 <dt><i>lineNumber</i> (int)</dt> 178 <dt><i>lineNumber</i> (int)</dt>
181 <dd> 179 <dd>
182 line number of the issue 180 line number of the issue
205 </dd> 203 </dd>
206 </dl> 204 </dl>
207 <a NAME="SecurityChecker.run" ID="SecurityChecker.run"></a> 205 <a NAME="SecurityChecker.run" ID="SecurityChecker.run"></a>
208 <h4>SecurityChecker.run</h4> 206 <h4>SecurityChecker.run</h4>
209 <b>run</b>(<i></i>) 207 <b>run</b>(<i></i>)
210
211 <p> 208 <p>
212 Public method to check the given source against security related 209 Public method to check the given source against security related
213 conditions. 210 conditions.
214 </p> 211 </p>
212
215 <div align="right"><a href="#top">Up</a></div> 213 <div align="right"><a href="#top">Up</a></div>
216 <hr /> 214 <hr />
217 </body></html> 215 </body></html>

Mercurial Repository: eric

eric ide

mercurial