94 <tr> |
94 <tr> |
95 <td><a href="#NannyNag.__init__">NannyNag</a></td> |
95 <td><a href="#NannyNag.__init__">NannyNag</a></td> |
96 <td>Constructor</td> |
96 <td>Constructor</td> |
97 </tr><tr> |
97 </tr><tr> |
98 <td><a href="#NannyNag.get_line">get_line</a></td> |
98 <td><a href="#NannyNag.get_line">get_line</a></td> |
99 <td>Method to retrieve the offending line.</td> |
99 <td>Public method to retrieve the offending line.</td> |
100 </tr><tr> |
100 </tr><tr> |
101 <td><a href="#NannyNag.get_lineno">get_lineno</a></td> |
101 <td><a href="#NannyNag.get_lineno">get_lineno</a></td> |
102 <td>Method to retrieve the line number.</td> |
102 <td>Public method to retrieve the line number.</td> |
103 </tr><tr> |
103 </tr><tr> |
104 <td><a href="#NannyNag.get_msg">get_msg</a></td> |
104 <td><a href="#NannyNag.get_msg">get_msg</a></td> |
105 <td>Method to retrieve the message.</td> |
105 <td>Public method to retrieve the message.</td> |
106 </tr> |
106 </tr> |
107 </table> |
107 </table> |
108 <h3>Static Methods</h3> |
108 <h3>Static Methods</h3> |
109 <table> |
109 <table> |
110 <tr><td>None</td></tr> |
110 <tr><td>None</td></tr> |
127 </dd> |
127 </dd> |
128 </dl><a NAME="NannyNag.get_line" ID="NannyNag.get_line"></a> |
128 </dl><a NAME="NannyNag.get_line" ID="NannyNag.get_line"></a> |
129 <h4>NannyNag.get_line</h4> |
129 <h4>NannyNag.get_line</h4> |
130 <b>get_line</b>(<i></i>) |
130 <b>get_line</b>(<i></i>) |
131 <p> |
131 <p> |
132 Method to retrieve the offending line. |
132 Public method to retrieve the offending line. |
133 </p><dl> |
133 </p><dl> |
134 <dt>Returns:</dt> |
134 <dt>Returns:</dt> |
135 <dd> |
135 <dd> |
136 The line of code (string) |
136 The line of code (string) |
137 </dd> |
137 </dd> |
138 </dl><a NAME="NannyNag.get_lineno" ID="NannyNag.get_lineno"></a> |
138 </dl><a NAME="NannyNag.get_lineno" ID="NannyNag.get_lineno"></a> |
139 <h4>NannyNag.get_lineno</h4> |
139 <h4>NannyNag.get_lineno</h4> |
140 <b>get_lineno</b>(<i></i>) |
140 <b>get_lineno</b>(<i></i>) |
141 <p> |
141 <p> |
142 Method to retrieve the line number. |
142 Public method to retrieve the line number. |
143 </p><dl> |
143 </p><dl> |
144 <dt>Returns:</dt> |
144 <dt>Returns:</dt> |
145 <dd> |
145 <dd> |
146 The line number (integer) |
146 The line number (integer) |
147 </dd> |
147 </dd> |
148 </dl><a NAME="NannyNag.get_msg" ID="NannyNag.get_msg"></a> |
148 </dl><a NAME="NannyNag.get_msg" ID="NannyNag.get_msg"></a> |
149 <h4>NannyNag.get_msg</h4> |
149 <h4>NannyNag.get_msg</h4> |
150 <b>get_msg</b>(<i></i>) |
150 <b>get_msg</b>(<i></i>) |
151 <p> |
151 <p> |
152 Method to retrieve the message. |
152 Public method to retrieve the message. |
153 </p><dl> |
153 </p><dl> |
154 <dt>Returns:</dt> |
154 <dt>Returns:</dt> |
155 <dd> |
155 <dd> |
156 The error message (string) |
156 The error message (string) |
157 </dd> |
157 </dd> |
178 <tr> |
178 <tr> |
179 <td><a href="#Whitespace.__init__">Whitespace</a></td> |
179 <td><a href="#Whitespace.__init__">Whitespace</a></td> |
180 <td>Constructor</td> |
180 <td>Constructor</td> |
181 </tr><tr> |
181 </tr><tr> |
182 <td><a href="#Whitespace.equal">equal</a></td> |
182 <td><a href="#Whitespace.equal">equal</a></td> |
183 <td>Method to compare the indentation levels of two Whitespace objects for equality.</td> |
183 <td>Public method to compare the indentation levels of two Whitespace objects for equality.</td> |
184 </tr><tr> |
184 </tr><tr> |
185 <td><a href="#Whitespace.indent_level">indent_level</a></td> |
185 <td><a href="#Whitespace.indent_level">indent_level</a></td> |
186 <td>Method to determine the indentation level.</td> |
186 <td>Public method to determine the indentation level.</td> |
187 </tr><tr> |
187 </tr><tr> |
188 <td><a href="#Whitespace.less">less</a></td> |
188 <td><a href="#Whitespace.less">less</a></td> |
189 <td>Method to compare the indentation level against another Whitespace objects to be smaller.</td> |
189 <td>Public method to compare the indentation level against another Whitespace objects to be smaller.</td> |
190 </tr><tr> |
190 </tr><tr> |
191 <td><a href="#Whitespace.longest_run_of_spaces">longest_run_of_spaces</a></td> |
191 <td><a href="#Whitespace.longest_run_of_spaces">longest_run_of_spaces</a></td> |
192 <td>Method to calculate the length of longest contiguous run of spaces.</td> |
192 <td>Public method to calculate the length of longest contiguous run of spaces.</td> |
193 </tr><tr> |
193 </tr><tr> |
194 <td><a href="#Whitespace.not_equal_witness">not_equal_witness</a></td> |
194 <td><a href="#Whitespace.not_equal_witness">not_equal_witness</a></td> |
195 <td>Method to calculate a tuple of witnessing tab size.</td> |
195 <td>Public method to calculate a tuple of witnessing tab size.</td> |
196 </tr><tr> |
196 </tr><tr> |
197 <td><a href="#Whitespace.not_less_witness">not_less_witness</a></td> |
197 <td><a href="#Whitespace.not_less_witness">not_less_witness</a></td> |
198 <td>Method to calculate a tuple of witnessing tab size.</td> |
198 <td>Public method to calculate a tuple of witnessing tab size.</td> |
199 </tr> |
199 </tr> |
200 </table> |
200 </table> |
201 <h3>Static Methods</h3> |
201 <h3>Static Methods</h3> |
202 <table> |
202 <table> |
203 <tr><td>None</td></tr> |
203 <tr><td>None</td></tr> |
214 </dd> |
214 </dd> |
215 </dl><a NAME="Whitespace.equal" ID="Whitespace.equal"></a> |
215 </dl><a NAME="Whitespace.equal" ID="Whitespace.equal"></a> |
216 <h4>Whitespace.equal</h4> |
216 <h4>Whitespace.equal</h4> |
217 <b>equal</b>(<i>other</i>) |
217 <b>equal</b>(<i>other</i>) |
218 <p> |
218 <p> |
219 Method to compare the indentation levels of two Whitespace objects for |
219 Public method to compare the indentation levels of two Whitespace |
220 equality. |
220 objects for equality. |
221 </p><dl> |
221 </p><dl> |
222 <dt><i>other</i></dt> |
222 <dt><i>other</i></dt> |
223 <dd> |
223 <dd> |
224 Whitespace object to compare against. |
224 Whitespace object to compare against. |
225 </dd> |
225 </dd> |
230 </dd> |
230 </dd> |
231 </dl><a NAME="Whitespace.indent_level" ID="Whitespace.indent_level"></a> |
231 </dl><a NAME="Whitespace.indent_level" ID="Whitespace.indent_level"></a> |
232 <h4>Whitespace.indent_level</h4> |
232 <h4>Whitespace.indent_level</h4> |
233 <b>indent_level</b>(<i>tabsize</i>) |
233 <b>indent_level</b>(<i>tabsize</i>) |
234 <p> |
234 <p> |
235 Method to determine the indentation level. |
235 Public method to determine the indentation level. |
236 </p><dl> |
236 </p><dl> |
237 <dt><i>tabsize</i></dt> |
237 <dt><i>tabsize</i></dt> |
238 <dd> |
238 <dd> |
239 The length of a tab stop. (integer) |
239 The length of a tab stop. (integer) |
240 </dd> |
240 </dd> |
245 </dd> |
245 </dd> |
246 </dl><a NAME="Whitespace.less" ID="Whitespace.less"></a> |
246 </dl><a NAME="Whitespace.less" ID="Whitespace.less"></a> |
247 <h4>Whitespace.less</h4> |
247 <h4>Whitespace.less</h4> |
248 <b>less</b>(<i>other</i>) |
248 <b>less</b>(<i>other</i>) |
249 <p> |
249 <p> |
250 Method to compare the indentation level against another Whitespace |
250 Public method to compare the indentation level against another |
251 objects to be smaller. |
251 Whitespace objects to be smaller. |
252 </p><dl> |
252 </p><dl> |
253 <dt><i>other</i></dt> |
253 <dt><i>other</i></dt> |
254 <dd> |
254 <dd> |
255 Whitespace object to compare against. |
255 Whitespace object to compare against. |
256 </dd> |
256 </dd> |
261 </dd> |
261 </dd> |
262 </dl><a NAME="Whitespace.longest_run_of_spaces" ID="Whitespace.longest_run_of_spaces"></a> |
262 </dl><a NAME="Whitespace.longest_run_of_spaces" ID="Whitespace.longest_run_of_spaces"></a> |
263 <h4>Whitespace.longest_run_of_spaces</h4> |
263 <h4>Whitespace.longest_run_of_spaces</h4> |
264 <b>longest_run_of_spaces</b>(<i></i>) |
264 <b>longest_run_of_spaces</b>(<i></i>) |
265 <p> |
265 <p> |
266 Method to calculate the length of longest contiguous run of spaces. |
266 Public method to calculate the length of longest contiguous run of |
|
267 spaces. |
267 </p><dl> |
268 </p><dl> |
268 <dt>Returns:</dt> |
269 <dt>Returns:</dt> |
269 <dd> |
270 <dd> |
270 The length of longest contiguous run of spaces (whether or not |
271 The length of longest contiguous run of spaces (whether or not |
271 preceding a tab) |
272 preceding a tab) |
272 </dd> |
273 </dd> |
273 </dl><a NAME="Whitespace.not_equal_witness" ID="Whitespace.not_equal_witness"></a> |
274 </dl><a NAME="Whitespace.not_equal_witness" ID="Whitespace.not_equal_witness"></a> |
274 <h4>Whitespace.not_equal_witness</h4> |
275 <h4>Whitespace.not_equal_witness</h4> |
275 <b>not_equal_witness</b>(<i>other</i>) |
276 <b>not_equal_witness</b>(<i>other</i>) |
276 <p> |
277 <p> |
277 Method to calculate a tuple of witnessing tab size. |
278 Public method to calculate a tuple of witnessing tab size. |
278 </p><p> |
279 </p><p> |
279 Intended to be used after not self.equal(other) is known, in which |
280 Intended to be used after not self.equal(other) is known, in which |
280 case it will return at least one witnessing tab size. |
281 case it will return at least one witnessing tab size. |
281 </p><dl> |
282 </p><dl> |
282 <dt><i>other</i></dt> |
283 <dt><i>other</i></dt> |
291 </dd> |
292 </dd> |
292 </dl><a NAME="Whitespace.not_less_witness" ID="Whitespace.not_less_witness"></a> |
293 </dl><a NAME="Whitespace.not_less_witness" ID="Whitespace.not_less_witness"></a> |
293 <h4>Whitespace.not_less_witness</h4> |
294 <h4>Whitespace.not_less_witness</h4> |
294 <b>not_less_witness</b>(<i>other</i>) |
295 <b>not_less_witness</b>(<i>other</i>) |
295 <p> |
296 <p> |
296 Method to calculate a tuple of witnessing tab size. |
297 Public method to calculate a tuple of witnessing tab size. |
297 </p><p> |
298 </p><p> |
298 Intended to be used after not self.less(other is known, in which |
299 Intended to be used after not self.less(other is known, in which |
299 case it will return at least one witnessing tab size. |
300 case it will return at least one witnessing tab size. |
300 </p><dl> |
301 </p><dl> |
301 <dt><i>other</i></dt> |
302 <dt><i>other</i></dt> |