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