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 - 49 built-in languages, 306 available via tree-sitter-language-pack
  • 🔧 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: 49 built-in languages including JavaScript, TypeScript, Rust, Go, Java, C/C++, Ruby, Dockerfile, Scala, Dart, and many more. 306 total languages available via tree-sitter-language-pack.

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-3.0.1.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

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

uncomment-3.0.1-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for uncomment-3.0.1.tar.gz
Algorithm Hash digest
SHA256 a8dc004b35c2f4f14f72815615cb7333d9aaf900e6a16bb87d2d0ffc0bf4f615
MD5 44e2c58bdb5c060e287ad5166f410fe0
BLAKE2b-256 61bb54700c784b6aa23f4295b837affb3c586b0c6ec62e04d60b6efbc2708759

See more details on using hashes here.

Provenance

The following attestation bundles were made for uncomment-3.0.1.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-3.0.1-py3-none-any.whl.

File metadata

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

File hashes

Hashes for uncomment-3.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 eef99ddc882deba5b320a8c4bdbab63572bd64dea83401d64754c53339548e7a
MD5 66da86c80e733b2ce29b745fe1fe25d5
BLAKE2b-256 55f98e5cdcc4bc868ef4d6c715fdfbffc98d106cd32d9a055829801059494f03

See more details on using hashes here.

Provenance

The following attestation bundles were made for uncomment-3.0.1-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