36 <p> |
36 <p> |
37 Class implementing a checker for pydantic related issues. |
37 Class implementing a checker for pydantic related issues. |
38 </p> |
38 </p> |
39 |
39 |
40 <h3>Derived from</h3> |
40 <h3>Derived from</h3> |
41 None |
41 CodeStyleTopicChecker |
42 <h3>Class Attributes</h3> |
42 <h3>Class Attributes</h3> |
43 <table> |
43 <table> |
|
44 <tr><td>Category</td></tr> |
44 <tr><td>Codes</td></tr> |
45 <tr><td>Codes</td></tr> |
45 <tr><td>Prefix</td></tr> |
|
46 </table> |
46 </table> |
47 |
47 |
48 <h3>Class Methods</h3> |
48 <h3>Class Methods</h3> |
49 <table> |
49 <table> |
50 <tr><td>None</td></tr> |
50 <tr><td>None</td></tr> |
57 <td>Constructor</td> |
57 <td>Constructor</td> |
58 </tr> |
58 </tr> |
59 <tr> |
59 <tr> |
60 <td><a href="#PydanticChecker.__checkPydantic">__checkPydantic</a></td> |
60 <td><a href="#PydanticChecker.__checkPydantic">__checkPydantic</a></td> |
61 <td>Private method to check pydantic related topics.</td> |
61 <td>Private method to check pydantic related topics.</td> |
62 </tr> |
|
63 <tr> |
|
64 <td><a href="#PydanticChecker.__error">__error</a></td> |
|
65 <td>Private method to record an issue.</td> |
|
66 </tr> |
|
67 <tr> |
|
68 <td><a href="#PydanticChecker.__ignoreCode">__ignoreCode</a></td> |
|
69 <td>Private method to check if the message code should be ignored.</td> |
|
70 </tr> |
|
71 <tr> |
|
72 <td><a href="#PydanticChecker.run">run</a></td> |
|
73 <td>Public method to check the given source against miscellaneous conditions.</td> |
|
74 </tr> |
62 </tr> |
75 </table> |
63 </table> |
76 |
64 |
77 <h3>Static Methods</h3> |
65 <h3>Static Methods</h3> |
78 <table> |
66 <table> |
127 <b>__checkPydantic</b>(<i></i>) |
115 <b>__checkPydantic</b>(<i></i>) |
128 <p> |
116 <p> |
129 Private method to check pydantic related topics. |
117 Private method to check pydantic related topics. |
130 </p> |
118 </p> |
131 |
119 |
132 <a NAME="PydanticChecker.__error" ID="PydanticChecker.__error"></a> |
|
133 <h4>PydanticChecker.__error</h4> |
|
134 <b>__error</b>(<i>lineNumber, offset, code, *args</i>) |
|
135 <p> |
|
136 Private method to record an issue. |
|
137 </p> |
|
138 |
|
139 <dl> |
|
140 |
|
141 <dt><i>lineNumber</i> (int)</dt> |
|
142 <dd> |
|
143 line number of the issue |
|
144 </dd> |
|
145 <dt><i>offset</i> (int)</dt> |
|
146 <dd> |
|
147 position within line of the issue |
|
148 </dd> |
|
149 <dt><i>code</i> (str)</dt> |
|
150 <dd> |
|
151 message code |
|
152 </dd> |
|
153 <dt><i>args</i> (list)</dt> |
|
154 <dd> |
|
155 arguments for the message |
|
156 </dd> |
|
157 </dl> |
|
158 <a NAME="PydanticChecker.__ignoreCode" ID="PydanticChecker.__ignoreCode"></a> |
|
159 <h4>PydanticChecker.__ignoreCode</h4> |
|
160 <b>__ignoreCode</b>(<i>code</i>) |
|
161 <p> |
|
162 Private method to check if the message code should be ignored. |
|
163 </p> |
|
164 |
|
165 <dl> |
|
166 |
|
167 <dt><i>code</i> (str)</dt> |
|
168 <dd> |
|
169 message code to check for |
|
170 </dd> |
|
171 </dl> |
|
172 <dl> |
|
173 <dt>Return:</dt> |
|
174 <dd> |
|
175 flag indicating to ignore the given code |
|
176 </dd> |
|
177 </dl> |
|
178 <dl> |
|
179 <dt>Return Type:</dt> |
|
180 <dd> |
|
181 bool |
|
182 </dd> |
|
183 </dl> |
|
184 <a NAME="PydanticChecker.run" ID="PydanticChecker.run"></a> |
|
185 <h4>PydanticChecker.run</h4> |
|
186 <b>run</b>(<i></i>) |
|
187 <p> |
|
188 Public method to check the given source against miscellaneous |
|
189 conditions. |
|
190 </p> |
|
191 |
|
192 <div align="right"><a href="#top">Up</a></div> |
120 <div align="right"><a href="#top">Up</a></div> |
193 <hr /> |
121 <hr /> |
194 </body></html> |
122 </body></html> |