Document how to avoid ruff removing import hvplot...

[MarcSkovMadsen]

We are migrating from pylint to ruff. ruff --fix --unsafe-fixes removes import hvplot.pandas as an unused import. See https://docs.astral.sh/ruff/rules/unused-import/.

I believe it would be very helpful for lots of users if this issue was discussed and solutions proposed in the docs.

One solution is to import hvplot.pandas # noqa: F401. But its rather painful to do across many files. I wish there was a more general solution.

[hoxbro]

Running it with --unsafe-fixes can give unsafe fixes, which is what this is. Does the problem still happen without the --unsafe-fixes?

You can use extend-unsafe-fixes or unfixable in your settings file to avoid it being automatic removed.

It would be nice if Ruff had a whitelist option for some imports.

[MarcSkovMadsen]

Ruff is actually considering it a "safe" fix. I.e. its removed with ruff --fix.

[hoxbro]

In the next of release of Ruff (the one after 0.6.8), allow-unused-imports has been added.

We should find someplace to mention this in hvplot docs. hvplot.pandas will also be the example in Ruff docs around here.

[tool.ruff.lint.pyflakes]
allowed-unused-imports = ["hvplot.pandas"]

[hoxbro]

Just been released https://github.com/astral-sh/ruff/releases/tag/0.6.9

https://docs.astral.sh/ruff/settings/#lint_pyflakes_allowed-unused-imports