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.3.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.3-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: uncomment-3.0.3.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.3.tar.gz
Algorithm Hash digest
SHA256 2dc2bbb3acefe6145f5f476672f6ef5a30b60ed4515bfd7ab802a7f5f8736a93
MD5 4450d86a70bcc42dcf0cf004b81f62da
BLAKE2b-256 bedc1fb432acc74e4eaf7e3e0aa1e46a93f480e549e96d56dd305298b3663f99

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: uncomment-3.0.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 db646cc1ba8abe807fd30584dc845d3d0f62c8f2e1c86b9bc4bd3f4566fafe3c
MD5 1d7395d3b03076c3370dab1ab3719d50
BLAKE2b-256 918dd9fe07da78a2b0aec1afa59bf3c6ad411b3472ee2af5edbfa2891b15ce76

See more details on using hashes here.

Provenance

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