pyclean icon indicating copy to clipboard operation
pyclean copied to clipboard

Display hint on optional topics when using `--debris`

Open bittner opened this issue 2 months ago • 0 comments

Not all users are immediately aware of the implicit and optional features of PyClean's debris cleanup option. See #112 for an example.

PyClean may output a hint on using all or any of the optional topics if -d or --debris (without topic arguments) is used.

Example

$ pyclean . --debris --verbose
...
Hint: The --debris option has optional topics for cleaning up more aggressively. Detected: mypy jupyter
$ pyclean --help
...
options:
  ...
  -d, --debris [TOPIC ...]
                        remove leftovers from popular Python development tools (may be specified multiple times;
                        optional: all jupyter mypy pyright tox; default: cache coverage package pytest ruff),
                        use `-d all` to cover all topics
  ...

bittner avatar Dec 10 '25 18:12 bittner