Pycln - Unused Import Cleaner

2.6.0 · active · verified Wed Apr 15

Pycln is a fast and efficient code formatter for finding and removing unused import statements in Python code. It helps to keep your codebase clean and reduce unnecessary dependencies. The current version is 2.6.0 and it maintains a relatively frequent release cadence, often aligning with Python version updates and bug fixes.

Warnings

breaking Pycln dropped support for Python 3.8 in version 2.6.0. Users on Python 3.8 or older must use Pycln v2.5.0 or earlier.
Fix: Upgrade to Python 3.9 or newer, or pin Pycln to `<2.6.0`.
breaking Pycln dropped support for Python 3.7 in version 2.5.0. Users on Python 3.7 or older must use Pycln v2.4.0 or earlier.
Fix: Upgrade to Python 3.8 or newer, or pin Pycln to `<2.5.0`.
gotcha When running Pycln with Python 3.14 (or early development versions), versions prior to 2.6.0 might fail due to changes in Python's AST (specifically, `ast.Str` being removed).
Fix: Upgrade to Pycln v2.6.0 or newer for full Python 3.14 compatibility.
gotcha In versions prior to 2.5.0, Pycln could encounter 'missing pyproject.toml' errors when reading configuration, even if the file existed.
Fix: Upgrade to Pycln v2.5.0 or newer. Ensure your `pyproject.toml` is correctly formatted and accessible.
gotcha Implicit imports (e.g., `from package import module` where `module` is not directly used but its side effects are needed) were sometimes misparsed and considered unused in Pycln versions prior to 2.1.6.
Fix: Upgrade to Pycln v2.1.6 or newer. If issues persist, consider using a `--skip` option for specific files or imports that rely heavily on implicit behavior.

Install

pip install pycln Install latest version

Imports

main
```
from pycln.main import main
```
Pycln is primarily a command-line interface (CLI) tool. While you can import and call `main` programmatically, the most common and recommended usage is via the `pycln` command in your terminal.

Quickstart

The primary way to use Pycln is through its command-line interface. Run `pycln .` in your project's root directory to scan and remove unused imports. Use `--check` to preview changes, or `--diff` to see a diff.

# To analyze current directory and remove unused imports:
pycln . 

# To check for unused imports without modifying files:
pycln --check . 

# To include specific files or directories:
pycln my_module.py my_package/

view raw JSON →