Question 1

How do I ignore a specific error in Refurb?

Accepted Answer

Use the --ignore flag with the error code (e.g., --ignore FURB123) or add inline comments like # noqa: FURB123. For broader control, configure ignores in pyproject.toml with amend sections for per-file exclusions.

Question 2

Refurb vs pyupgrade: which should I use?

Accepted Answer

Refurb focuses on making code more elegant and readable, while pyupgrade upgrades syntax to newer Python versions. Use Refurb for general cleanup and pyupgrade for version-specific migrations; they can complement each other.

Question 3

How to write a custom check for Refurb?

Accepted Answer

Use refurb gen to generate a check file (requires fzf), then add your logic based on AST nodes. Load it with --load your.path.here, similar to importing a Python module, and refer to existing checks in the refurb/checks folder for examples.

Question 4

Does Refurb work with GitHub Actions?

Accepted Answer

Yes, set the output format to github using --format github, and Refurb will generate annotations compatible with GitHub Actions, allowing you to view suggestions directly in pull requests.

Question 5

Why is Refurb slow and how can I speed it up?

Accepted Answer

Slowness often stems from Mypy's parsing phase. Use --timing-stats to identify bottlenecks, ignore checks in large files via config, or disable all checks and incrementally enable only needed ones to reduce overhead.

Question 6

Can Refurb check Python 2 code?

Accepted Answer

No, Refurb requires Python 3.10+ to run and primarily checks Python 3.7+ code using the --python-version flag. It's not designed for Python 2, as it focuses on modern syntax and best practices.

refurb

What is refurb?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions