eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.__init__.html

Fri, 22 Jan 2021 16:48:43 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Fri, 22 Jan 2021 16:48:43 +0100
changeset 7998
cd41c844862f
parent 7989
a21d673a8f99
permissions
-rw-r--r--

Editor
- added functionality to insert docstring templates via the context menu (cursor placed on first line of function definition) or after entering the docstring start string (e.g. """ for Python)

7624
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
1 <!DOCTYPE html>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2 <html><head>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 <title>eric6.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.__init__</title>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
4 <meta charset="UTF-8">
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5 <style>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 body {
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
7 background: #EDECE6;
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 margin: 0em 1em 10em 1em;
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
9 color: black;
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10 }
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
11
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
12 h1 { color: white; background: #85774A; }
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
13 h2 { color: white; background: #85774A; }
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
14 h3 { color: white; background: #9D936E; }
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
15 h4 { color: white; background: #9D936E; }
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
16
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
17 a { color: #BA6D36; }
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
18
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19 </style>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20 </head>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
21 <body>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
22 <a NAME="top" ID="top"></a>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
23 <h1>eric6.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.__init__</h1>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
24
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
25 <p>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
26 Package containing the various security checker modules.
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27 </p>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28 <h3>Global Attributes</h3>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
29
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30 <table>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
31 <tr><td>None</td></tr>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 </table>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 <h3>Classes</h3>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
34
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
35 <table>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
36 <tr><td>None</td></tr>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37 </table>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38 <h3>Functions</h3>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
39
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
40 <table>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
41
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 <tr>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
43 <td><a href="#generateCheckersDict">generateCheckersDict</a></td>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44 <td>Function to generate the dictionary with checkers.</td>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
45 </tr>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
46 </table>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
47 <hr />
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
48 <hr />
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
49 <a NAME="generateCheckersDict" ID="generateCheckersDict"></a>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
50 <h2>generateCheckersDict</h2>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
51 <b>generateCheckersDict</b>(<i></i>)
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
52
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
53 <p>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
54 Function to generate the dictionary with checkers.
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
55 </p>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
56 <p>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
57 Checker modules are searched for inside this package. Each module
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
58 defining some checks must contain a function 'getChecks()' returning
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
59 a dictionary containing the check type as key and a list of tuples
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
60 with the check function and associated message codes.
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
61 </p>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
62 <dl>
7989
a21d673a8f99 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7624
diff changeset
63 <dt>Return:</dt>
7624
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
64 <dd>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
65 dictionary containing list of tuples with checker data
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
66 </dd>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
67 </dl>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
68 <dl>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
69 <dt>Return Type:</dt>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
70 <dd>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
71 dict
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
72 </dd>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
73 </dl>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
74 <div align="right"><a href="#top">Up</a></div>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
75 <hr />
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
76 </body></html>

eric ide

mercurial