Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Ruff Processor

Purpose

Lints Python source files using ruff.

How It Works

Discovers .py files in the project (excluding common non-source directories), runs ruff check on each file, and creates a stub file on success. A non-zero exit code from ruff fails the product.

This processor supports batch mode, allowing multiple files to be checked in a single ruff invocation for better performance.

Source Files

  • Input: **/*.py
  • Output: out/ruff/{flat_name}.ruff

Configuration

[processor.ruff]
linter = "ruff"                            # The ruff command to run
args = []                                  # Additional arguments to pass to ruff
extra_inputs = []                          # Additional files that trigger rebuilds (e.g. ["pyproject.toml"])
KeyTypeDefaultDescription
linterstring"ruff"The ruff executable to run
argsstring[][]Extra arguments passed to ruff
extra_inputsstring[][]Extra files whose changes trigger rebuilds