Python Comment Manager Script Code

<br /> import tokenize<br /> import io<br /> import os<br /> import sys</p> <p># — _tokenize_file function (Should be the corrected version from the previous steps) —<br /> def _tokenize_file(filepath):<br /> “””<br /> Helper function to open, read, and tokenize a file using BytesIO.<br /> Returns generator or None on error.<br /> “””<br /> try:<br /> with open(filepath, ‘rb’) as source_file:<br /> source_bytes = source_file.read()<br /> try:<br /> source_bytes.decode(‘utf-8’)<br /> except UnicodeDecodeError as e:<br /> print(f”\nError: Could not decode file ‘{filepath}’ as UTF-8: {e}”, file=sys.stderr)<br /> print(“Ensure the file is saved with UTF-8 encoding.”, file=sys.stderr)<br /> return None<br /> source_io = io.BytesIO(source_bytes)<br /> return tokenize.tokenize(source_io.readline)<br /> except FileNotFoundError:<br /> print(f”\nError: Input file not found at ‘{filepath}'”, file=sys.stderr)<br /> return None<br /> except tokenize.TokenError as e:<br /> print(f”\nError during initial tokenization of ‘{filepath}’: {e}”, file=sys.stderr)<br /> return None<br /> except IOError as e:<br /> print(f”\nError reading file ‘{filepath}’: {e}”, file=sys.stderr)<br /> return None<br /> except Exception as e:<br /> print(f”\nAn unexpected error occurred while reading/preparing ‘{filepath}’: {e}”, file=sys.stderr)<br /> return None</p> <p># — Corrected remove_comments function with trailing space removal —<br /> def remove_comments(input_filepath, output_filepath):<br /> “””<br /> Reads a Python file, removes comments, blank lines left by<br /> comment-only lines, AND trailing whitespace from lines where comments<br /> were removed, then writes the result to a new file.</p> <p> Args:<br /> input_filepath (str): Path to the input .py file.<br /> output_filepath (str): Path to the output .py file.</p> <p> Returns:<br /> bool: True if successful, False otherwise.<br /> “””<br /> print(f”\nProcessing ‘{os.path.basename(input_filepath)}’ to remove comments…”)<br /> token_generator = _tokenize_file(input_filepath)<br /> if token_generator is None:<br /> return False</p> <p> try:<br /> all_tokens = list(token_generator)<br /> tokens_without_comments = [t for t in all_tokens if t.type != tokenize.COMMENT]</p> <p> tokens_to_keep = []<br /> for i, tok in enumerate(tokens_without_comments):<br /> if tok.type == tokenize.NL and i > 0:<br /> prev_tok = tokens_without_comments[i-1]<br /> if prev_tok.type == tokenize.INDENT:<br /> continue # Skip NL after INDENT if comment was removed<br /> tokens_to_keep.append(tok)</p> <p> # Untokenize might leave trailing whitespace where comments were<br /> result_bytes = tokenize.untokenize(tokens_to_keep)<br /> result_code_with_trailing_spaces = result_bytes.decode(‘utf-8’)</p> <p> # *** FIX: Post-process to remove trailing whitespace line by line ***<br /> cleaned_lines = []<br /> # Use io.StringIO to handle different line endings gracefully<br /> with io.StringIO(result_code_with_trailing_spaces) as f:<br /> for line in f:<br /> # rstrip() removes trailing whitespace (spaces, tabs, newlines)<br /> # We add back the standard newline character ‘\n’<br /> cleaned_lines.append(line.rstrip() + ‘\n’)</p> <p> # Handle case where the original file might not end with a newline<br /> if not result_code_with_trailing_spaces.endswith((‘\n’, ‘\r\n’)) and cleaned_lines:<br /> # Remove the extra newline we added if the original didn’t have one<br /> cleaned_lines[-1] = cleaned_lines[-1].rstrip(‘\n’)</p> <p> final_code = “”.join(cleaned_lines)<br /> # *******************************************************************</p> <p> except tokenize.TokenError as e:<br /> print(f”Error tokenizing/untokenizing file ‘{input_filepath}’: {e}”, file=sys.stderr)<br /> return False<br /> except UnicodeDecodeError as e:<br /> print(f”Error decoding processed data from ‘{input_filepath}’ back to UTF-8: {e}”, file=sys.stderr)<br /> return False<br /> except Exception as e:<br /> print(f”An unexpected error occurred during token processing/reconstruction: {e}”, file=sys.stderr)<br /> return False</p> <p> # Write the final, cleaned code<br /> try:<br /> output_dir = os.path.dirname(output_filepath)<br /> if output_dir and not os.path.exists(output_dir):<br /> print(f”Creating output directory: {output_dir}”)<br /> os.makedirs(output_dir, exist_ok=True)</p> <p> with open(output_filepath, ‘w’, encoding=’utf-8′) as output_file:<br /> # Write the cleaned code<br /> output_file.write(final_code)</p> <p> print(f”\nSuccessfully removed comments and cleaned trailing spaces.”)<br /> print(f”Output saved to ‘{output_filepath}'”)<br /> return True<br /> except IOError as e:<br /> print(f”\nError writing output file ‘{output_filepath}’: {e}”, file=sys.stderr)<br /> return False<br /> except OSError as e:<br /> print(f”\nError creating output directory for ‘{output_filepath}’: {e}”, file=sys.stderr)<br /> return False<br /> except Exception as e:<br /> print(f”\nAn unexpected error occurred while writing ‘{output_filepath}’: {e}”, file=sys.stderr)<br /> return False</p> <p># — count_comments function (Keep as before, needs the check for None generator) —<br /> def count_comments(input_filepath):<br /> “”” Counts comment tokens “””<br /> print(f”\nAnalyzing ‘{os.path.basename(input_filepath)}’ for comments…”)<br /> token_generator = _tokenize_file(input_filepath)<br /> if token_generator is None: return None</p> <p> comment_count = 0<br /> try:<br /> for token_info in token_generator:<br /> if token_info.type == tokenize.COMMENT:<br /> comment_count += 1<br /> except tokenize.TokenError as e:<br /> print(f”Error processing tokens in ‘{input_filepath}’: {e}”, file=sys.stderr)<br /> return None<br /> except Exception as e:<br /> print(f”An unexpected error occurred during token processing: {e}”, file=sys.stderr)<br /> return None<br /> return comment_count</p> <p># — run_interactive function (Keep as before) —<br /> def run_interactive():<br /> “””Handles the interactive user prompts and calls the appropriate functions.”””<br /> print(“————————————“)<br /> print(” Python Comment Manager Script “)<br /> print(“————————————“)</p> <p> # 1. Get desired action<br /> while True:<br /> print(“\nChoose an action:”)<br /> print(” 1: Count comments in a file”)<br /> print(” 2: Remove comments from a file”)<br /> print(” Q: Quit”)<br /> action_choice = input(“Enter your choice (1, 2, or Q): “).strip().upper()</p> <p> if action_choice in [‘1’, ‘2’, ‘Q’]:<br /> break<br /> else:<br /> print(“Invalid choice. Please enter 1, 2, or Q.”)</p> <p> if action_choice == ‘Q’:<br /> print(“Exiting.”)<br /> return</p> <p> # 2. Get input file path<br /> input_filepath = “”<br /> while True:<br /> try:<br /> input_filepath = input(“Enter the full path to the input Python file (.py): “).strip()<br /> if not input_filepath:<br /> print(“File path cannot be empty. Please try again.”)<br /> continue<br /> if not os.path.isfile(input_filepath):<br /> print(f”Error: File not found at ‘{input_filepath}’. Please check the path and try again.”)<br /> continue<br /> if not input_filepath.lower().endswith((‘.py’, ‘.pyw’)):<br /> print(f”Warning: File ‘{os.path.basename(input_filepath)}’ does not have a typical Python extension (.py, .pyw).”)<br /> proceed = input(“Continue anyway? (y/n): “).strip().lower()<br /> if proceed != ‘y’:<br /> input_filepath = “” # Reset to loop again<br /> continue<br /> break # Valid path entered<br /> except KeyboardInterrupt:<br /> print(“\nOperation cancelled by user.”)<br /> return<br /> except Exception as e:<br /> print(f”An error occurred during input: {e}”)<br /> return</p> <p> # — Perform Action —<br /> try:<br /> if action_choice == ‘1’: # Count Comments<br /> comment_count = count_comments(input_filepath)<br /> if comment_count is not None:<br /> print(f”\n————————————“)<br /> print(f”Result: Found {comment_count} comment tokens in ‘{os.path.basename(input_filepath)}’.”)<br /> print(f”————————————“)</p> <p> elif action_choice == ‘2’: # Remove Comments<br /> output_filepath = “”<br /> while True:<br /> base, ext = os.path.splitext(input_filepath)<br /> if not ext: ext = ‘.py’<br /> default_output_name = f”{base}_no_comments{ext}”<br /> try:<br /> output_filepath_prompt = (<br /> f”Enter the full path for the output file ”<br /> f”(leave blank to use default: ‘{os.path.basename(default_output_name)}’): ”<br /> )<br /> output_filepath = input(output_filepath_prompt).strip()<br /> if not output_filepath:<br /> output_filepath = default_output_name<br /> print(f”Using default output path: ‘{output_filepath}'”)<br /> if os.path.abspath(input_filepath) == os.path.abspath(output_filepath):<br /> print(“\nError: Output file path cannot be the same as the input file path.”)<br /> print(“Please enter a different path or leave blank for the default.”)<br /> output_filepath = “” # Reset to loop again<br /> continue<br /> if os.path.exists(output_filepath):<br /> overwrite = input(f”Warning: Output file ‘{output_filepath}’ already exists. Overwrite? (y/n): “).strip().lower()<br /> if overwrite != ‘y’:<br /> print(“Please enter a different output file path.”)<br /> output_filepath = “” # Reset to loop again<br /> continue<br /> break # Valid output path obtained<br /> except KeyboardInterrupt:<br /> print(“\nOperation cancelled by user.”)<br /> return<br /> remove_comments(input_filepath, output_filepath)</p> <p> except KeyboardInterrupt:<br /> print(“\nOperation cancelled by user.”)<br /> except Exception as e:<br /> print(f”\nAn unexpected critical error occurred: {e}”, file=sys.stderr)</p> <p> print(“\nOperation finished.”)</p> <p># — Script Execution —<br /> if __name__ == “__main__”:<br /> run_interactive()<br />