--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.eradicate.html Thu Jul 07 11:23:56 2022 +0200 @@ -0,0 +1,168 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.eradicate</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.eradicate</h1> + +<p> +Removes commented-out Python code. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>__version__</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#Eradicator">Eradicator</a></td> +<td>Eradicate comments.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> + +<tr> +<td><a href="#main">main</a></td> +<td>Main entry point.</td> +</tr> +</table> +<hr /> +<hr /> +<a NAME="Eradicator" ID="Eradicator"></a> +<h2>Eradicator</h2> + +<p> +Eradicate comments. +</p> +<h3>Derived from</h3> +object +<h3>Class Attributes</h3> + +<table> +<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> +</table> +<h3>Class Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> + +<table> + +<tr> +<td><a href="#Eradicator.comment_contains_code">comment_contains_code</a></td> +<td>Return True comment contains code.</td> +</tr> +<tr> +<td><a href="#Eradicator.commented_out_code_line_numbers">commented_out_code_line_numbers</a></td> +<td>Yield line numbers of commented-out code.</td> +</tr> +<tr> +<td><a href="#Eradicator.detect_encoding">detect_encoding</a></td> +<td>Return file encoding.</td> +</tr> +<tr> +<td><a href="#Eradicator.filter_commented_out_code">filter_commented_out_code</a></td> +<td>Yield code with commented out code removed.</td> +</tr> +<tr> +<td><a href="#Eradicator.fix_file">fix_file</a></td> +<td>Run filter_commented_out_code() on file.</td> +</tr> +<tr> +<td><a href="#Eradicator.multiline_case">multiline_case</a></td> +<td>Return True if line is probably part of some multiline code.</td> +</tr> +<tr> +<td><a href="#Eradicator.open_with_encoding">open_with_encoding</a></td> +<td>Return opened file with a specific encoding.</td> +</tr> +<tr> +<td><a href="#Eradicator.update_whitelist">update_whitelist</a></td> +<td>Updates the whitelist.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="Eradicator.comment_contains_code" ID="Eradicator.comment_contains_code"></a> +<h4>Eradicator.comment_contains_code</h4> +<b>comment_contains_code</b>(<i>line, aggressive=True</i>) + +<p> +Return True comment contains code. +</p> +<a NAME="Eradicator.commented_out_code_line_numbers" ID="Eradicator.commented_out_code_line_numbers"></a> +<h4>Eradicator.commented_out_code_line_numbers</h4> +<b>commented_out_code_line_numbers</b>(<i>source, aggressive=True</i>) + +<p> +Yield line numbers of commented-out code. +</p> +<a NAME="Eradicator.detect_encoding" ID="Eradicator.detect_encoding"></a> +<h4>Eradicator.detect_encoding</h4> +<b>detect_encoding</b>(<i>filename</i>) + +<p> +Return file encoding. +</p> +<a NAME="Eradicator.filter_commented_out_code" ID="Eradicator.filter_commented_out_code"></a> +<h4>Eradicator.filter_commented_out_code</h4> +<b>filter_commented_out_code</b>(<i>source, aggressive=True</i>) + +<p> +Yield code with commented out code removed. +</p> +<a NAME="Eradicator.fix_file" ID="Eradicator.fix_file"></a> +<h4>Eradicator.fix_file</h4> +<b>fix_file</b>(<i>filename, args, standard_out</i>) + +<p> +Run filter_commented_out_code() on file. +</p> +<a NAME="Eradicator.multiline_case" ID="Eradicator.multiline_case"></a> +<h4>Eradicator.multiline_case</h4> +<b>multiline_case</b>(<i>line, aggressive=True</i>) + +<p> +Return True if line is probably part of some multiline code. +</p> +<a NAME="Eradicator.open_with_encoding" ID="Eradicator.open_with_encoding"></a> +<h4>Eradicator.open_with_encoding</h4> +<b>open_with_encoding</b>(<i>filename, encoding, mode='r'</i>) + +<p> +Return opened file with a specific encoding. +</p> +<a NAME="Eradicator.update_whitelist" ID="Eradicator.update_whitelist"></a> +<h4>Eradicator.update_whitelist</h4> +<b>update_whitelist</b>(<i>new_whitelist, extend_default=True</i>) + +<p> +Updates the whitelist. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="main" ID="main"></a> +<h2>main</h2> +<b>main</b>(<i>argv, standard_out, standard_error</i>) + +<p> +Main entry point. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file