10116
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1
|
<!DOCTYPE html> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
2
|
<html><head> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
3
|
<title>eric7.Plugins.CheckerPlugins.CodeStyleChecker.Async.AsyncChecker</title> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
4
|
<meta charset="UTF-8"> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
5
|
<link rel="stylesheet" href="styles.css"> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
6
|
</head> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
7
|
<body> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
8
|
<a NAME="top" ID="top"></a> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
9
|
<h1>eric7.Plugins.CheckerPlugins.CodeStyleChecker.Async.AsyncChecker</h1> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
10
|
<p> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
11
|
Module implementing a checker for "async" related issues. |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
12
|
</p> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
diff
changeset
|
13
|
|
10116
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
14
|
<h3>Global Attributes</h3> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
15
|
<table> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
16
|
<tr><td>None</td></tr> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
17
|
</table> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
diff
changeset
|
18
|
|
10116
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
19
|
<h3>Classes</h3> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
20
|
<table> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
21
|
<tr> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
22
|
<td><a href="#AsyncChecker">AsyncChecker</a></td> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
23
|
<td>Class implementing a checker for "async" related issues.</td> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
24
|
</tr> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
25
|
</table> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
diff
changeset
|
26
|
|
10116
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
27
|
<h3>Functions</h3> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
28
|
<table> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
29
|
<tr><td>None</td></tr> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
30
|
</table> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
diff
changeset
|
31
|
|
10116
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
32
|
<hr /> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
33
|
<hr /> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
34
|
<a NAME="AsyncChecker" ID="AsyncChecker"></a> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
35
|
<h2>AsyncChecker</h2> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
36
|
<p> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
37
|
Class implementing a checker for "async" related issues. |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
38
|
</p> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
diff
changeset
|
39
|
|
10116
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
40
|
<h3>Derived from</h3> |
11150
|
41
|
CodeStyleTopicChecker |
10116
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
42
|
<h3>Class Attributes</h3> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
43
|
<table> |
11150
|
44
|
<tr><td>Category</td></tr> |
10116
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
45
|
<tr><td>Codes</td></tr> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
46
|
</table> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
diff
changeset
|
47
|
|
10116
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
48
|
<h3>Class Methods</h3> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
49
|
<table> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
50
|
<tr><td>None</td></tr> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
51
|
</table> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
diff
changeset
|
52
|
|
10116
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
53
|
<h3>Methods</h3> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
54
|
<table> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
55
|
<tr> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
56
|
<td><a href="#AsyncChecker.__init__">AsyncChecker</a></td> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
57
|
<td>Constructor</td> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
58
|
</tr> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
59
|
<tr> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
60
|
<td><a href="#AsyncChecker.__checkSyncUses">__checkSyncUses</a></td> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
61
|
<td>Private method to check for use of synchroneous functions in async methods.</td> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
62
|
</tr> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
63
|
</table> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
diff
changeset
|
64
|
|
10116
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
65
|
<h3>Static Methods</h3> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
66
|
<table> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
67
|
<tr><td>None</td></tr> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
68
|
</table> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
69
|
|
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
diff
changeset
|
70
|
|
10116
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
71
|
<a NAME="AsyncChecker.__init__" ID="AsyncChecker.__init__"></a> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
72
|
<h4>AsyncChecker (Constructor)</h4> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
73
|
<b>AsyncChecker</b>(<i>source, filename, tree, select, ignore, expected, repeat, args</i>) |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
74
|
<p> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
75
|
Constructor |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
76
|
</p> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
diff
changeset
|
77
|
|
10116
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
78
|
<dl> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
79
|
|
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
80
|
<dt><i>source</i> (list of str)</dt> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
81
|
<dd> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
82
|
source code to be checked |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
83
|
</dd> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
84
|
<dt><i>filename</i> (str)</dt> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
85
|
<dd> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
86
|
name of the source file |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
87
|
</dd> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
88
|
<dt><i>tree</i> (ast.Module)</dt> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
89
|
<dd> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
90
|
AST tree of the source code |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
91
|
</dd> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
92
|
<dt><i>select</i> (list of str)</dt> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
93
|
<dd> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
94
|
list of selected codes |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
95
|
</dd> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
96
|
<dt><i>ignore</i> (list of str)</dt> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
97
|
<dd> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
98
|
list of codes to be ignored |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
99
|
</dd> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
100
|
<dt><i>expected</i> (list of str)</dt> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
101
|
<dd> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
102
|
list of expected codes |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
103
|
</dd> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
104
|
<dt><i>repeat</i> (bool)</dt> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
105
|
<dd> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
106
|
flag indicating to report each occurrence of a code |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
107
|
</dd> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
108
|
<dt><i>args</i> (dict)</dt> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
109
|
<dd> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
110
|
dictionary of arguments for the various checks |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
111
|
</dd> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
112
|
</dl> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
113
|
<a NAME="AsyncChecker.__checkSyncUses" ID="AsyncChecker.__checkSyncUses"></a> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
114
|
<h4>AsyncChecker.__checkSyncUses</h4> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
115
|
<b>__checkSyncUses</b>(<i></i>) |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
116
|
<p> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
117
|
Private method to check for use of synchroneous functions in async methods. |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
118
|
</p> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
diff
changeset
|
119
|
|
10116
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
120
|
<div align="right"><a href="#top">Up</a></div> |
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
121
|
<hr /> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
diff
changeset
|
122
|
</body></html> |