Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.eradicate.html
eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.eradicate.html
- changeset 7976
- a8a20f558176
- parent 7273
- 391d6b7b1eff
equal
deleted
inserted
replaced
| 7975:7d493839a8fc | 7976:a8a20f558176 |
|---|---|
| 26 Removes commented-out Python code. | 26 Removes commented-out Python code. |
| 27 </p> | 27 </p> |
| 28 <h3>Global Attributes</h3> | 28 <h3>Global Attributes</h3> |
| 29 | 29 |
| 30 <table> | 30 <table> |
| 31 <tr><td>MULTILINE_ASSIGNMENT_REGEX</td></tr><tr><td>PARTIAL_DICTIONARY_REGEX</td></tr><tr><td>__version__</td></tr> | 31 <tr><td>__version__</td></tr> |
| 32 </table> | 32 </table> |
| 33 <h3>Classes</h3> | 33 <h3>Classes</h3> |
| 34 | 34 |
| 35 <table> | 35 <table> |
| 36 <tr><td>None</td></tr> | 36 |
| 37 <tr> | |
| 38 <td><a href="#Eradicator">Eradicator</a></td> | |
| 39 <td>Eradicate comments.</td> | |
| 40 </tr> | |
| 37 </table> | 41 </table> |
| 38 <h3>Functions</h3> | 42 <h3>Functions</h3> |
| 39 | 43 |
| 40 <table> | 44 <table> |
| 41 | 45 |
| 42 <tr> | 46 <tr> |
| 43 <td><a href="#comment_contains_code">comment_contains_code</a></td> | |
| 44 <td>Return True comment contains code.</td> | |
| 45 </tr> | |
| 46 <tr> | |
| 47 <td><a href="#commented_out_code_line_numbers">commented_out_code_line_numbers</a></td> | |
| 48 <td>Yield line numbers of commented-out code.</td> | |
| 49 </tr> | |
| 50 <tr> | |
| 51 <td><a href="#detect_encoding">detect_encoding</a></td> | |
| 52 <td>Return file encoding.</td> | |
| 53 </tr> | |
| 54 <tr> | |
| 55 <td><a href="#filter_commented_out_code">filter_commented_out_code</a></td> | |
| 56 <td>Yield code with commented out code removed.</td> | |
| 57 </tr> | |
| 58 <tr> | |
| 59 <td><a href="#fix_file">fix_file</a></td> | |
| 60 <td>Run filter_commented_out_code() on file.</td> | |
| 61 </tr> | |
| 62 <tr> | |
| 63 <td><a href="#main">main</a></td> | 47 <td><a href="#main">main</a></td> |
| 64 <td>Main entry point.</td> | 48 <td>Main entry point.</td> |
| 65 </tr> | |
| 66 <tr> | |
| 67 <td><a href="#multiline_case">multiline_case</a></td> | |
| 68 <td>Return True if line is probably part of some multiline code.</td> | |
| 69 </tr> | |
| 70 <tr> | |
| 71 <td><a href="#open_with_encoding">open_with_encoding</a></td> | |
| 72 <td>Return opened file with a specific encoding.</td> | |
| 73 </tr> | 49 </tr> |
| 74 </table> | 50 </table> |
| 75 <hr /> | 51 <hr /> |
| 76 <hr /> | 52 <hr /> |
| 77 <a NAME="comment_contains_code" ID="comment_contains_code"></a> | 53 <a NAME="Eradicator" ID="Eradicator"></a> |
| 78 <h2>comment_contains_code</h2> | 54 <h2>Eradicator</h2> |
| 55 | |
| 56 <p> | |
| 57 Eradicate comments. | |
| 58 </p> | |
| 59 <h3>Derived from</h3> | |
| 60 object | |
| 61 <h3>Class Attributes</h3> | |
| 62 | |
| 63 <table> | |
| 64 <tr><td>BRACKET_REGEX</td></tr><tr><td>CODE_INDICATORS</td></tr><tr><td>CODE_KEYWORDS</td></tr><tr><td>CODE_KEYWORDS_AGGR</td></tr><tr><td>CODING_COMMENT_REGEX</td></tr><tr><td>DEFAULT_WHITELIST</td></tr><tr><td>DEF_STATEMENT_REGEX</td></tr><tr><td>FOR_STATEMENT_REGEX</td></tr><tr><td>HASH_NUMBER</td></tr><tr><td>MULTILINE_ASSIGNMENT_REGEX</td></tr><tr><td>PARTIAL_DICTIONARY_REGEX</td></tr><tr><td>PRINT_RETURN_REGEX</td></tr><tr><td>WHITELIST_REGEX</td></tr><tr><td>WHITESPACE_HASH</td></tr><tr><td>WITH_STATEMENT_REGEX</td></tr> | |
| 65 </table> | |
| 66 <h3>Class Methods</h3> | |
| 67 | |
| 68 <table> | |
| 69 <tr><td>None</td></tr> | |
| 70 </table> | |
| 71 <h3>Methods</h3> | |
| 72 | |
| 73 <table> | |
| 74 | |
| 75 <tr> | |
| 76 <td><a href="#Eradicator.comment_contains_code">comment_contains_code</a></td> | |
| 77 <td>Return True comment contains code.</td> | |
| 78 </tr> | |
| 79 <tr> | |
| 80 <td><a href="#Eradicator.commented_out_code_line_numbers">commented_out_code_line_numbers</a></td> | |
| 81 <td>Yield line numbers of commented-out code.</td> | |
| 82 </tr> | |
| 83 <tr> | |
| 84 <td><a href="#Eradicator.detect_encoding">detect_encoding</a></td> | |
| 85 <td>Return file encoding.</td> | |
| 86 </tr> | |
| 87 <tr> | |
| 88 <td><a href="#Eradicator.filter_commented_out_code">filter_commented_out_code</a></td> | |
| 89 <td>Yield code with commented out code removed.</td> | |
| 90 </tr> | |
| 91 <tr> | |
| 92 <td><a href="#Eradicator.fix_file">fix_file</a></td> | |
| 93 <td>Run filter_commented_out_code() on file.</td> | |
| 94 </tr> | |
| 95 <tr> | |
| 96 <td><a href="#Eradicator.multiline_case">multiline_case</a></td> | |
| 97 <td>Return True if line is probably part of some multiline code.</td> | |
| 98 </tr> | |
| 99 <tr> | |
| 100 <td><a href="#Eradicator.open_with_encoding">open_with_encoding</a></td> | |
| 101 <td>Return opened file with a specific encoding.</td> | |
| 102 </tr> | |
| 103 <tr> | |
| 104 <td><a href="#Eradicator.update_whitelist">update_whitelist</a></td> | |
| 105 <td>Updates the whitelist.</td> | |
| 106 </tr> | |
| 107 </table> | |
| 108 <h3>Static Methods</h3> | |
| 109 | |
| 110 <table> | |
| 111 <tr><td>None</td></tr> | |
| 112 </table> | |
| 113 | |
| 114 <a NAME="Eradicator.comment_contains_code" ID="Eradicator.comment_contains_code"></a> | |
| 115 <h4>Eradicator.comment_contains_code</h4> | |
| 79 <b>comment_contains_code</b>(<i>line, aggressive=True</i>) | 116 <b>comment_contains_code</b>(<i>line, aggressive=True</i>) |
| 80 | 117 |
| 81 <p> | 118 <p> |
| 82 Return True comment contains code. | 119 Return True comment contains code. |
| 83 </p> | 120 </p> |
| 84 <div align="right"><a href="#top">Up</a></div> | 121 <a NAME="Eradicator.commented_out_code_line_numbers" ID="Eradicator.commented_out_code_line_numbers"></a> |
| 85 <hr /> | 122 <h4>Eradicator.commented_out_code_line_numbers</h4> |
| 86 <hr /> | |
| 87 <a NAME="commented_out_code_line_numbers" ID="commented_out_code_line_numbers"></a> | |
| 88 <h2>commented_out_code_line_numbers</h2> | |
| 89 <b>commented_out_code_line_numbers</b>(<i>source, aggressive=True</i>) | 123 <b>commented_out_code_line_numbers</b>(<i>source, aggressive=True</i>) |
| 90 | 124 |
| 91 <p> | 125 <p> |
| 92 Yield line numbers of commented-out code. | 126 Yield line numbers of commented-out code. |
| 93 </p> | 127 </p> |
| 94 <div align="right"><a href="#top">Up</a></div> | 128 <a NAME="Eradicator.detect_encoding" ID="Eradicator.detect_encoding"></a> |
| 95 <hr /> | 129 <h4>Eradicator.detect_encoding</h4> |
| 96 <hr /> | |
| 97 <a NAME="detect_encoding" ID="detect_encoding"></a> | |
| 98 <h2>detect_encoding</h2> | |
| 99 <b>detect_encoding</b>(<i>filename</i>) | 130 <b>detect_encoding</b>(<i>filename</i>) |
| 100 | 131 |
| 101 <p> | 132 <p> |
| 102 Return file encoding. | 133 Return file encoding. |
| 103 </p> | 134 </p> |
| 104 <div align="right"><a href="#top">Up</a></div> | 135 <a NAME="Eradicator.filter_commented_out_code" ID="Eradicator.filter_commented_out_code"></a> |
| 105 <hr /> | 136 <h4>Eradicator.filter_commented_out_code</h4> |
| 106 <hr /> | |
| 107 <a NAME="filter_commented_out_code" ID="filter_commented_out_code"></a> | |
| 108 <h2>filter_commented_out_code</h2> | |
| 109 <b>filter_commented_out_code</b>(<i>source, aggressive=True</i>) | 137 <b>filter_commented_out_code</b>(<i>source, aggressive=True</i>) |
| 110 | 138 |
| 111 <p> | 139 <p> |
| 112 Yield code with commented out code removed. | 140 Yield code with commented out code removed. |
| 113 </p> | 141 </p> |
| 114 <div align="right"><a href="#top">Up</a></div> | 142 <a NAME="Eradicator.fix_file" ID="Eradicator.fix_file"></a> |
| 115 <hr /> | 143 <h4>Eradicator.fix_file</h4> |
| 116 <hr /> | |
| 117 <a NAME="fix_file" ID="fix_file"></a> | |
| 118 <h2>fix_file</h2> | |
| 119 <b>fix_file</b>(<i>filename, args, standard_out</i>) | 144 <b>fix_file</b>(<i>filename, args, standard_out</i>) |
| 120 | 145 |
| 121 <p> | 146 <p> |
| 122 Run filter_commented_out_code() on file. | 147 Run filter_commented_out_code() on file. |
| 148 </p> | |
| 149 <a NAME="Eradicator.multiline_case" ID="Eradicator.multiline_case"></a> | |
| 150 <h4>Eradicator.multiline_case</h4> | |
| 151 <b>multiline_case</b>(<i>line, aggressive=True</i>) | |
| 152 | |
| 153 <p> | |
| 154 Return True if line is probably part of some multiline code. | |
| 155 </p> | |
| 156 <a NAME="Eradicator.open_with_encoding" ID="Eradicator.open_with_encoding"></a> | |
| 157 <h4>Eradicator.open_with_encoding</h4> | |
| 158 <b>open_with_encoding</b>(<i>filename, encoding, mode='r'</i>) | |
| 159 | |
| 160 <p> | |
| 161 Return opened file with a specific encoding. | |
| 162 </p> | |
| 163 <a NAME="Eradicator.update_whitelist" ID="Eradicator.update_whitelist"></a> | |
| 164 <h4>Eradicator.update_whitelist</h4> | |
| 165 <b>update_whitelist</b>(<i>new_whitelist, extend_default=True</i>) | |
| 166 | |
| 167 <p> | |
| 168 Updates the whitelist. | |
| 123 </p> | 169 </p> |
| 124 <div align="right"><a href="#top">Up</a></div> | 170 <div align="right"><a href="#top">Up</a></div> |
| 125 <hr /> | 171 <hr /> |
| 126 <hr /> | 172 <hr /> |
| 127 <a NAME="main" ID="main"></a> | 173 <a NAME="main" ID="main"></a> |
| 131 <p> | 177 <p> |
| 132 Main entry point. | 178 Main entry point. |
| 133 </p> | 179 </p> |
| 134 <div align="right"><a href="#top">Up</a></div> | 180 <div align="right"><a href="#top">Up</a></div> |
| 135 <hr /> | 181 <hr /> |
| 136 <hr /> | |
| 137 <a NAME="multiline_case" ID="multiline_case"></a> | |
| 138 <h2>multiline_case</h2> | |
| 139 <b>multiline_case</b>(<i>line, aggressive=True</i>) | |
| 140 | |
| 141 <p> | |
| 142 Return True if line is probably part of some multiline code. | |
| 143 </p> | |
| 144 <div align="right"><a href="#top">Up</a></div> | |
| 145 <hr /> | |
| 146 <hr /> | |
| 147 <a NAME="open_with_encoding" ID="open_with_encoding"></a> | |
| 148 <h2>open_with_encoding</h2> | |
| 149 <b>open_with_encoding</b>(<i>filename, encoding, mode='r'</i>) | |
| 150 | |
| 151 <p> | |
| 152 Return opened file with a specific encoding. | |
| 153 </p> | |
| 154 <div align="right"><a href="#top">Up</a></div> | |
| 155 <hr /> | |
| 156 </body></html> | 182 </body></html> |
