Skip to main content

A fast Rust-based CLI tool for removing comments from source code

Project description

uncomment

PyPI version MIT License

A blazing fast Rust-based command-line tool that removes comments from your source code. Perfect for cleaning up AI-generated code that comes with excessive explanations.

Why Use This?

  • 🚀 Lightning Fast - Built in Rust for maximum performance
  • 🎯 100% Accurate - Never accidentally removes code that looks like comments
  • 🛡️ Safe by Default - Preview changes before applying them
  • 🌍 Multi-language - Supports Python, JS, TS, Rust, Go, Java, C/C++, and more
  • 🔧 Zero Dependencies - Downloads a self-contained binary

Installation

pip install uncomment

The installer will automatically download the appropriate pre-compiled Rust binary for your platform (Windows, macOS, or Linux).

Quick Start

Remove comments from a single file:

uncomment main.py

Preview changes without modifying files:

uncomment --dry-run src/

Process all Python files in a directory:

uncomment "src/**/*.py"

Key Features

Smart Comment Detection

Unlike simple regex-based tools, uncomment understands your code's structure:

# This comment will be removed
code = "# But this won't - it's in a string!"

Preserves Important Comments

Keeps what matters:

  • TODO and FIXME comments (configurable)
  • License headers and copyright notices
  • Linting directives (# noqa, # type: ignore, etc.)
  • Docstrings (configurable)

Perfect for Python Projects

  • Handles all Python comment styles
  • Preserves type hints and annotations
  • Respects # pylint:, # flake8:, and other linter directives
  • Works with .py, .pyw, .pyi, .pyx, and .pxd files

Common Use Cases

Clean up AI-generated code:

uncomment generated_script.py

Remove all comments including TODOs:

uncomment --remove-todo --remove-fixme module.py

Remove docstrings:

uncomment --remove-doc api.py

Process entire packages:

uncomment my_package/

Use multiple threads for large codebases:

uncomment --threads 8 entire_project/

Supported Languages

While this tool works great for Python, it also supports: JavaScript, TypeScript, Rust, Go, Java, C/C++, Ruby, YAML, Terraform/HCL, Makefile, and more!

Documentation

For detailed documentation, advanced options, and examples, visit: https://github.com/Goldziher/uncomment

License

MIT - see LICENSE for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

uncomment-2.10.2.tar.gz (4.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

uncomment-2.10.2-py3-none-any.whl (5.2 kB view details)

Uploaded Python 3

File details

Details for the file uncomment-2.10.2.tar.gz.

File metadata

  • Download URL: uncomment-2.10.2.tar.gz
  • Upload date:
  • Size: 4.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for uncomment-2.10.2.tar.gz
Algorithm Hash digest
SHA256 7d23384f0f29b41b44446aeed69d9d0dd43ec01c44fe4daad443c3ebb12345fe
MD5 fd5f221c869ac6f4efdef0dc2121d473
BLAKE2b-256 42d5f038cb7487478a460b791be8b4121ab130b4fe7812bba82531825277119b

See more details on using hashes here.

Provenance

The following attestation bundles were made for uncomment-2.10.2.tar.gz:

Publisher: publish.yaml on Goldziher/uncomment

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file uncomment-2.10.2-py3-none-any.whl.

File metadata

  • Download URL: uncomment-2.10.2-py3-none-any.whl
  • Upload date:
  • Size: 5.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for uncomment-2.10.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0ebcda4208033869e18e9347fdd06dfa3990ca00ff2c7f2683db7f13bec729a0
MD5 69fa453a5cfb3f477f20e3df6f5b165a
BLAKE2b-256 d952f3f9ff66bcaca2a863b503ea9d194131ccd59a24981fc622fbf41d4d7686

See more details on using hashes here.

Provenance

The following attestation bundles were made for uncomment-2.10.2-py3-none-any.whl:

Publisher: publish.yaml on Goldziher/uncomment

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page