Bump version to 0.0.89

This reverts commit 77e5564f4b.

.pre-commit-config.yaml

@@ -1,8 +1,8 @@
 repos:
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.0.40
+    rev: v0.0.89
     hooks:
-      - id: lint
+      - id: ruff
 
   - repo: https://github.com/abravalheri/validate-pyproject
     rev: v0.10.1

Cargo.lock

@@ -418,9 +418,9 @@ checksum = "fff857943da45f546682664a79488be82e69e43c1a7a2307679ab9afb3a66d2e"
 
 [[package]]
 name = "clap"
-version = "4.0.9"
+version = "4.0.15"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "30607dd93c420c6f1f80b544be522a0238a7db35e6a12968d28910983fee0df0"
+checksum = "6bf8832993da70a4c6d13c581f4463c2bdda27b9bf1c5498dc4365543abe6d6f"
 dependencies = [
  "atty",
  "bitflags",
@@ -433,9 +433,9 @@ dependencies = [
 
 [[package]]
 name = "clap_derive"
-version = "4.0.9"
+version = "4.0.13"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a4a307492e1a34939f79d3b6b9650bd2b971513cd775436bf2b78defeb5af00b"
+checksum = "c42f169caba89a7d512b5418b09864543eeb4d497416c917d7137863bd2076ad"
 dependencies = [
  "heck",
  "proc-macro-error",
@@ -466,6 +466,25 @@ dependencies = [
  "winapi 0.3.9",
 ]
 
+[[package]]
+name = "codegen"
+version = "0.2.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ff61280aed771c3070e7dcc9e050c66f1eb1e3b96431ba66f9f74641d02fc41d"
+dependencies = [
+ "indexmap",
+]
+
+[[package]]
+name = "codespan-reporting"
+version = "0.11.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3538270d33cc669650c4b093848450d380def10c331d38c768e34cac80576e6e"
+dependencies = [
+ "termcolor",
+ "unicode-width",
+]
+
 [[package]]
 name = "colored"
 version = "2.0.0"
@@ -588,6 +607,50 @@ dependencies = [
  "syn",
 ]
 
+[[package]]
+name = "cxx"
+version = "1.0.78"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "19f39818dcfc97d45b03953c1292efc4e80954e1583c4aa770bac1383e2310a4"
+dependencies = [
+ "cc",
+ "cxxbridge-flags",
+ "cxxbridge-macro",
+ "link-cplusplus",
+]
+
+[[package]]
+name = "cxx-build"
+version = "1.0.78"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3e580d70777c116df50c390d1211993f62d40302881e54d4b79727acb83d0199"
+dependencies = [
+ "cc",
+ "codespan-reporting",
+ "once_cell",
+ "proc-macro2",
+ "quote",
+ "scratch",
+ "syn",
+]
+
+[[package]]
+name = "cxxbridge-flags"
+version = "1.0.78"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "56a46460b88d1cec95112c8c363f0e2c39afdb237f60583b0b36343bf627ea9c"
+
+[[package]]
+name = "cxxbridge-macro"
+version = "1.0.78"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "747b608fecf06b0d72d440f27acc99288207324b793be2c17991839f3d4995ea"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
 [[package]]
 name = "diff"
 version = "0.1.13"
@@ -954,8 +1017,10 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "4eb1a864a501629691edf6c15a593b7a51eebaa1e8468e9ddc623de7c9b58ec6"
 dependencies = [
  "cfg-if 1.0.0",
+ "js-sys",
  "libc",
  "wasi 0.11.0+wasi-snapshot-preview1",
+ "wasm-bindgen",
 ]
 
 [[package]]
@@ -981,6 +1046,9 @@ name = "hashbrown"
 version = "0.12.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "8a9ee70c43aaf417c914396645a0fa852624801b24ebb7ae78fe8272889ac888"
+dependencies = [
+ "ahash",
+]
 
 [[package]]
 name = "heck"
@@ -1017,17 +1085,28 @@ checksum = "dfa686283ad6dd069f105e5ab091b04c62850d3e4cf5d67debad1933f55023df"
 
 [[package]]
 name = "iana-time-zone"
-version = "0.1.50"
+version = "0.1.51"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "fd911b35d940d2bd0bea0f9100068e5b97b51a1cbe13d13382f132e0365257a0"
+checksum = "f5a6ef98976b22b3b7f2f3a806f858cb862044cfa66805aa3ad84cb3d3b785ed"
 dependencies = [
  "android_system_properties",
  "core-foundation-sys",
+ "iana-time-zone-haiku",
  "js-sys",
  "wasm-bindgen",
  "winapi 0.3.9",
 ]
 
+[[package]]
+name = "iana-time-zone-haiku"
+version = "0.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "fde6edd6cef363e9359ed3c98ba64590ba9eecba2293eb5a723ab32aee8926aa"
+dependencies = [
+ "cxx",
+ "cxx-build",
+]
+
 [[package]]
 name = "idna"
 version = "0.3.0"
@@ -1111,9 +1190,9 @@ dependencies = [
 
 [[package]]
 name = "itoa"
-version = "1.0.3"
+version = "1.0.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "6c8af84674fe1f223a982c933a0ee1086ac4d4052aa0fb8060c12c6ad838e754"
+checksum = "4217ad341ebadf8d8e724e264f13e593e0648f5b3e94b3896a5df283be015ecc"
 
 [[package]]
 name = "joinery"
@@ -1225,9 +1304,9 @@ dependencies = [
 
 [[package]]
 name = "libc"
-version = "0.2.134"
+version = "0.2.135"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "329c933548736bc49fd575ee68c89e8be4d260064184389a5b77517cddd99ffb"
+checksum = "68783febc7782c6c5cb401fbda4de5a9898be1762314da0bb2c10ced61f18b0c"
 
 [[package]]
 name = "libcst"
@@ -1253,6 +1332,15 @@ dependencies = [
  "syn",
 ]
 
+[[package]]
+name = "link-cplusplus"
+version = "1.0.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9272ab7b96c9046fbc5bc56c06c117cb639fe2d509df0c421cad82d2915cf369"
+dependencies = [
+ "cc",
+]
+
 [[package]]
 name = "linked-hash-map"
 version = "0.5.6"
@@ -1538,18 +1626,18 @@ checksum = "b1de2e551fb905ac83f73f7aedf2f0cb4a0da7e35efa24a202a936269f1f18e1"
 
 [[package]]
 name = "path-absolutize"
-version = "3.0.13"
+version = "3.0.14"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d3de4b40bd9736640f14c438304c09538159802388febb02c8abaae0846c1f13"
+checksum = "0f1d4993b16f7325d90c18c3c6a3327db7808752db8d208cea0acee0abd52c52"
 dependencies = [
  "path-dedot",
 ]
 
 [[package]]
 name = "path-dedot"
-version = "3.0.17"
+version = "3.0.18"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d611d5291372b3738a34ebf0d1f849e58b1dcc1101032f76a346eaa1f8ddbb5b"
+checksum = "9a81540d94551664b72b72829b12bd167c73c9d25fbac0e04fafa8023f7e4901"
 dependencies = [
  "once_cell",
 ]
@@ -1966,7 +2054,7 @@ dependencies = [
 
 [[package]]
 name = "ruff"
-version = "0.0.73"
+version = "0.0.89"
 dependencies = [
  "anyhow",
  "assert_cmd",
@@ -1975,11 +2063,13 @@ dependencies = [
  "chrono",
  "clap",
  "clearscreen",
+ "codegen",
  "colored",
  "common-path",
  "dirs 4.0.0",
  "fern",
  "filetime",
+ "getrandom 0.2.7",
  "glob",
  "insta",
  "itertools",
@@ -1999,6 +2089,7 @@ dependencies = [
  "strum",
  "strum_macros",
  "test-case",
+ "textwrap",
  "titlecase",
  "toml",
  "update-informer",
@@ -2020,7 +2111,7 @@ dependencies = [
 [[package]]
 name = "rustpython-ast"
 version = "0.1.0"
-source = "git+https://github.com/charliermarsh/RustPython.git?rev=778ae2aeb521d0438d2a91bd11238bb5c2bf9d4f#778ae2aeb521d0438d2a91bd11238bb5c2bf9d4f"
+source = "git+https://github.com/charliermarsh/RustPython.git?rev=1b253a12705f84972cd76e8dc1cdaaccb233e5a5#1b253a12705f84972cd76e8dc1cdaaccb233e5a5"
 dependencies = [
  "num-bigint",
  "rustpython-common",
@@ -2030,7 +2121,7 @@ dependencies = [
 [[package]]
 name = "rustpython-common"
 version = "0.0.0"
-source = "git+https://github.com/charliermarsh/RustPython.git?rev=778ae2aeb521d0438d2a91bd11238bb5c2bf9d4f#778ae2aeb521d0438d2a91bd11238bb5c2bf9d4f"
+source = "git+https://github.com/charliermarsh/RustPython.git?rev=1b253a12705f84972cd76e8dc1cdaaccb233e5a5#1b253a12705f84972cd76e8dc1cdaaccb233e5a5"
 dependencies = [
  "ascii",
  "cfg-if 1.0.0",
@@ -2053,7 +2144,7 @@ dependencies = [
 [[package]]
 name = "rustpython-compiler-core"
 version = "0.1.2"
-source = "git+https://github.com/charliermarsh/RustPython.git?rev=778ae2aeb521d0438d2a91bd11238bb5c2bf9d4f#778ae2aeb521d0438d2a91bd11238bb5c2bf9d4f"
+source = "git+https://github.com/charliermarsh/RustPython.git?rev=1b253a12705f84972cd76e8dc1cdaaccb233e5a5#1b253a12705f84972cd76e8dc1cdaaccb233e5a5"
 dependencies = [
  "bincode",
  "bitflags",
@@ -2070,7 +2161,7 @@ dependencies = [
 [[package]]
 name = "rustpython-parser"
 version = "0.1.2"
-source = "git+https://github.com/charliermarsh/RustPython.git?rev=778ae2aeb521d0438d2a91bd11238bb5c2bf9d4f#778ae2aeb521d0438d2a91bd11238bb5c2bf9d4f"
+source = "git+https://github.com/charliermarsh/RustPython.git?rev=1b253a12705f84972cd76e8dc1cdaaccb233e5a5#1b253a12705f84972cd76e8dc1cdaaccb233e5a5"
 dependencies = [
  "ahash",
  "anyhow",
@@ -2118,6 +2209,12 @@ version = "1.1.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "d29ab0c6d3fc0ee92fe66e2d99f700eab17a8d57d1c1d3b748380fb20baa78cd"
 
+[[package]]
+name = "scratch"
+version = "1.0.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9c8132065adcfd6e02db789d9285a0deb2f3fcb04002865ab67d5fb103533898"
+
 [[package]]
 name = "sct"
 version = "0.7.0"
@@ -2156,9 +2253,9 @@ dependencies = [
 
 [[package]]
 name = "serde_json"
-version = "1.0.85"
+version = "1.0.86"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e55a28e3aaef9d5ce0506d0a14dbba8054ddc7e499ef522dd8b26859ec9d4a44"
+checksum = "41feea4228a6f1cd09ec7a3593a682276702cd67b5273544757dae23c096f074"
 dependencies = [
  "itoa",
  "ryu",
@@ -2261,6 +2358,12 @@ version = "1.10.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "a507befe795404456341dfab10cef66ead4c041f62b8b11bbb92bffe5d0953e0"
 
+[[package]]
+name = "smawk"
+version = "0.3.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f67ad224767faa3c7d8b6d91985b78e70a1324408abcb1cfcc2be4c06bc06043"
+
 [[package]]
 name = "socket2"
 version = "0.4.7"
@@ -2341,9 +2444,9 @@ dependencies = [
 
 [[package]]
 name = "syn"
-version = "1.0.101"
+version = "1.0.102"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e90cde112c4b9690b8cbe810cba9ddd8bc1d7472e2cae317b69e9438c1cba7d2"
+checksum = "3fcd952facd492f9be3ef0d0b7032a6e442ee9b361d4acc2b1d0c4aaa5f613a1"
 dependencies = [
  "proc-macro2",
  "quote",
@@ -2435,6 +2538,17 @@ dependencies = [
  "syn",
 ]
 
+[[package]]
+name = "textwrap"
+version = "0.15.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "949517c0cf1bf4ee812e2e07e08ab448e3ae0d23472aee8a06c985f0c8815b16"
+dependencies = [
+ "smawk",
+ "unicode-linebreak",
+ "unicode-width",
+]
+
 [[package]]
 name = "thiserror"
 version = "1.0.37"
@@ -2598,9 +2712,19 @@ checksum = "099b7128301d285f79ddd55b9a83d5e6b9e97c92e0ea0daebee7263e932de992"
 
 [[package]]
 name = "unicode-ident"
-version = "1.0.4"
+version = "1.0.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "dcc811dc4066ac62f84f11307873c4850cb653bfa9b1719cee2bd2204a4bc5dd"
+checksum = "6ceab39d59e4c9499d4e5a8ee0e2735b891bb7308ac83dfb4e80cad195c9f6f3"
+
+[[package]]
+name = "unicode-linebreak"
+version = "0.1.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c5faade31a542b8b35855fff6e8def199853b2da8da256da52f52f1316ee3137"
+dependencies = [
+ "hashbrown",
+ "regex",
+]
 
 [[package]]
 name = "unicode-normalization"
@@ -2611,6 +2735,12 @@ dependencies = [
  "tinyvec",
 ]
 
+[[package]]
+name = "unicode-width"
+version = "0.1.10"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c0edd1e5b14653f783770bce4a4dabb4a5108a5370a5f5d8cfe8710c361f6c8b"
+
 [[package]]
 name = "unicode-xid"
 version = "0.2.4"

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ruff"
-version = "0.0.73"
+version = "0.0.89"
 edition = "2021"
 
 [lib]
@@ -9,10 +9,8 @@ name = "ruff"
 [dependencies]
 anyhow = { version = "1.0.60" }
 bincode = { version = "1.3.3" }
-cacache = { version = "10.0.1" }
 chrono = { version = "0.4.21" }
 clap = { version = "4.0.1", features = ["derive"] }
-clearscreen = { version = "1.0.10" }
 colored = { version = "2.0.0" }
 common-path = { version = "1.0.0" }
 dirs = { version = "4.0.0" }
@@ -25,23 +23,34 @@ log = { version = "0.4.17" }
 notify = { version = "4.0.17" }
 num-bigint = { version = "0.4.3" }
 once_cell = { version = "1.13.1" }
-path-absolutize = { version = "3.0.13", features = ["once_cell_cache"] }
+path-absolutize = { version = "3.0.14", features = ["once_cell_cache", "use_unix_paths_on_wasm"] }
 rayon = { version = "1.5.3" }
 regex = { version = "1.6.0" }
-rustpython-ast = { features = ["unparse"], git = "https://github.com/charliermarsh/RustPython.git", rev = "778ae2aeb521d0438d2a91bd11238bb5c2bf9d4f" }
-rustpython-common = { git = "https://github.com/charliermarsh/RustPython.git", rev = "778ae2aeb521d0438d2a91bd11238bb5c2bf9d4f" }
-rustpython-parser = { features = ["lalrpop"], git = "https://github.com/charliermarsh/RustPython.git", rev = "778ae2aeb521d0438d2a91bd11238bb5c2bf9d4f" }
+rustpython-ast = { features = ["unparse"], git = "https://github.com/charliermarsh/RustPython.git", rev = "1b253a12705f84972cd76e8dc1cdaaccb233e5a5" }
+rustpython-common = { git = "https://github.com/charliermarsh/RustPython.git", rev = "1b253a12705f84972cd76e8dc1cdaaccb233e5a5" }
+rustpython-parser = { features = ["lalrpop"], git = "https://github.com/charliermarsh/RustPython.git", rev = "1b253a12705f84972cd76e8dc1cdaaccb233e5a5" }
 serde = { version = "1.0.143", features = ["derive"] }
 serde_json = { version = "1.0.83" }
 strum = { version = "0.24.1", features = ["strum_macros"] }
 strum_macros = { version = "0.24.3" }
+textwrap = { version = "0.15.1" }
 titlecase = { version = "2.2.1" }
 toml = { version = "0.5.9" }
 update-informer = { version = "0.5.0", default_features = false, features = ["pypi"], optional = true }
 walkdir = { version = "2.3.2" }
 
+[target.'cfg(not(target_family = "wasm"))'.dependencies]
+cacache = { version = "10.0.1" } # uses async-std
+clearscreen = { version = "1.0.10" } # uses which
+
+# https://docs.rs/getrandom/0.2.7/getrandom/#webassembly-support
+# For (future) wasm-pack support
+[target.'cfg(all(target_family = "wasm", target_os = "unknown"))'.dependencies]
+getrandom = { version = "0.2.7", features = ["js"] }
+
 [dev-dependencies]
 assert_cmd = { version = "2.0.4" }
+codegen = { version = "0.2.0" }
 insta = { version = "1.19.1", features = ["yaml"] }
 test-case = { version = "2.2.2" }
 

README.md

@@ -1,4 +1,4 @@
-# ruff
+# Ruff
 
 [![image](https://img.shields.io/pypi/v/ruff.svg)](https://pypi.python.org/pypi/ruff)
 [![image](https://img.shields.io/pypi/l/ruff.svg)](https://pypi.python.org/pypi/ruff)
@@ -20,17 +20,37 @@ An extremely fast Python linter, written in Rust.
 - 🤝 Python 3.10 compatibility
 - 🛠️ `pyproject.toml` support
 - 📦 [ESLint](https://eslint.org/docs/latest/user-guide/command-line-interface#caching)-inspired cache support
-- 🔧 [ESLint](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix)-inspired `--fix` support
-- 👀 [TypeScript](https://www.typescriptlang.org/docs/handbook/configuring-watch.html)-inspired `--watch` support
-- ⚖️ [Near-complete parity](#Parity-with-Flake8) with the built-in Flake8 rule set
+- 🔧 [ESLint](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix)-inspired autofix support (e.g., automatically remove unused imports)
+- 👀 [TypeScript](https://www.typescriptlang.org/docs/handbook/configuring-watch.html)-inspired `--watch` support, for continuous file monitoring
+- ⚖️ [Near-parity](#how-does-ruff-compare-to-flake8) with the built-in Flake8 rule set
+- 🔌 Native re-implementations of popular Flake8 plugins, like [`flake8-docstrings`](https://pypi.org/project/flake8-docstrings/) ([`pydocstyle`](https://pypi.org/project/pydocstyle/))
+
+Ruff aims to be orders of magnitude faster than alternative tools while integrating more
+functionality behind a single, common interface. Ruff can be used to replace Flake8 (plus a variety
+of plugins), [`pydocstyle`](https://pypi.org/project/pydocstyle/), [`yesqa`](https://github.com/asottile/yesqa),
+and even a subset of [`pyupgrade`](https://pypi.org/project/pyupgrade/) and [`autoflake`](https://pypi.org/project/autoflake/)
+all while executing tens or hundreds of times faster than any individual tool.
 
 Read the [launch blog post](https://notes.crmarsh.com/python-tooling-could-be-much-much-faster).
 
-## Installation and usage
+## Table of Contents
+
+1. [Installation and Usage](#installation-and-usage)
+2. [Configuration](#configuration)
+3. [Supported Rules](#supported-rules)
+4. [Editor Integrations](#editor-integrations)
+5. [FAQ](#faq)
+6. [Development](#development)
+7. [Releases](#releases)
+8. [Benchmarks](#benchmarks)
+9. [License](#license)
+10. [Contributing](#contributing)
+
+## Installation and Usage
 
 ### Installation
 
-Available as [ruff](https://pypi.org/project/ruff/) on PyPI:
+Available as [`ruff`](https://pypi.org/project/ruff/) on PyPI:
 
 ```shell
 pip install ruff
@@ -38,7 +58,7 @@ pip install ruff
 
 ### Usage
 
-To run ruff, try any of the following:
+To run Ruff, try any of the following:
 
 ```shell
 ruff path/to/code/to/check.py
@@ -46,38 +66,53 @@ ruff path/to/code/
 ruff path/to/code/*.py
 ```
 
-You can run ruff in `--watch` mode to automatically re-run on-change:
+You can run Ruff in `--watch` mode to automatically re-run on-change:
 
 ```shell
 ruff path/to/code/ --watch
 ```
 
-ruff also works with [pre-commit](https://pre-commit.com):
+Ruff also works with [pre-commit](https://pre-commit.com):
 
 ```yaml
 repos:
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.0.73
+    rev: v0.0.89
     hooks:
-      - id: lint
+      - id: ruff
 ```
 
+<!-- TODO(charlie): Remove this message a few versions after v0.0.86. -->
+_Note: prior to `v0.0.86`, `ruff-pre-commit` used `lint` (rather than `ruff`) as the hook ID._
+
 ## Configuration
 
-ruff is configurable both via `pyproject.toml` and the command line.
+Ruff is configurable both via `pyproject.toml` and the command line.
 
-For example, you could configure ruff to only enforce a subset of rules with:
+For example, you could configure Ruff to only enforce a subset of rules with:
 
 ```toml
 [tool.ruff]
 line-length = 88
-select = [
-    "F401",
-    "F403",
+select = ["E", "F"]
+ignore = ["E501"]
+per-file-ignores = [
+    "__init__.py:F401",
+    "path/to/file.py:F401"
 ]
 ```
 
-Alternatively, on the command-line:
+Plugin configurations should be expressed as subsections, e.g.:
+
+```toml
+[tool.ruff]
+line-length = 88
+
+[tool.ruff.flake8-quotes]
+docstring-quotes = "double"
+```
+
+Alternatively, common configuration settings can be provided via the command-line:
 
 ```shell
 ruff path/to/code/ --select F401 --select F403
@@ -158,7 +193,7 @@ Exclusions are based on globs, and can be either:
 To omit a lint check entirely, add it to the "ignore" list via `--ignore` or `--extend-ignore`,
 either  on the command-line or in your `project.toml` file.
 
-To ignore an error in-line, ruff uses a `noqa` system similar to [Flake8](https://flake8.pycqa.org/en/3.1.1/user/ignoring-errors.html).
+To ignore an error in-line, Ruff uses a `noqa` system similar to [Flake8](https://flake8.pycqa.org/en/3.1.1/user/ignoring-errors.html).
 To ignore an individual error, add `# noqa: {code}` to the end of the line, like so:
 
 ```python
@@ -182,195 +217,248 @@ Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor i
 """  # noqa: E501
 ```
 
-ruff supports several (experimental) workflows to aid in `noqa` management.
+Ruff supports several workflows to aid in `noqa` management.
 
-First, ruff provides a special error code, `M001`, to enforce that your `noqa` directives are
+First, Ruff provides a special error code, `M001`, to enforce that your `noqa` directives are
 "valid", in that the errors they _say_ they ignore are actually being triggered on that line (and
 thus suppressed). **You can run `ruff /path/to/file.py --extend-select M001` to flag unused `noqa`
 directives.**
 
-Second, ruff can _automatically remove_ unused `noqa` directives via its autofix functionality.
+Second, Ruff can _automatically remove_ unused `noqa` directives via its autofix functionality.
 **You can run `ruff /path/to/file.py --extend-select M001 --fix` to automatically remove unused
 `noqa` directives.**
 
-Third, ruff can _automatically add_ `noqa` directives to all failing lines. This is useful when
-migrating a new codebase to ruff. **You can run `ruff /path/to/file.py --add-noqa` to automatically
+Third, Ruff can _automatically add_ `noqa` directives to all failing lines. This is useful when
+migrating a new codebase to Ruff. **You can run `ruff /path/to/file.py --add-noqa` to automatically
 add `noqa` directives to all failing lines, with the appropriate error codes.**
 
-### Compatibility with Black
+## Supported Rules
 
-ruff is compatible with [Black](https://github.com/psf/black) out-of-the-box, as long as
-the `line-length` setting is consistent between the two.
-
-As a project, ruff is designed to be used alongside Black and, as such, will defer implementing
-stylistic lint rules that are obviated by autoformatting.
-
-### Parity with Flake8
-
-ruff's goal is to achieve feature parity with Flake8 when used (1) without plugins, (2) alongside
-Black, and (3) on Python 3 code.
-
-**Under those conditions, ruff implements 44 out of 60 rules.** (ruff is missing: 14 rules related
-to string `.format` calls, 1 rule related to docstring parsing, and 1 rule related to redefined
-variables.)
-
-ruff also implements some of the most popular Flake8 plugins natively, including:
-
-- [`flake8-builtins`](https://pypi.org/project/flake8-builtins/)
-- [`flake8-super`](https://pypi.org/project/flake8-super/)
-- [`flake8-print`](https://pypi.org/project/flake8-print/)
-- [`flake8-comprehensions`](https://pypi.org/project/flake8-comprehensions/) (15/16)
-- [`flake8-bugbear`](https://pypi.org/project/flake8-bugbear/) (3/32)
-- [`flake8-docstrings`](https://pypi.org/project/flake8-docstrings/) (37/48)
-- [`pyupgrade`](https://pypi.org/project/pyupgrade/) (8/34)
-
-Beyond rule-set parity, ruff suffers from the following limitations vis-à-vis Flake8:
-
-1. ruff does not yet support a few Python 3.9 and 3.10 language features, including structural
-   pattern matching and parenthesized context managers.
-2. Flake8 has a plugin architecture and supports writing custom lint rules.
-
-## Rules
-
-The ✅ emoji indicates a rule is enabled by default.
+By default, Ruff enables all `E` and `F` error codes, which correspond to those built-in to Flake8.
 
 The 🛠 emoji indicates that a rule is automatically fixable by the `--fix` command-line option.
 
-| Code | Name | Message |     |     |
-| ---- | ---- | ------- | --- | --- |
-| E402 | ModuleImportNotAtTopOfFile | Module level import not at top of file | ✅ |  |
-| E501 | LineTooLong | Line too long (89 > 88 characters) | ✅ |  |
-| E711 | NoneComparison | Comparison to `None` should be `cond is None` | ✅ |  |
-| E712 | TrueFalseComparison | Comparison to `True` should be `cond is True` | ✅ |  |
-| E713 | NotInTest | Test for membership should be `not in` | ✅ |  |
-| E714 | NotIsTest | Test for object identity should be `is not` | ✅ |  |
-| E721 | TypeComparison | Do not compare types, use `isinstance()` | ✅ |  |
-| E722 | DoNotUseBareExcept | Do not use bare `except` | ✅ |  |
-| E731 | DoNotAssignLambda | Do not assign a lambda expression, use a def | ✅ |  |
-| E741 | AmbiguousVariableName | Ambiguous variable name: `...` | ✅ |  |
-| E742 | AmbiguousClassName | Ambiguous class name: `...` | ✅ |  |
-| E743 | AmbiguousFunctionName | Ambiguous function name: `...` | ✅ |  |
-| E902 | IOError | IOError: `...` | ✅ |  |
-| E999 | SyntaxError | SyntaxError: `...` | ✅ |  |
-| W292 | NoNewLineAtEndOfFile | No newline at end of file | ✅ |  |
-| F401 | UnusedImport | `...` imported but unused | ✅ | 🛠 |
-| F402 | ImportShadowedByLoopVar | Import `...` from line 1 shadowed by loop variable | ✅ |  |
-| F403 | ImportStarUsed | `from ... import *` used; unable to detect undefined names | ✅ |  |
-| F404 | LateFutureImport | `from __future__` imports must occur at the beginning of the file | ✅ |  |
-| F405 | ImportStarUsage | `...` may be undefined, or defined from star imports: `...` | ✅ |  |
-| F406 | ImportStarNotPermitted | `from ... import *` only allowed at module level | ✅ |  |
-| F407 | FutureFeatureNotDefined | Future feature `...` is not defined | ✅ |  |
-| F541 | FStringMissingPlaceholders | f-string without any placeholders | ✅ |  |
-| F601 | MultiValueRepeatedKeyLiteral | Dictionary key literal repeated | ✅ |  |
-| F602 | MultiValueRepeatedKeyVariable | Dictionary key `...` repeated | ✅ |  |
-| F621 | ExpressionsInStarAssignment | Too many expressions in star-unpacking assignment | ✅ |  |
-| F622 | TwoStarredExpressions | Two starred expressions in assignment | ✅ |  |
-| F631 | AssertTuple | Assert test is a non-empty tuple, which is always `True` | ✅ |  |
-| F632 | IsLiteral | Use `==` and `!=` to compare constant literals | ✅ |  |
-| F633 | InvalidPrintSyntax | Use of `>>` is invalid with `print` function | ✅ |  |
-| F634 | IfTuple | If test is a tuple, which is always `True` | ✅ |  |
-| F701 | BreakOutsideLoop | `break` outside loop | ✅ |  |
-| F702 | ContinueOutsideLoop | `continue` not properly in loop | ✅ |  |
-| F704 | YieldOutsideFunction | `yield` or `yield from` statement outside of a function/method | ✅ |  |
-| F706 | ReturnOutsideFunction | `return` statement outside of a function/method | ✅ |  |
-| F707 | DefaultExceptNotLast | An `except:` block as not the last exception handler | ✅ |  |
-| F722 | ForwardAnnotationSyntaxError | Syntax error in forward annotation: `...` | ✅ |  |
-| F821 | UndefinedName | Undefined name `...` | ✅ |  |
-| F822 | UndefinedExport | Undefined name `...` in `__all__` | ✅ |  |
-| F823 | UndefinedLocal | Local variable `...` referenced before assignment | ✅ |  |
-| F831 | DuplicateArgumentName | Duplicate argument name in function definition | ✅ |  |
-| F841 | UnusedVariable | Local variable `...` is assigned to but never used | ✅ |  |
-| F901 | RaiseNotImplemented | `raise NotImplemented` should be `raise NotImplementedError` | ✅ |  |
-| A001 | BuiltinVariableShadowing | Variable `...` is shadowing a python builtin |  |  |
-| A002 | BuiltinArgumentShadowing | Argument `...` is shadowing a python builtin |  |  |
-| A003 | BuiltinAttributeShadowing | Class attribute `...` is shadowing a python builtin |  |  |
-| B011 | DoNotAssertFalse | Do not `assert False` (`python -O` removes these calls), raise `AssertionError()` |  | 🛠 |
-| B014 | DuplicateHandlerException | Exception handler with duplicate exception: `ValueError` |  | 🛠 |
-| B025 | DuplicateTryBlockException | try-except block with duplicate exception `Exception` |  |  |
-| C400 | UnnecessaryGeneratorList | Unnecessary generator - rewrite as a list comprehension |  |  |
-| C401 | UnnecessaryGeneratorSet | Unnecessary generator - rewrite as a set comprehension |  |  |
-| C402 | UnnecessaryGeneratorDict | Unnecessary generator - rewrite as a dict comprehension |  |  |
-| C403 | UnnecessaryListComprehensionSet | Unnecessary list comprehension - rewrite as a set comprehension |  |  |
-| C404 | UnnecessaryListComprehensionDict | Unnecessary list comprehension - rewrite as a dict comprehension |  |  |
-| C405 | UnnecessaryLiteralSet | Unnecessary <list/tuple> literal - rewrite as a set literal |  |  |
-| C406 | UnnecessaryLiteralDict | Unnecessary <list/tuple> literal - rewrite as a dict literal |  |  |
-| C408 | UnnecessaryCollectionCall | Unnecessary <dict/list/tuple> call - rewrite as a literal |  |  |
-| C409 | UnnecessaryLiteralWithinTupleCall | Unnecessary <list/tuple> literal passed to tuple() - remove the outer call to tuple() |  |  |
-| C410 | UnnecessaryLiteralWithinListCall | Unnecessary <list/tuple> literal passed to list() - rewrite as a list literal |  |  |
-| C411 | UnnecessaryListCall | Unnecessary list call - remove the outer call to list() |  |  |
-| C413 | UnnecessaryCallAroundSorted | Unnecessary <list/reversed> call around sorted() |  |  |
-| C414 | UnnecessaryDoubleCastOrProcess | Unnecessary <list/reversed/set/sorted/tuple> call within <list/set/sorted/tuple>(). |  |  |
-| C415 | UnnecessarySubscriptReversal | Unnecessary subscript reversal of iterable within <reversed/set/sorted>() |  |  |
-| C416 | UnnecessaryComprehension |  Unnecessary <list/set> comprehension - rewrite using <list/set>() |  |  |
-| T201 | PrintFound | `print` found |  | 🛠 |
-| T203 | PPrintFound | `pprint` found |  | 🛠 |
-| U001 | UselessMetaclassType | `__metaclass__ = type` is implied |  | 🛠 |
-| U002 | UnnecessaryAbspath | `abspath(__file__)` is unnecessary in Python 3.9 and later |  | 🛠 |
-| U003 | TypeOfPrimitive | Use `str` instead of `type(...)` |  | 🛠 |
-| U004 | UselessObjectInheritance | Class `...` inherits from object |  | 🛠 |
-| U005 | DeprecatedUnittestAlias | `assertEquals` is deprecated, use `assertEqual` instead |  | 🛠 |
-| U006 | UsePEP585Annotation | Use `list` instead of `List` for type annotations |  | 🛠 |
-| U007 | UsePEP604Annotation | Use `X \| Y` for type annotations |  | 🛠 |
-| U008 | SuperCallWithParameters | Use `super()` instead of `super(__class__, self)` |  | 🛠 |
-| D100 | PublicModule | Missing docstring in public module |  |  |
-| D101 | PublicClass | Missing docstring in public class |  |  |
-| D102 | PublicMethod | Missing docstring in public method |  |  |
-| D103 | PublicFunction | Missing docstring in public function |  |  |
-| D104 | PublicPackage | Missing docstring in public package |  |  |
-| D105 | MagicMethod | Missing docstring in magic method |  |  |
-| D106 | PublicNestedClass | Missing docstring in public nested class |  |  |
-| D107 | PublicInit | Missing docstring in __init__ |  |  |
-| D200 | FitsOnOneLine | One-line docstring should fit on one line |  |  |
-| D201 | NoBlankLineBeforeFunction | No blank lines allowed before function docstring (found 1) |  |  |
-| D202 | NoBlankLineAfterFunction | No blank lines allowed after function docstring (found 1) |  |  |
-| D203 | OneBlankLineBeforeClass | 1 blank line required before class docstring |  |  |
-| D204 | OneBlankLineAfterClass | 1 blank line required after class docstring |  |  |
-| D205 | NoBlankLineAfterSummary | 1 blank line required between summary line and description |  |  |
-| D209 | NewLineAfterLastParagraph | Multi-line docstring closing quotes should be on a separate line |  |  |
-| D210 | NoSurroundingWhitespace | No whitespaces allowed surrounding docstring text |  |  |
-| D211 | NoBlankLineBeforeClass | No blank lines allowed before class docstring |  |  |
-| D212 | MultiLineSummaryFirstLine | Multi-line docstring summary should start at the first line |  |  |
-| D213 | MultiLineSummarySecondLine | Multi-line docstring summary should start at the second line |  |  |
-| D214 | SectionNotOverIndented | Section is over-indented ("Returns") |  |  |
-| D215 | SectionUnderlineNotOverIndented | Section underline is over-indented ("Returns") |  |  |
-| D300 | UsesTripleQuotes | Use """triple double quotes""" |  |  |
-| D400 | EndsInPeriod | First line should end with a period |  |  |
-| D402 | NoSignature | First line should not be the function's 'signature' |  |  |
-| D403 | FirstLineCapitalized | First word of the first line should be properly capitalized |  |  |
-| D404 | NoThisPrefix | First word of the docstring should not be `This` |  |  |
-| D405 | CapitalizeSectionName | Section name should be properly capitalized ("returns") |  |  |
-| D406 | NewLineAfterSectionName | Section name should end with a newline ("Returns") |  |  |
-| D407 | DashedUnderlineAfterSection | Missing dashed underline after section ("Returns") |  |  |
-| D408 | SectionUnderlineAfterName | Section underline should be in the line following the section's name ("Returns") |  |  |
-| D409 | SectionUnderlineMatchesSectionLength | Section underline should match the length of its name ("Returns") |  |  |
-| D410 | BlankLineAfterSection | Missing blank line after section ("Returns") |  |  |
-| D411 | BlankLineBeforeSection | Missing blank line before section ("Returns") |  |  |
-| D412 | NoBlankLinesBetweenHeaderAndContent | No blank lines allowed between a section header and its content ("Returns") |  |  |
-| D413 | BlankLineAfterLastSection | Missing blank line after last section ("Returns") |  |  |
-| D414 | NonEmptySection | Section has no content ("Returns") |  |  |
-| D415 | EndsInPunctuation | First line should end with a period, question mark, or exclamation point |  |  |
-| D417 | DocumentAllArguments | Missing argument descriptions in the docstring: `x`, `y` |  |  |
-| D418 | SkipDocstring | Function decorated with @overload shouldn't contain a docstring |  |  |
-| D419 | NonEmpty | Docstring is empty |  |  |
-| M001 | UnusedNOQA | Unused `noqa` directive |  | 🛠 |
+### Pyflakes
 
-## Integrations
+| Code | Name | Message | Fix |
+| ---- | ---- | ------- | --- |
+| F401 | UnusedImport | `...` imported but unused | 🛠 |
+| F402 | ImportShadowedByLoopVar | Import `...` from line 1 shadowed by loop variable |  |
+| F403 | ImportStarUsed | `from ... import *` used; unable to detect undefined names |  |
+| F404 | LateFutureImport | `from __future__` imports must occur at the beginning of the file |  |
+| F405 | ImportStarUsage | `...` may be undefined, or defined from star imports: `...` |  |
+| F406 | ImportStarNotPermitted | `from ... import *` only allowed at module level |  |
+| F407 | FutureFeatureNotDefined | Future feature `...` is not defined |  |
+| F541 | FStringMissingPlaceholders | f-string without any placeholders |  |
+| F601 | MultiValueRepeatedKeyLiteral | Dictionary key literal repeated |  |
+| F602 | MultiValueRepeatedKeyVariable | Dictionary key `...` repeated |  |
+| F621 | ExpressionsInStarAssignment | Too many expressions in star-unpacking assignment |  |
+| F622 | TwoStarredExpressions | Two starred expressions in assignment |  |
+| F631 | AssertTuple | Assert test is a non-empty tuple, which is always `True` |  |
+| F632 | IsLiteral | Use `==` and `!=` to compare constant literals |  |
+| F633 | InvalidPrintSyntax | Use of `>>` is invalid with `print` function |  |
+| F634 | IfTuple | If test is a tuple, which is always `True` |  |
+| F701 | BreakOutsideLoop | `break` outside loop |  |
+| F702 | ContinueOutsideLoop | `continue` not properly in loop |  |
+| F704 | YieldOutsideFunction | `yield` or `yield from` statement outside of a function/method |  |
+| F706 | ReturnOutsideFunction | `return` statement outside of a function/method |  |
+| F707 | DefaultExceptNotLast | An `except:` block as not the last exception handler |  |
+| F722 | ForwardAnnotationSyntaxError | Syntax error in forward annotation: `...` |  |
+| F821 | UndefinedName | Undefined name `...` |  |
+| F822 | UndefinedExport | Undefined name `...` in `__all__` |  |
+| F823 | UndefinedLocal | Local variable `...` referenced before assignment |  |
+| F831 | DuplicateArgumentName | Duplicate argument name in function definition |  |
+| F841 | UnusedVariable | Local variable `...` is assigned to but never used |  |
+| F901 | RaiseNotImplemented | `raise NotImplemented` should be `raise NotImplementedError` |  |
+
+### pycodestyle (error)
+
+| Code | Name | Message | Fix |
+| ---- | ---- | ------- | --- |
+| E402 | ModuleImportNotAtTopOfFile | Module level import not at top of file |  |
+| E501 | LineTooLong | Line too long (89 > 88 characters) |  |
+| E711 | NoneComparison | Comparison to `None` should be `cond is None` |  |
+| E712 | TrueFalseComparison | Comparison to `True` should be `cond is True` |  |
+| E713 | NotInTest | Test for membership should be `not in` |  |
+| E714 | NotIsTest | Test for object identity should be `is not` |  |
+| E721 | TypeComparison | Do not compare types, use `isinstance()` |  |
+| E722 | DoNotUseBareExcept | Do not use bare `except` |  |
+| E731 | DoNotAssignLambda | Do not assign a lambda expression, use a def |  |
+| E741 | AmbiguousVariableName | Ambiguous variable name: `...` |  |
+| E742 | AmbiguousClassName | Ambiguous class name: `...` |  |
+| E743 | AmbiguousFunctionName | Ambiguous function name: `...` |  |
+| E902 | IOError | IOError: `...` |  |
+| E999 | SyntaxError | SyntaxError: `...` |  |
+
+### pycodestyle (warning)
+
+| Code | Name | Message | Fix |
+| ---- | ---- | ------- | --- |
+| W292 | NoNewLineAtEndOfFile | No newline at end of file |  |
+| W605 | InvalidEscapeSequence | Invalid escape sequence: '\c' |  |
+
+### pydocstyle
+
+| Code | Name | Message | Fix |
+| ---- | ---- | ------- | --- |
+| D100 | PublicModule | Missing docstring in public module |  |
+| D101 | PublicClass | Missing docstring in public class |  |
+| D102 | PublicMethod | Missing docstring in public method |  |
+| D103 | PublicFunction | Missing docstring in public function |  |
+| D104 | PublicPackage | Missing docstring in public package |  |
+| D105 | MagicMethod | Missing docstring in magic method |  |
+| D106 | PublicNestedClass | Missing docstring in public nested class |  |
+| D107 | PublicInit | Missing docstring in `__init__` |  |
+| D200 | FitsOnOneLine | One-line docstring should fit on one line |  |
+| D201 | NoBlankLineBeforeFunction | No blank lines allowed before function docstring (found 1) | 🛠 |
+| D202 | NoBlankLineAfterFunction | No blank lines allowed after function docstring (found 1) | 🛠 |
+| D203 | OneBlankLineBeforeClass | 1 blank line required before class docstring | 🛠 |
+| D204 | OneBlankLineAfterClass | 1 blank line required after class docstring | 🛠 |
+| D205 | BlankLineAfterSummary | 1 blank line required between summary line and description | 🛠 |
+| D206 | IndentWithSpaces | Docstring should be indented with spaces, not tabs |  |
+| D207 | NoUnderIndentation | Docstring is under-indented | 🛠 |
+| D208 | NoOverIndentation | Docstring is over-indented | 🛠 |
+| D209 | NewLineAfterLastParagraph | Multi-line docstring closing quotes should be on a separate line | 🛠 |
+| D210 | NoSurroundingWhitespace | No whitespaces allowed surrounding docstring text | 🛠 |
+| D211 | NoBlankLineBeforeClass | No blank lines allowed before class docstring | 🛠 |
+| D212 | MultiLineSummaryFirstLine | Multi-line docstring summary should start at the first line |  |
+| D213 | MultiLineSummarySecondLine | Multi-line docstring summary should start at the second line |  |
+| D214 | SectionNotOverIndented | Section is over-indented ("Returns") | 🛠 |
+| D215 | SectionUnderlineNotOverIndented | Section underline is over-indented ("Returns") | 🛠 |
+| D300 | UsesTripleQuotes | Use """triple double quotes""" |  |
+| D400 | EndsInPeriod | First line should end with a period |  |
+| D402 | NoSignature | First line should not be the function's signature |  |
+| D403 | FirstLineCapitalized | First word of the first line should be properly capitalized |  |
+| D404 | NoThisPrefix | First word of the docstring should not be `This` |  |
+| D405 | CapitalizeSectionName | Section name should be properly capitalized ("returns") | 🛠 |
+| D406 | NewLineAfterSectionName | Section name should end with a newline ("Returns") | 🛠 |
+| D407 | DashedUnderlineAfterSection | Missing dashed underline after section ("Returns") | 🛠 |
+| D408 | SectionUnderlineAfterName | Section underline should be in the line following the section's name ("Returns") | 🛠 |
+| D409 | SectionUnderlineMatchesSectionLength | Section underline should match the length of its name ("Returns") | 🛠 |
+| D410 | BlankLineAfterSection | Missing blank line after section ("Returns") | 🛠 |
+| D411 | BlankLineBeforeSection | Missing blank line before section ("Returns") | 🛠 |
+| D412 | NoBlankLinesBetweenHeaderAndContent | No blank lines allowed between a section header and its content ("Returns") | 🛠 |
+| D413 | BlankLineAfterLastSection | Missing blank line after last section ("Returns") | 🛠 |
+| D414 | NonEmptySection | Section has no content ("Returns") |  |
+| D415 | EndsInPunctuation | First line should end with a period, question mark, or exclamation point |  |
+| D416 | SectionNameEndsInColon | Section name should end with a colon ("Returns") | 🛠 |
+| D417 | DocumentAllArguments | Missing argument descriptions in the docstring: `x`, `y` |  |
+| D418 | SkipDocstring | Function decorated with @overload shouldn't contain a docstring |  |
+| D419 | NonEmpty | Docstring is empty |  |
+
+### pyupgrade
+
+| Code | Name | Message | Fix |
+| ---- | ---- | ------- | --- |
+| U001 | UselessMetaclassType | `__metaclass__ = type` is implied | 🛠 |
+| U002 | UnnecessaryAbspath | `abspath(__file__)` is unnecessary in Python 3.9 and later | 🛠 |
+| U003 | TypeOfPrimitive | Use `str` instead of `type(...)` | 🛠 |
+| U004 | UselessObjectInheritance | Class `...` inherits from object | 🛠 |
+| U005 | DeprecatedUnittestAlias | `assertEquals` is deprecated, use `assertEqual` instead | 🛠 |
+| U006 | UsePEP585Annotation | Use `list` instead of `List` for type annotations | 🛠 |
+| U007 | UsePEP604Annotation | Use `X \| Y` for type annotations | 🛠 |
+| U008 | SuperCallWithParameters | Use `super()` instead of `super(__class__, self)` | 🛠 |
+
+### pep8-naming
+
+| Code | Name | Message | Fix |
+| ---- | ---- | ------- | --- |
+| N801 | InvalidClassName | Class name `...` should use CapWords convention  |  |
+| N802 | InvalidFunctionName | Function name `...` should be lowercase |  |
+| N803 | InvalidArgumentName | Argument name `...` should be lowercase |  |
+| N804 | InvalidFirstArgumentNameForClassMethod | First argument of a class method should be named `cls` |  |
+| N805 | InvalidFirstArgumentNameForMethod | First argument of a method should be named `self` |  |
+| N806 | NonLowercaseVariableInFunction | Variable `...` in function should be lowercase |  |
+| N807 | DunderFunctionName | Function name should not start and end with `__` |  |
+| N811 | ConstantImportedAsNonConstant | Constant `...` imported as non-constant `...` |  |
+| N812 | LowercaseImportedAsNonLowercase | Lowercase `...` imported as non-lowercase `...` |  |
+| N813 | CamelcaseImportedAsLowercase | Camelcase `...` imported as lowercase `...` |  |
+| N814 | CamelcaseImportedAsConstant | Camelcase `...` imported as constant `...` |  |
+| N815 | MixedCaseVariableInClassScope | Variable `mixedCase` in class scope should not be mixedCase |  |
+| N816 | MixedCaseVariableInGlobalScope | Variable `mixedCase` in global scope should not be mixedCase |  |
+| N817 | CamelcaseImportedAsAcronym | Camelcase `...` imported as acronym `...` |  |
+| N818 | ErrorSuffixOnExceptionName | Exception name `...` should be named with an Error suffix |  |
+
+### flake8-comprehensions
+
+| Code | Name | Message | Fix |
+| ---- | ---- | ------- | --- |
+| C400 | UnnecessaryGeneratorList | Unnecessary generator (rewrite as a `list` comprehension) |  |
+| C401 | UnnecessaryGeneratorSet | Unnecessary generator (rewrite as a `set` comprehension) |  |
+| C402 | UnnecessaryGeneratorDict | Unnecessary generator (rewrite as a `dict` comprehension) |  |
+| C403 | UnnecessaryListComprehensionSet | Unnecessary `list` comprehension (rewrite as a `set` comprehension) |  |
+| C404 | UnnecessaryListComprehensionDict | Unnecessary `list` comprehension (rewrite as a `dict` comprehension) |  |
+| C405 | UnnecessaryLiteralSet | Unnecessary `(list\|tuple)` literal (rewrite as a `set` literal) |  |
+| C406 | UnnecessaryLiteralDict | Unnecessary `(list\|tuple)` literal (rewrite as a `dict` literal) |  |
+| C408 | UnnecessaryCollectionCall | Unnecessary `(dict\|list\|tuple)` call (rewrite as a literal) |  |
+| C409 | UnnecessaryLiteralWithinTupleCall | Unnecessary `(list\|tuple)` literal passed to `tuple()` (remove the outer call to `tuple()`) |  |
+| C410 | UnnecessaryLiteralWithinListCall | Unnecessary `(list\|tuple)` literal passed to `list()` (rewrite as a `list` literal) |  |
+| C411 | UnnecessaryListCall | Unnecessary `list` call (remove the outer call to `list()`) |  |
+| C413 | UnnecessaryCallAroundSorted | Unnecessary `(list\|reversed)` call around `sorted()` |  |
+| C414 | UnnecessaryDoubleCastOrProcess | Unnecessary `(list\|reversed\|set\|sorted\|tuple)` call within `(list\|set\|sorted\|tuple)()` |  |
+| C415 | UnnecessarySubscriptReversal | Unnecessary subscript reversal of iterable within `(reversed\|set\|sorted)()` |  |
+| C416 | UnnecessaryComprehension |  Unnecessary `(list\|set)` comprehension (rewrite using `(list\|set)()`) |  |
+| C417 | UnnecessaryMap | Unnecessary `map` usage (rewrite using a `(list\|set\|dict)` comprehension) |  |
+
+### flake8-bugbear
+
+| Code | Name | Message | Fix |
+| ---- | ---- | ------- | --- |
+| B002 | UnaryPrefixIncrement | Python does not support the unary prefix increment. |  |
+| B007 | UnusedLoopControlVariable | Loop control variable `i` not used within the loop body. | 🛠 |
+| B011 | DoNotAssertFalse | Do not `assert False` (`python -O` removes these calls), raise `AssertionError()` | 🛠 |
+| B013 | RedundantTupleInExceptionHandler | A length-one tuple literal is redundant. Write `except ValueError:` instead of `except (ValueError,):`. |  |
+| B014 | DuplicateHandlerException | Exception handler with duplicate exception: `ValueError` | 🛠 |
+| B017 | NoAssertRaisesException | `assertRaises(Exception):` should be considered evil. |  |
+| B025 | DuplicateTryBlockException | try-except block with duplicate exception `Exception` |  |
+
+### flake8-builtins
+
+| Code | Name | Message | Fix |
+| ---- | ---- | ------- | --- |
+| A001 | BuiltinVariableShadowing | Variable `...` is shadowing a python builtin |  |
+| A002 | BuiltinArgumentShadowing | Argument `...` is shadowing a python builtin |  |
+| A003 | BuiltinAttributeShadowing | Class attribute `...` is shadowing a python builtin |  |
+
+### flake8-print
+
+| Code | Name | Message | Fix |
+| ---- | ---- | ------- | --- |
+| T201 | PrintFound | `print` found | 🛠 |
+| T203 | PPrintFound | `pprint` found | 🛠 |
+
+### flake8-quotes
+
+| Code | Name | Message | Fix |
+| ---- | ---- | ------- | --- |
+| Q000 | BadQuotesInlineString | Single quotes found but double quotes preferred |  |
+| Q001 | BadQuotesMultilineString | Single quote multiline found but double quotes preferred |  |
+| Q002 | BadQuotesDocstring | Single quote docstring found but double quotes preferred |  |
+| Q003 | AvoidQuoteEscape | Change outer quotes to avoid escaping inner quotes |  |
+
+### Meta rules
+
+| Code | Name | Message | Fix |
+| ---- | ---- | ------- | --- |
+| M001 | UnusedNOQA | Unused `noqa` directive | 🛠 |
+
+## Editor Integrations
 
 ### PyCharm
 
-ruff can be installed as an [External Tool](https://www.jetbrains.com/help/pycharm/configuring-third-party-tools.html)
+Ruff can be installed as an [External Tool](https://www.jetbrains.com/help/pycharm/configuring-third-party-tools.html)
 in PyCharm. Open the Preferences pane, then navigate to "Tools", then "External Tools". From there,
 add a new tool with the following configuration:
 
-![Install ruff as an External Tool](https://user-images.githubusercontent.com/1309177/193155720-336e43f0-1a8d-46b4-bc12-e60f9ae01f7e.png)
+![Install Ruff as an External Tool](https://user-images.githubusercontent.com/1309177/193155720-336e43f0-1a8d-46b4-bc12-e60f9ae01f7e.png)
 
-ruff should then appear as a runnable action:
+Ruff should then appear as a runnable action:
 
-![ruff as a runnable action](https://user-images.githubusercontent.com/1309177/193156026-732b0aaf-3dd9-4549-9b4d-2de6d2168a33.png)
+![Ruff as a runnable action](https://user-images.githubusercontent.com/1309177/193156026-732b0aaf-3dd9-4549-9b4d-2de6d2168a33.png)
 
 ### GitHub Actions
 
-GitHub Actions has everything you need to run ruff out-of-the-box:
+GitHub Actions has everything you need to run Ruff out-of-the-box:
 
 ```yaml
 name: CI
@@ -388,13 +476,158 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install ruff
-      - name: Run ruff
+      - name: Run Ruff
         run: ruff .
 ```
 
+## FAQ
+
+### Is Ruff compatible with Black?
+
+Yes. Ruff is compatible with [Black](https://github.com/psf/black) out-of-the-box, as long as
+the `line-length` setting is consistent between the two.
+
+As a project, Ruff is designed to be used alongside Black and, as such, will defer implementing
+stylistic lint rules that are obviated by autoformatting.
+
+### How does Ruff compare to Flake8?
+
+Ruff can be used as a (near) drop-in replacement for Flake8 when used (1) without or with a small
+number of plugins, (2) alongside Black, and (3) on Python 3 code.
+
+Under those conditions Ruff is missing 14 rules related to string `.format` calls, 1 rule related
+to docstring parsing, and 1 rule related to redefined variables.
+
+Ruff re-implements some of the most popular Flake8 plugins and related code quality tools natively,
+including:
+
+- [`pydocstyle`](https://pypi.org/project/pydocstyle/)
+- [`pep8-naming`](https://pypi.org/project/pep8-naming/)
+- [`yesqa`](https://github.com/asottile/yesqa)
+- [`flake8-docstrings`](https://pypi.org/project/flake8-docstrings/)
+- [`flake8-builtins`](https://pypi.org/project/flake8-builtins/)
+- [`flake8-super`](https://pypi.org/project/flake8-super/)
+- [`flake8-print`](https://pypi.org/project/flake8-print/)
+- [`flake8-quotes`](https://pypi.org/project/flake8-quotes/)
+- [`flake8-comprehensions`](https://pypi.org/project/flake8-comprehensions/)
+- [`flake8-bugbear`](https://pypi.org/project/flake8-bugbear/) (10/32)
+- [`pyupgrade`](https://pypi.org/project/pyupgrade/) (8/34)
+- [`autoflake`](https://pypi.org/project/autoflake/) (1/7)
+
+Beyond rule-set parity, Ruff suffers from the following limitations vis-à-vis Flake8:
+
+1. Ruff does not yet support a few Python 3.9 and 3.10 language features, including structural
+   pattern matching and parenthesized context managers.
+2. Flake8 has a plugin architecture and supports writing custom lint rules. (To date, popular Flake8
+   plugins have been re-implemented within Ruff directly.)
+
+### Which tools does Ruff replace?
+
+Today, Ruff can be used to replace Flake8 when used with any of the following plugins:
+
+- [`pep8-naming`](https://pypi.org/project/pep8-naming/)
+- [`flake8-docstrings`](https://pypi.org/project/flake8-docstrings/)
+- [`flake8-builtins`](https://pypi.org/project/flake8-builtins/)
+- [`flake8-super`](https://pypi.org/project/flake8-super/)
+- [`flake8-print`](https://pypi.org/project/flake8-print/)
+- [`flake8-quotes`](https://pypi.org/project/flake8-quotes/)
+- [`flake8-comprehensions`](https://pypi.org/project/flake8-comprehensions/)
+- [`flake8-bugbear`](https://pypi.org/project/flake8-bugbear/) (9/32)
+
+Ruff also implements the functionality that you get from [`yesqa`](https://github.com/asottile/yesqa),
+and a subset of the rules implemented in [`pyupgrade`](https://pypi.org/project/pyupgrade/) (8/34).
+
+If you're looking to use Ruff, but rely on an unsupported Flake8 plugin, free to file an Issue.
+
+### Do I need to install Rust to use Ruff?
+
+Nope! Ruff is available as [`ruff`](https://pypi.org/project/ruff/) on PyPI:
+
+```shell
+pip install ruff
+```
+
+Ruff ships with wheels for all major platforms, which enables `pip` to install Ruff without relying
+on Rust at all.
+
+### Can I write my own plugins for Ruff?
+
+Ruff does not yet support third-party plugins, though a plugin system is within-scope for the
+project. See [#283](https://github.com/charliermarsh/ruff/issues/283) for more.
+
+### Does Ruff support NumPy- or Google-style docstrings?
+
+Yes! To enable a specific docstring convention, start by enabling all `pydocstyle` error codes, and
+then selectively disabling based on your [preferred convention](https://www.pydocstyle.org/en/latest/error_codes.html#default-conventions).
+
+For example, if you're coming from `flake8-docstrings`, the following configuration is equivalent to
+`--docstring-convention=numpy`:
+
+```toml
+[tool.ruff]
+extend-select = ["D"]
+extend-ignore = [
+    "D107",
+    "D203",
+    "D212",
+    "D213",
+    "D402",
+    "D413",
+    "D415",
+    "D416",
+    "D417",
+]
+```
+
+Similarly, the following is equivalent to `--docstring-convention=google`:
+
+```toml
+[tool.ruff]
+extend-select = ["D"]
+extend-ignore = [
+    "D203",
+    "D204",
+    "D213",
+    "D215",
+    "D400",
+    "D404",
+    "D406",
+    "D407",
+    "D408",
+    "D409",
+    "D413",
+]
+```
+
+Similarly, the following is equivalent to `--docstring-convention=pep8`:
+
+```toml
+[tool.ruff]
+extend-select = ["D"]
+extend-ignore = [
+    "D203",
+    "D212",
+    "D213",
+    "D214",
+    "D215",
+    "D404",
+    "D405",
+    "D406",
+    "D407",
+    "D408",
+    "D409",
+    "D410",
+    "D411",
+    "D413",
+    "D415",
+    "D416",
+    "D417",
+]
+```
+
 ## Development
 
-ruff is written in Rust (1.63.0). You'll need to install the [Rust toolchain](https://www.rust-lang.org/tools/install)
+Ruff is written in Rust (1.63.0). You'll need to install the [Rust toolchain](https://www.rust-lang.org/tools/install)
 for development.
 
 Assuming you have `cargo` installed, you can run:
@@ -406,13 +639,13 @@ cargo clippy
 cargo test
 ```
 
-## Deployment
+## Releases
 
-ruff is distributed on [PyPI](https://pypi.org/project/ruff/), and published via [`maturin`](https://github.com/PyO3/maturin).
+Ruff is distributed on [PyPI](https://pypi.org/project/ruff/), and published via [`maturin`](https://github.com/PyO3/maturin).
 
 See: `.github/workflows/release.yaml`.
 
-## Benchmarking
+## Benchmarks
 
 First, clone [CPython](https://github.com/python/cpython). It's a large and diverse Python codebase,
 which makes it a good target for benchmarking.
@@ -489,9 +722,9 @@ hyperfine --ignore-failure --warmup 5 \
 
 In order, these evaluate:
 
-- ruff
+- Ruff
 - Pylint
-- PyFlakes
+- Pyflakes
 - autoflake
 - pycodestyle
 - Flake8

examples/generate_check_code_prefix.rs

@@ -0,0 +1,105 @@
+//! Generate the CheckCodePrefix enum.
+
+use std::collections::{BTreeMap, BTreeSet};
+
+use codegen::{Scope, Type, Variant};
+use itertools::Itertools;
+use strum::IntoEnumIterator;
+
+use ruff::checks::CheckCode;
+
+fn main() {
+    // Build up a map from prefix to matching CheckCodes.
+    let mut prefix_to_codes: BTreeMap<String, BTreeSet<CheckCode>> = Default::default();
+    for check_code in CheckCode::iter() {
+        let as_ref = check_code.as_ref().to_string();
+        for i in 1..=as_ref.len() {
+            let prefix = as_ref[..i].to_string();
+            let entry = prefix_to_codes
+                .entry(prefix)
+                .or_insert_with(|| Default::default());
+            entry.insert(check_code.clone());
+        }
+    }
+
+    let mut scope = Scope::new();
+
+    // Create the `CheckCodePrefix` definition.
+    let mut gen = scope
+        .new_enum("CheckCodePrefix")
+        .vis("pub")
+        .derive("EnumString")
+        .derive("Debug")
+        .derive("PartialEq")
+        .derive("Eq")
+        .derive("Clone")
+        .derive("Serialize")
+        .derive("Deserialize");
+    for (prefix, _) in &prefix_to_codes {
+        gen = gen.push_variant(Variant::new(prefix.to_string()));
+    }
+
+    // Create the `PrefixSpecificity` definition.
+    scope
+        .new_enum("PrefixSpecificity")
+        .vis("pub")
+        .derive("PartialEq")
+        .derive("Eq")
+        .derive("PartialOrd")
+        .derive("Ord")
+        .push_variant(Variant::new("Category"))
+        .push_variant(Variant::new("Hundreds"))
+        .push_variant(Variant::new("Tens"))
+        .push_variant(Variant::new("Explicit"));
+
+    // Create the `match` statement, to map from definition to relevant codes.
+    let mut gen = scope
+        .new_impl("CheckCodePrefix")
+        .new_fn("codes")
+        .arg_ref_self()
+        .ret(Type::new("Vec<CheckCode>"))
+        .vis("pub")
+        .line("match self {");
+    for (prefix, codes) in &prefix_to_codes {
+        gen = gen.line(format!(
+            "CheckCodePrefix::{prefix} => vec![{}],",
+            codes
+                .iter()
+                .map(|code| format!("CheckCode::{}", code.as_ref()))
+                .join(", ")
+        ));
+    }
+    gen.line("}");
+
+    // Create the `match` statement, to map from definition to specificity.
+    let mut gen = scope
+        .new_impl("CheckCodePrefix")
+        .new_fn("specificity")
+        .arg_ref_self()
+        .ret(Type::new("PrefixSpecificity"))
+        .vis("pub")
+        .line("match self {");
+    for (prefix, _) in &prefix_to_codes {
+        let specificity = match prefix.len() {
+            4 => "Explicit",
+            3 => "Tens",
+            2 => "Hundreds",
+            1 => "Category",
+            _ => panic!("Invalid prefix: {}", prefix),
+        };
+        gen = gen.line(format!(
+            "CheckCodePrefix::{prefix} => PrefixSpecificity::{},",
+            specificity
+        ));
+    }
+    gen.line("}");
+
+    println!("//! File automatically generated by examples/generate_check_code_prefix.rs.");
+    println!();
+    println!("use serde::{{Deserialize, Serialize}};");
+    println!("use strum_macros::EnumString;");
+    println!();
+    println!("use crate::checks::CheckCode;");
+    println!();
+    println!("{}", scope.to_string());
+}

examples/generate_rules_table.rs

@@ -1,26 +1,29 @@
-/// Generate a Markdown-compatible table of supported lint rules.
+//! Generate a Markdown-compatible table of supported lint rules.
+
 use strum::IntoEnumIterator;
 
-use ruff::checks::{CheckCode, DEFAULT_CHECK_CODES};
+use ruff::checks::{CheckCategory, CheckCode};
 
 fn main() {
-    println!("| Code | Name | Message |     |     |");
-    println!("| ---- | ---- | ------- | --- | --- |");
-    for check_code in CheckCode::iter() {
-        let check_kind = check_code.kind();
-        let default_token = if DEFAULT_CHECK_CODES.contains(&check_code) {
-            "✅"
-        } else {
-            ""
-        };
-        let fix_token = if check_kind.fixable() { "🛠" } else { "" };
-        println!(
-            "| {} | {} | {} | {} | {} |",
-            check_kind.code().as_ref(),
-            check_kind.as_ref(),
-            check_kind.body().replace("|", r"\|"),
-            default_token,
-            fix_token
-        );
+    for check_category in CheckCategory::iter() {
+        println!("### {}", check_category.title());
+        println!();
+
+        println!("| Code | Name | Message | Fix |");
+        println!("| ---- | ---- | ------- | --- |");
+        for check_code in CheckCode::iter() {
+            if check_code.category() == check_category {
+                let check_kind = check_code.kind();
+                let fix_token = if check_kind.fixable() { "🛠" } else { "" };
+                println!(
+                    "| {} | {} | {} | {} |",
+                    check_kind.code().as_ref(),
+                    check_kind.as_ref(),
+                    check_kind.summary().replace("|", r"\|"),
+                    fix_token
+                );
+            }
+        }
+        println!();
     }
 }

examples/print_ast.rs

@@ -1,4 +1,5 @@
-/// Print the AST for a given Python file.
+//! Print the AST for a given Python file.
+
 use std::path::PathBuf;
 
 use anyhow::Result;

examples/print_tokens.rs

@@ -1,4 +1,5 @@
-/// Print the token stream for a given Python file.
+//! Print the token stream for a given Python file.
+
 use std::path::PathBuf;
 
 use anyhow::Result;

resources/test/fixtures/B002.py

@@ -0,0 +1,20 @@
+"""
+Should emit:
+B002 - on lines 15 and 20
+"""
+
+
+def this_is_all_fine(n):
+    x = n + 1
+    y = 1 + n
+    z = +x + y
+    return +z
+
+
+def this_is_buggy(n):
+    x = ++n
+    return x
+
+
+def this_is_buggy_too(n):
+    return ++n

resources/test/fixtures/B007.py

@@ -0,0 +1,31 @@
+for i in range(10):
+    print(i)
+
+print(i)  # name no longer defined on Python 3; no warning yet
+
+for i in range(10):  # name not used within the loop; B007
+    print(10)
+
+print(i)  # name no longer defined on Python 3; no warning yet
+
+
+for _ in range(10):  # _ is okay for a throw-away variable
+    print(10)
+
+
+for i in range(10):
+    for j in range(10):
+        for k in range(10):  # k not used, i and j used transitively
+            print(i + j)
+
+
+def strange_generator():
+    for i in range(10):
+        for j in range(10):
+            for k in range(10):
+                for l in range(10):
+                    yield i, (j, (k, l))
+
+
+for i, (j, (k, l)) in strange_generator():  # i, k not used
+    print(j, l)

resources/test/fixtures/B013.py

@@ -0,0 +1,8 @@
+try:
+    pass
+except (ValueError,):
+    pass
+except AttributeError:
+    pass
+except (ImportError, TypeError):
+    pass

resources/test/fixtures/B017.py

@@ -0,0 +1,36 @@
+"""
+Should emit:
+B017 - on lines 20
+"""
+import asyncio
+import unittest
+
+CONSTANT = True
+
+
+def something_else() -> None:
+    for i in (1, 2, 3):
+        print(i)
+
+
+class Foo:
+    pass
+
+
+class Foobar(unittest.TestCase):
+    def evil_raises(self) -> None:
+        with self.assertRaises(Exception):
+            raise Exception("Evil I say!")
+
+    def context_manager_raises(self) -> None:
+        with self.assertRaises(Exception) as ex:
+            raise Exception("Context manager is good")
+        self.assertEqual("Context manager is good", str(ex.exception))
+
+    def regex_raises(self) -> None:
+        with self.assertRaisesRegex(Exception, "Regex is good"):
+            raise Exception("Regex is good")
+
+    def raises_with_absolute_reference(self):
+        with self.assertRaises(asyncio.CancelledError):
+            Foo()

resources/test/fixtures/C417.py

@@ -0,0 +1,6 @@
+nums = [1, 2, 3]
+map(lambda x: x + 1, nums)
+map(lambda x: str(x), nums)
+list(map(lambda x: x * 2, nums))
+set(map(lambda x: x % 2 == 0, nums))
+dict(map(lambda v: (v, v**2), nums))

resources/test/fixtures/F401_0.py

@@ -61,7 +61,7 @@ Y = TypeVar("Y", bound="Dict")
 Z = TypeVar("Z", "List", "Set")
 
 a = list["Fruit"]
-b = Union["Nut", None]
+b = Union["""Nut""", None]
 c = cast("Vegetable", b)
 
 Field = lambda default=MISSING: field(default=default)

resources/test/fixtures/F401_5.py

@@ -0,0 +1,5 @@
+"""Test: removal of multi-segment and aliases imports."""
+from a.b import c
+from d.e import f as g
+import h.i
+import j.k as l

resources/test/fixtures/N801.py

@@ -0,0 +1,34 @@
+class bad:
+    pass
+
+
+class _bad:
+    pass
+
+
+class bad_class:
+    pass
+
+
+class Bad_Class:
+    pass
+
+
+class BAD_CLASS:
+    pass
+
+
+class Good:
+    pass
+
+
+class _Good:
+    pass
+
+
+class GoodClass:
+    pass
+
+
+class GOOD:
+    pass

resources/test/fixtures/N802.py

@@ -0,0 +1,41 @@
+import unittest
+
+
+def Bad():
+    pass
+
+
+def _Bad():
+    pass
+
+
+def BAD():
+    pass
+
+
+def BAD_FUNC():
+    pass
+
+
+def good():
+    pass
+
+
+def _good():
+    pass
+
+
+def good_func():
+    pass
+
+
+def tearDownModule():
+    pass
+
+
+class Test(unittest.TestCase):
+    def tearDown(self):
+        return super().tearDown()
+
+    def testTest(self):
+        assert True

resources/test/fixtures/N803.py

@@ -0,0 +1,7 @@
+def func(a, A):
+    return a, A
+
+
+class Class:
+    def method(self, a, A):
+        return a, A

resources/test/fixtures/N804.py

@@ -0,0 +1,19 @@
+class Class:
+    @classmethod
+    def bad_class_method(this):
+        pass
+
+    @classmethod
+    def good_class_method(cls):
+        pass
+
+    def method(self):
+        pass
+
+    @staticmethod
+    def static_method(x):
+        return x
+
+
+def func(x):
+    return x

resources/test/fixtures/N805.py

@@ -0,0 +1,26 @@
+import random
+
+
+class Class:
+    def bad_method(this):
+        pass
+
+    if random.random(0, 2) == 0:
+
+        def extra_bad_method(this):
+            pass
+
+    def good_method(self):
+        pass
+
+    @classmethod
+    def class_method(cls):
+        pass
+
+    @staticmethod
+    def static_method(x):
+        return x
+
+
+def func(x):
+    return x

resources/test/fixtures/N806.py

@@ -0,0 +1,4 @@
+def f():
+    lower = 0
+    Camel = 0
+    CONSTANT = 0

resources/test/fixtures/N807.py

@@ -0,0 +1,15 @@
+def __bad__():
+    pass
+
+
+def __good():
+    pass
+
+
+def good__():
+    pass
+
+
+class Class:
+    def __good__(self):
+        pass

resources/test/fixtures/N811.py

@@ -0,0 +1,3 @@
+import mod.CONST as const
+from mod import CONSTANT as constant
+from mod import ANOTHER_CONSTANT as another_constant

resources/test/fixtures/N812.py

@@ -0,0 +1,3 @@
+import modl.lowercase as Lower
+from mod import lowercase as Lowercase
+from mod import another_lowercase as AnotherLowercase

resources/test/fixtures/N813.py

@@ -0,0 +1,3 @@
+import mod.Camel as camel
+from mod import CamelCase as camelcase
+from mod import AnotherCamelCase as another_camelcase

resources/test/fixtures/N814.py

@@ -0,0 +1,3 @@
+import mod.Camel as CAMEL
+from mod import CamelCase as CAMELCASE
+from mod import AnotherCamelCase as ANOTHER_CAMELCASE

resources/test/fixtures/N815.py

@@ -0,0 +1,6 @@
+class C:
+    lower = 0
+    CONSTANT = 0
+    mixedCase = 0
+    _mixedCase = 0
+    mixed_Case = 0

resources/test/fixtures/N816.py

@@ -0,0 +1,5 @@
+lower = 0
+CONSTANT = 0
+mixedCase = 0
+_mixedCase = 0
+mixed_Case = 0

resources/test/fixtures/N817.py

@@ -0,0 +1,2 @@
+import mod.CaMel as CM
+from mod import CamelCase as CC

resources/test/fixtures/N818.py

@@ -0,0 +1,10 @@
+class Error(Exception):
+    pass
+
+
+class AnotherError(Exception):
+    pass
+
+
+class C(Exception):
+    pass

resources/test/fixtures/W605.py

@@ -0,0 +1,35 @@
+#: W605:1:10
+regex = '\.png$'
+
+#: W605:2:1
+regex = '''
+\.png$
+'''
+
+#: W605:2:6
+f(
+    '\_'
+)
+
+#: W605:4:6
+"""
+multi-line
+literal
+with \_ somewhere
+in the middle
+"""
+
+#: Okay
+regex = r'\.png$'
+regex = '\\.png$'
+regex = r'''
+\.png$
+'''
+regex = r'''
+\\.png$
+'''
+s = '\\'
+regex = '\w'  # noqa
+regex = '''
+\w
+'''  # noqa

resources/test/fixtures/__init__.py

@@ -1,3 +1,5 @@
+import os
+
 print(__path__)
 
 __all__ = ["a", "b", "c"]

resources/test/fixtures/canonical_google_examples.py

@@ -0,0 +1,108 @@
+"""A one line summary of the module or program, terminated by a period.
+
+Leave one blank line.  The rest of this docstring should contain an
+overall description of the module or program.  Optionally, it may also
+contain a brief description of exported classes and functions and/or usage
+examples.
+
+  Typical usage example:
+
+  foo = ClassFoo()
+  bar = foo.FunctionBar()
+"""
+# above: "2.8.2 Modules" section example
+# https://google.github.io/styleguide/pyguide.html#382-modules
+
+# Examples from the official "Google Python Style Guide" documentation:
+#     * As HTML: https://google.github.io/styleguide/pyguide.html
+#     * Source Markdown:
+#         https://github.com/google/styleguide/blob/gh-pages/pyguide.md
+
+import os
+from .expected import Expectation
+
+expectation = Expectation()
+expect = expectation.expect
+
+# module docstring expected violations:
+expectation.expected.add((
+    os.path.normcase(__file__),
+    "D213: Multi-line docstring summary should start at the second line"))
+
+
+# "3.8.3 Functions and Methods" section example
+# https://google.github.io/styleguide/pyguide.html#383-functions-and-methods
+@expect("D213: Multi-line docstring summary should start at the second line",
+        arg_count=3)
+@expect("D401: First line should be in imperative mood "
+        "(perhaps 'Fetch', not 'Fetches')", arg_count=3)
+@expect("D406: Section name should end with a newline "
+        "('Raises', not 'Raises:')", arg_count=3)
+@expect("D406: Section name should end with a newline "
+        "('Returns', not 'Returns:')", arg_count=3)
+@expect("D407: Missing dashed underline after section ('Raises')", arg_count=3)
+@expect("D407: Missing dashed underline after section ('Returns')",
+        arg_count=3)
+@expect("D413: Missing blank line after last section ('Raises')", arg_count=3)
+def fetch_bigtable_rows(big_table, keys, other_silly_variable=None):
+    """Fetches rows from a Bigtable.
+
+    Retrieves rows pertaining to the given keys from the Table instance
+    represented by big_table.  Silly things may happen if
+    other_silly_variable is not None.
+
+    Args:
+        big_table: An open Bigtable Table instance.
+        keys: A sequence of strings representing the key of each table row
+            to fetch.
+        other_silly_variable: Another optional variable, that has a much
+            longer name than the other args, and which does nothing.
+
+    Returns:
+        A dict mapping keys to the corresponding table row data
+        fetched. Each row is represented as a tuple of strings. For
+        example:
+
+        {'Serak': ('Rigel VII', 'Preparer'),
+         'Zim': ('Irk', 'Invader'),
+         'Lrrr': ('Omicron Persei 8', 'Emperor')}
+
+        If a key from the keys argument is missing from the dictionary,
+        then that row was not found in the table.
+
+    Raises:
+        IOError: An error occurred accessing the bigtable.Table object.
+    """
+
+
+# "3.8.4 Classes" section example
+# https://google.github.io/styleguide/pyguide.html#384-classes
+@expect("D203: 1 blank line required before class docstring (found 0)")
+@expect("D213: Multi-line docstring summary should start at the second line")
+@expect("D406: Section name should end with a newline "
+        "('Attributes', not 'Attributes:')")
+@expect("D407: Missing dashed underline after section ('Attributes')")
+@expect("D413: Missing blank line after last section ('Attributes')")
+class SampleClass:
+    """Summary of class here.
+
+    Longer class information....
+    Longer class information....
+
+    Attributes:
+        likes_spam: A boolean indicating if we like SPAM or not.
+        eggs: An integer count of the eggs we have laid.
+    """
+
+    @expect("D401: First line should be in imperative mood "
+            "(perhaps 'Init', not 'Inits')", arg_count=2)
+    def __init__(self, likes_spam=False):
+        """Inits SampleClass with blah."""
+        if self:  # added to avoid NameError when run via @expect decorator
+            self.likes_spam = likes_spam
+            self.eggs = 0
+
+    @expect("D401: First line should be in imperative mood "
+            "(perhaps 'Perform', not 'Performs')", arg_count=1)
+    def public_method(self):
+        """Performs operation blah."""

resources/test/fixtures/flake8_quotes/docstring_doubles.py

@@ -0,0 +1,38 @@
+"""
+Double quotes multiline module docstring
+"""
+
+"""
+this is not a docstring
+"""
+
+l = []
+
+class Cls:
+    """
+    Double quotes multiline class docstring
+    """
+
+    """
+    this is not a docstring
+    """
+
+    # The colon in the list indexing below is an edge case for the docstring scanner
+    def f(self, bar="""
+        definitely not a docstring""",
+        val=l[Cls():3]):
+        """
+        Double quotes multiline function docstring
+        """
+
+        some_expression = 'hello world'
+
+        """
+        this is not a docstring
+        """
+
+        if l:
+            """
+            Looks like a docstring, but in reality it isn't - only modules, classes and functions
+            """
+            pass

resources/test/fixtures/flake8_quotes/docstring_doubles_class.py

@@ -0,0 +1,9 @@
+class SingleLineDocstrings():
+    """ Double quotes single line class docstring """
+    """ Not a docstring """
+
+    def foo(self, bar="""not a docstring"""):
+        """ Double quotes single line method docstring"""
+        pass
+
+    class Nested(foo()[:]): """ inline docstring """; pass

resources/test/fixtures/flake8_quotes/docstring_doubles_function.py

@@ -0,0 +1,22 @@
+def foo():
+    """function without params, single line docstring"""
+    """ not a docstring"""
+    return
+
+
+def foo2():
+    """
+        function without params, multiline docstring
+    """
+    """ not a docstring"""
+    return
+
+
+def fun_with_params_no_docstring(a, b="""
+    not a
+""" """docstring"""):
+    pass
+
+def fun_with_params_no_docstring2(a, b=c[foo():], c=\
+    """ not a docstring """):
+    pass

resources/test/fixtures/flake8_quotes/docstring_doubles_module_multiline.py

@@ -0,0 +1,11 @@
+"""
+Double quotes multiline module docstring
+"""
+"""
+this is not a docstring
+"""
+def foo():
+    pass
+"""
+this is not a docstring
+"""

resources/test/fixtures/flake8_quotes/docstring_doubles_module_singleline.py

@@ -0,0 +1,6 @@
+""" Double quotes singleline module docstring """
+""" this is not a docstring """
+
+def foo():
+    pass
+""" this is not a docstring """

resources/test/fixtures/flake8_quotes/docstring_singles.py

@@ -0,0 +1,40 @@
+'''
+Single quotes multiline module docstring
+'''
+
+'''
+this is not a docstring
+'''
+
+l = []
+
+class Cls(MakeKlass('''
+    class params \t not a docstring
+''')):
+    '''
+    Single quotes multiline class docstring
+    '''
+
+    '''
+    this is not a docstring
+    '''
+
+    # The colon in the list indexing below is an edge case for the docstring scanner
+    def f(self, bar='''
+        definitely not a docstring''',
+        val=l[Cls():3]):
+        '''
+        Single quotes multiline function docstring
+        '''
+
+        some_expression = 'hello world'
+
+        '''
+        this is not a docstring
+        '''
+
+        if l:
+            '''
+            Looks like a docstring, but in reality it isn't - only modules, classes and functions
+            '''
+            pass

resources/test/fixtures/flake8_quotes/docstring_singles_class.py

@@ -0,0 +1,9 @@
+class SingleLineDocstrings():
+    ''' Double quotes single line class docstring '''
+    ''' Not a docstring '''
+
+    def foo(self, bar='''not a docstring'''):
+        ''' Double quotes single line method docstring'''
+        pass
+
+    class Nested(foo()[:]): ''' inline docstring '''; pass

resources/test/fixtures/flake8_quotes/docstring_singles_function.py

@@ -0,0 +1,23 @@
+def foo():
+    '''function without params, single line docstring'''
+    ''' not a docstring'''
+    return
+
+
+def foo2():
+    '''
+        function without params, multiline docstring
+    '''
+    ''' not a docstring'''
+    return
+
+
+def fun_with_params_no_docstring(a, b='''
+    not a 
+''' '''docstring'''):
+    pass
+
+def fun_with_params_no_docstring2(a, b=c[foo():], c=\
+    ''' not a docstring '''):
+    pass
+

resources/test/fixtures/flake8_quotes/docstring_singles_module_multiline.py

@@ -0,0 +1,11 @@
+'''
+Double quotes multiline module docstring
+'''
+'''
+this is not a docstring
+'''
+def foo():
+    pass
+'''
+this is not a docstring
+'''

resources/test/fixtures/flake8_quotes/docstring_singles_module_singleline.py

@@ -0,0 +1,6 @@
+''' Double quotes singleline module docstring '''
+''' this is not a docstring '''
+
+def foo():
+    pass
+''' this is not a docstring '''

resources/test/fixtures/flake8_quotes/doubles.py

@@ -0,0 +1,2 @@
+this_should_be_linted = "double quote string"
+this_should_be_linted = u"double quote string"

resources/test/fixtures/flake8_quotes/doubles_escaped.py

@@ -0,0 +1,5 @@
+this_should_raise_Q003 = 'This is a \'string\''
+this_is_fine = '"This" is a \'string\''
+this_is_fine = "This is a 'string'"
+this_is_fine = "\"This\" is a 'string'"
+this_is_fine = r'This is a \'string\''

resources/test/fixtures/flake8_quotes/doubles_multiline_string.py

@@ -0,0 +1,9 @@
+s = """ This "should"
+be
+"linted" """
+
+s = ''' This "should"
+"not" be
+"linted" '''
+
+s = """'This should not be linted due to having would-be quadruple end quote'"""

resources/test/fixtures/flake8_quotes/doubles_noqa.py

@@ -0,0 +1 @@
+this_should_not_be_linted = "double quote string"  # noqa

resources/test/fixtures/flake8_quotes/doubles_wrapped.py

@@ -0,0 +1,2 @@
+s = 'double "quotes" wrapped in singles are ignored'
+s = "single 'quotes' wrapped in doubles are ignored"

resources/test/fixtures/flake8_quotes/singles.py

@@ -0,0 +1,2 @@
+this_should_be_linted = 'single quote string'
+this_should_be_linted = u'double quote string'

resources/test/fixtures/flake8_quotes/singles_escaped.py

@@ -0,0 +1,5 @@
+this_should_raise_Q003 = "This is a \"string\""
+this_is_fine = "'This' is a \"string\""
+this_is_fine = 'This is a "string"'
+this_is_fine = '\'This\' is a "string"'
+this_is_fine = r"This is a \"string\""

resources/test/fixtures/flake8_quotes/singles_multiline_string.py

@@ -0,0 +1,9 @@
+s = ''' This 'should'
+be
+'linted' '''
+
+s = """ This 'should'
+'not' be
+'linted' """
+
+s = '''"This should not be linted due to having would-be quadruple end quote"'''

resources/test/fixtures/flake8_quotes/singles_noqa.py

@@ -0,0 +1 @@
+this_should_not_be_linted = 'single quote string'  # noqa

resources/test/fixtures/flake8_quotes/singles_wrapped.py

@@ -0,0 +1,2 @@
+s = "single 'quotes' wrapped in doubles are ignored"
+s = 'double "quotes" wrapped in singles are ignored'

resources/test/fixtures/pyproject.toml

@@ -5,3 +5,12 @@ extend-exclude = [
     "migrations",
     "directory/also_excluded.py",
 ]
+per-file-ignores = [
+    "__init__.py:F401",
+]
+
+[tool.ruff.flake8-quotes]
+inline-quotes = "single"
+multiline-quotes = "double"
+docstring-quotes = "double"
+avoid-escape = true

scripts/.flake8

@@ -0,0 +1,19 @@
+[flake8]
+exclude =
+    # Defaults
+    .svn,
+    CVS,
+    .bzr,
+    .hg,
+    .git,
+    __pycache__,
+    .tox,
+    .idea,
+    .mypy_cache,
+    .venv,
+    node_modules,
+    # Custom
+    _state_machine.py,
+    test_fstring.py,
+    bad_coding2.py,
+    badsyntax_*.py

src/ast/helpers.rs

@@ -1,6 +1,6 @@
 use once_cell::sync::Lazy;
 use regex::Regex;
-use rustpython_ast::{Excepthandler, ExcepthandlerKind, Expr, ExprKind, StmtKind};
+use rustpython_ast::{Excepthandler, ExcepthandlerKind, Expr, ExprKind, Location, StmtKind};
 
 use crate::python::typing;
 
@@ -123,7 +123,7 @@ pub fn extract_handler_names(handlers: &[Excepthandler]) -> Vec<String> {
 }
 
 /// Returns `true` if a call is an argumented `super` invocation.
-pub fn is_super_call_with_arguments(func: &Expr, args: &Vec<Expr>) -> bool {
+pub fn is_super_call_with_arguments(func: &Expr, args: &[Expr]) -> bool {
     // Check: is this a `super` call?
     if let ExprKind::Name { id, .. } = &func.node {
         id == "super" && !args.is_empty()
@@ -131,3 +131,15 @@ pub fn is_super_call_with_arguments(func: &Expr, args: &Vec<Expr>) -> bool {
         false
     }
 }
+
+/// Convert a location within a file (relative to `base`) to an absolute position.
+pub fn to_absolute(relative: &Location, base: &Location) -> Location {
+    if relative.row() == 1 {
+        Location::new(
+            relative.row() + base.row() - 1,
+            relative.column() + base.column() - 1,
+        )
+    } else {
+        Location::new(relative.row() + base.row() - 1, relative.column())
+    }
+}

src/ast/mod.rs

@@ -1,4 +1,3 @@
-pub mod checkers;
 pub mod helpers;
 pub mod operations;
 pub mod relocate;

src/ast/operations.rs

@@ -121,57 +121,55 @@ pub fn is_unpacking_assignment(stmt: &Stmt) -> bool {
 /// Struct used to efficiently slice source code at (row, column) Locations.
 pub struct SourceCodeLocator<'a> {
     content: &'a str,
-    offsets: Vec<usize>,
-    initialized: bool,
+    offsets: Vec<Vec<usize>>,
 }
 
 impl<'a> SourceCodeLocator<'a> {
     pub fn new(content: &'a str) -> Self {
         SourceCodeLocator {
             content,
-            offsets: vec![],
-            initialized: false,
+            offsets: Self::compute_offsets(content),
         }
     }
 
-    fn init(&mut self) {
-        if !self.initialized {
-            let mut offset = 0;
-            for i in self.content.lines() {
-                self.offsets.push(offset);
-                offset += i.len();
-                offset += 1;
+    fn compute_offsets(content: &str) -> Vec<Vec<usize>> {
+        let mut offsets = vec![];
+        let mut offset = 0;
+        for line in content.lines() {
+            let mut newline = 0;
+            let mut line_offsets: Vec<usize> = vec![];
+            for (i, char) in line.char_indices() {
+                line_offsets.push(offset + i);
+                newline = i + char.len_utf8();
             }
-            self.offsets.push(offset);
-            self.initialized = true;
+            line_offsets.push(offset + newline);
+            offsets.push(line_offsets);
+            offset += newline + 1;
         }
+        offsets.push(vec![offset]);
+        offsets
     }
 
-    pub fn slice_source_code_at(&mut self, location: &Location) -> &'a str {
-        self.init();
-        let offset = self.offsets[location.row() - 1] + location.column() - 1;
+    pub fn slice_source_code_at(&self, location: &Location) -> &'a str {
+        let offset = self.offsets[location.row() - 1][location.column() - 1];
         &self.content[offset..]
     }
 
-    pub fn slice_source_code_range(&mut self, range: &Range) -> &'a str {
-        self.init();
-        let start = self.offsets[range.location.row() - 1] + range.location.column() - 1;
-        let end = self.offsets[range.end_location.row() - 1] + range.end_location.column() - 1;
+    pub fn slice_source_code_range(&self, range: &Range) -> &'a str {
+        let start = self.offsets[range.location.row() - 1][range.location.column() - 1];
+        let end = self.offsets[range.end_location.row() - 1][range.end_location.column() - 1];
         &self.content[start..end]
     }
 
     pub fn partition_source_code_at(
-        &mut self,
+        &self,
         outer: &Range,
         inner: &Range,
     ) -> (&'a str, &'a str, &'a str) {
-        self.init();
-        let outer_start = self.offsets[outer.location.row() - 1] + outer.location.column() - 1;
-        let outer_end =
-            self.offsets[outer.end_location.row() - 1] + outer.end_location.column() - 1;
-        let inner_start = self.offsets[inner.location.row() - 1] + inner.location.column() - 1;
-        let inner_end =
-            self.offsets[inner.end_location.row() - 1] + inner.end_location.column() - 1;
+        let outer_start = self.offsets[outer.location.row() - 1][outer.location.column() - 1];
+        let outer_end = self.offsets[outer.end_location.row() - 1][outer.end_location.column() - 1];
+        let inner_start = self.offsets[inner.location.row() - 1][inner.location.column() - 1];
+        let inner_end = self.offsets[inner.end_location.row() - 1][inner.end_location.column() - 1];
         (
             &self.content[outer_start..inner_start],
             &self.content[inner_start..inner_end],
@@ -179,3 +177,22 @@ impl<'a> SourceCodeLocator<'a> {
         )
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use super::SourceCodeLocator;
+
+    #[test]
+    fn source_code_locator_init() {
+        let content = "# \u{4e9c}\nclass Foo:\n    \"\"\".\"\"\"";
+        let locator = SourceCodeLocator::new(content);
+        assert_eq!(locator.offsets.len(), 4);
+        assert_eq!(locator.offsets[0], [0, 1, 2, 5]);
+        assert_eq!(locator.offsets[1], [6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16]);
+        assert_eq!(
+            locator.offsets[2],
+            [17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28]
+        );
+        assert_eq!(locator.offsets[3], [29]);
+    }
+}

src/ast/relocate.rs

@@ -4,14 +4,14 @@ use crate::ast::types::Range;
 
 fn relocate_keyword(keyword: &mut Keyword, location: Range) {
     keyword.location = location.location;
-    keyword.end_location = location.end_location;
+    keyword.end_location = Some(location.end_location);
     relocate_expr(&mut keyword.node.value, location);
 }
 
 /// Change an expression's location (recursively) to match a desired, fixed location.
 pub fn relocate_expr(expr: &mut Expr, location: Range) {
     expr.location = location.location;
-    expr.end_location = location.end_location;
+    expr.end_location = Some(location.end_location);
     match &mut expr.node {
         ExprKind::BoolOp { values, .. } => {
             for expr in values {

src/ast/types.rs

@@ -18,7 +18,9 @@ impl Range {
     pub fn from_located<T>(located: &Located<T>) -> Self {
         Range {
             location: located.location,
-            end_location: located.end_location,
+            end_location: located
+                .end_location
+                .expect("AST nodes should have end_location."),
         }
     }
 }

src/autofix.rs

@@ -1,2 +0,0 @@
-pub mod fixer;
-pub mod fixes;

src/autofix/fixer.rs

@@ -1,7 +1,11 @@
+use std::collections::BTreeSet;
+
 use itertools::Itertools;
 use rustpython_parser::ast::Location;
 
-use crate::checks::{Check, Fix};
+use crate::autofix::Fix;
+use crate::autofix::Patch;
+use crate::checks::Check;
 
 #[derive(Hash)]
 pub enum Mode {
@@ -10,6 +14,17 @@ pub enum Mode {
     None,
 }
 
+impl Mode {
+    /// Return `true` if a patch should be generated under the given `Mode`.
+    pub fn patch(&self) -> bool {
+        match &self {
+            Mode::Generate => true,
+            Mode::Apply => true,
+            Mode::None => false,
+        }
+    }
+}
+
 impl From<bool> for Mode {
     fn from(value: bool) -> Self {
         match value {
@@ -35,34 +50,44 @@ pub fn fix_file(checks: &mut [Check], contents: &str) -> Option<String> {
 fn apply_fixes<'a>(fixes: impl Iterator<Item = &'a mut Fix>, contents: &str) -> String {
     let lines: Vec<&str> = contents.lines().collect();
 
-    let mut output = "".to_string();
-    let mut last_pos: Location = Location::new(0, 0);
+    let mut output: String = Default::default();
+    let mut last_pos: Location = Default::default();
+    let mut applied: BTreeSet<&Patch> = Default::default();
 
-    for fix in fixes.sorted_by_key(|fix| fix.location) {
-        // Best-effort approach: if this fix overlaps with a fix we've already applied, skip it.
-        if last_pos > fix.location {
+    for fix in fixes.sorted_by_key(|fix| fix.patch.location) {
+        // If we already applied an identical fix as part of another correction, skip any
+        // re-application.
+        if applied.contains(&fix.patch) {
+            fix.applied = true;
             continue;
         }
 
-        if fix.location.row() > last_pos.row() {
+        // Best-effort approach: if this fix overlaps with a fix we've already applied, skip it.
+        if last_pos > fix.patch.location {
+            continue;
+        }
+
+        if fix.patch.location.row() > last_pos.row() {
             if last_pos.row() > 0 || last_pos.column() > 0 {
                 output.push_str(&lines[last_pos.row() - 1][last_pos.column() - 1..]);
                 output.push('\n');
             }
-            for line in &lines[last_pos.row()..fix.location.row() - 1] {
+            for line in &lines[last_pos.row()..fix.patch.location.row() - 1] {
                 output.push_str(line);
                 output.push('\n');
             }
-            output.push_str(&lines[fix.location.row() - 1][..fix.location.column() - 1]);
-            output.push_str(&fix.content);
+            output
+                .push_str(&lines[fix.patch.location.row() - 1][..fix.patch.location.column() - 1]);
+            output.push_str(&fix.patch.content);
         } else {
             output.push_str(
-                &lines[last_pos.row() - 1][last_pos.column() - 1..fix.location.column() - 1],
+                &lines[last_pos.row() - 1][last_pos.column() - 1..fix.patch.location.column() - 1],
             );
-            output.push_str(&fix.content);
+            output.push_str(&fix.patch.content);
         }
+        last_pos = fix.patch.end_location;
 
-        last_pos = fix.end_location;
+        applied.insert(&fix.patch);
         fix.applied = true;
     }
 
@@ -89,7 +114,8 @@ mod tests {
     use rustpython_parser::ast::Location;
 
     use crate::autofix::fixer::apply_fixes;
-    use crate::checks::Fix;
+    use crate::autofix::Fix;
+    use crate::autofix::Patch;
 
     #[test]
     fn empty_file() -> Result<()> {
@@ -105,9 +131,11 @@ mod tests {
     #[test]
     fn apply_single_replacement() -> Result<()> {
         let mut fixes = vec![Fix {
-            content: "Bar".to_string(),
-            location: Location::new(1, 9),
-            end_location: Location::new(1, 15),
+            patch: Patch {
+                content: "Bar".to_string(),
+                location: Location::new(1, 9),
+                end_location: Location::new(1, 15),
+            },
             applied: false,
         }];
         let actual = apply_fixes(
@@ -129,9 +157,11 @@ mod tests {
     #[test]
     fn apply_single_removal() -> Result<()> {
         let mut fixes = vec![Fix {
-            content: "".to_string(),
-            location: Location::new(1, 8),
-            end_location: Location::new(1, 16),
+            patch: Patch {
+                content: "".to_string(),
+                location: Location::new(1, 8),
+                end_location: Location::new(1, 16),
+            },
             applied: false,
         }];
         let actual = apply_fixes(
@@ -154,15 +184,19 @@ mod tests {
     fn apply_double_removal() -> Result<()> {
         let mut fixes = vec![
             Fix {
-                content: "".to_string(),
-                location: Location::new(1, 8),
-                end_location: Location::new(1, 17),
+                patch: Patch {
+                    content: "".to_string(),
+                    location: Location::new(1, 8),
+                    end_location: Location::new(1, 17),
+                },
                 applied: false,
             },
             Fix {
-                content: "".to_string(),
-                location: Location::new(1, 17),
-                end_location: Location::new(1, 24),
+                patch: Patch {
+                    content: "".to_string(),
+                    location: Location::new(1, 17),
+                    end_location: Location::new(1, 24),
+                },
                 applied: false,
             },
         ];
@@ -186,15 +220,19 @@ mod tests {
     fn ignore_overlapping_fixes() -> Result<()> {
         let mut fixes = vec![
             Fix {
-                content: "".to_string(),
-                location: Location::new(1, 8),
-                end_location: Location::new(1, 16),
+                patch: Patch {
+                    content: "".to_string(),
+                    location: Location::new(1, 8),
+                    end_location: Location::new(1, 16),
+                },
                 applied: false,
             },
             Fix {
-                content: "ignored".to_string(),
-                location: Location::new(1, 10),
-                end_location: Location::new(1, 12),
+                patch: Patch {
+                    content: "ignored".to_string(),
+                    location: Location::new(1, 10),
+                    end_location: Location::new(1, 12),
+                },
                 applied: false,
             },
         ];

src/autofix/fixes.rs

@@ -1,392 +0,0 @@
-use anyhow::Result;
-use itertools::Itertools;
-use libcst_native::ImportNames::Aliases;
-use libcst_native::NameOrAttribute::N;
-use libcst_native::{Codegen, Expression, SmallStatement, Statement};
-use rustpython_parser::ast::{ExcepthandlerKind, Expr, Keyword, Location, Stmt, StmtKind};
-use rustpython_parser::lexer;
-use rustpython_parser::token::Tok;
-
-use crate::ast::operations::SourceCodeLocator;
-use crate::ast::types::Range;
-use crate::checks::Fix;
-
-/// Convert a location within a file (relative to `base`) to an absolute position.
-fn to_absolute(relative: &Location, base: &Location) -> Location {
-    if relative.row() == 1 {
-        Location::new(
-            relative.row() + base.row() - 1,
-            relative.column() + base.column() - 1,
-        )
-    } else {
-        Location::new(relative.row() + base.row() - 1, relative.column())
-    }
-}
-
-/// Generate a fix to remove a base from a ClassDef statement.
-pub fn remove_class_def_base(
-    locator: &mut SourceCodeLocator,
-    stmt_at: &Location,
-    expr_at: Location,
-    bases: &[Expr],
-    keywords: &[Keyword],
-) -> Option<Fix> {
-    let content = locator.slice_source_code_at(stmt_at);
-
-    // Case 1: `object` is the only base.
-    if bases.len() == 1 && keywords.is_empty() {
-        let mut fix_start = None;
-        let mut fix_end = None;
-        let mut count: usize = 0;
-        for (start, tok, end) in lexer::make_tokenizer(content).flatten() {
-            if matches!(tok, Tok::Lpar) {
-                if count == 0 {
-                    fix_start = Some(to_absolute(&start, stmt_at));
-                }
-                count += 1;
-            }
-
-            if matches!(tok, Tok::Rpar) {
-                count -= 1;
-                if count == 0 {
-                    fix_end = Some(to_absolute(&end, stmt_at));
-                    break;
-                }
-            }
-        }
-
-        return match (fix_start, fix_end) {
-            (Some(start), Some(end)) => Some(Fix {
-                content: "".to_string(),
-                location: start,
-                end_location: end,
-                applied: false,
-            }),
-            _ => None,
-        };
-    }
-
-    if bases
-        .iter()
-        .map(|node| node.location)
-        .chain(keywords.iter().map(|node| node.location))
-        .any(|location| location > expr_at)
-    {
-        // Case 2: `object` is _not_ the last node.
-        let mut fix_start: Option<Location> = None;
-        let mut fix_end: Option<Location> = None;
-        let mut seen_comma = false;
-        for (start, tok, end) in lexer::make_tokenizer(content).flatten() {
-            let start = to_absolute(&start, stmt_at);
-            if seen_comma {
-                if matches!(tok, Tok::Newline) {
-                    fix_end = Some(end);
-                } else {
-                    fix_end = Some(start);
-                }
-                break;
-            }
-            if start == expr_at {
-                fix_start = Some(start);
-            }
-            if fix_start.is_some() && matches!(tok, Tok::Comma) {
-                seen_comma = true;
-            }
-        }
-
-        match (fix_start, fix_end) {
-            (Some(start), Some(end)) => Some(Fix {
-                content: "".to_string(),
-                location: start,
-                end_location: end,
-                applied: false,
-            }),
-            _ => None,
-        }
-    } else {
-        // Case 3: `object` is the last node, so we have to find the last token that isn't a comma.
-        let mut fix_start: Option<Location> = None;
-        let mut fix_end: Option<Location> = None;
-        for (start, tok, end) in lexer::make_tokenizer(content).flatten() {
-            let start = to_absolute(&start, stmt_at);
-            let end = to_absolute(&end, stmt_at);
-            if start == expr_at {
-                fix_end = Some(end);
-                break;
-            }
-            if matches!(tok, Tok::Comma) {
-                fix_start = Some(start);
-            }
-        }
-
-        match (fix_start, fix_end) {
-            (Some(start), Some(end)) => Some(Fix {
-                content: "".to_string(),
-                location: start,
-                end_location: end,
-                applied: false,
-            }),
-            _ => None,
-        }
-    }
-}
-
-pub fn remove_super_arguments(locator: &mut SourceCodeLocator, expr: &Expr) -> Option<Fix> {
-    let range = Range::from_located(expr);
-    let contents = locator.slice_source_code_range(&range);
-
-    let mut tree = match libcst_native::parse_module(contents, None) {
-        Ok(m) => m,
-        Err(_) => return None,
-    };
-
-    if let Some(Statement::Simple(body)) = tree.body.first_mut() {
-        if let Some(SmallStatement::Expr(body)) = body.body.first_mut() {
-            if let Expression::Call(body) = &mut body.value {
-                body.args = vec![];
-                body.whitespace_before_args = Default::default();
-                body.whitespace_after_func = Default::default();
-
-                let mut state = Default::default();
-                tree.codegen(&mut state);
-
-                return Some(Fix {
-                    content: state.to_string(),
-                    location: range.location,
-                    end_location: range.end_location,
-                    applied: false,
-                });
-            }
-        }
-    }
-
-    None
-}
-
-/// Determine if a body contains only a single statement, taking into account deleted.
-fn has_single_child(body: &[Stmt], deleted: &[&Stmt]) -> bool {
-    body.iter().filter(|child| !deleted.contains(child)).count() == 1
-}
-
-/// Determine if a child is the only statement in its body.
-fn is_lone_child(child: &Stmt, parent: &Stmt, deleted: &[&Stmt]) -> Result<bool> {
-    match &parent.node {
-        StmtKind::FunctionDef { body, .. }
-        | StmtKind::AsyncFunctionDef { body, .. }
-        | StmtKind::ClassDef { body, .. }
-        | StmtKind::With { body, .. }
-        | StmtKind::AsyncWith { body, .. } => {
-            if body.iter().contains(child) {
-                Ok(has_single_child(body, deleted))
-            } else {
-                Err(anyhow::anyhow!("Unable to find child in parent body."))
-            }
-        }
-        StmtKind::For { body, orelse, .. }
-        | StmtKind::AsyncFor { body, orelse, .. }
-        | StmtKind::While { body, orelse, .. }
-        | StmtKind::If { body, orelse, .. } => {
-            if body.iter().contains(child) {
-                Ok(has_single_child(body, deleted))
-            } else if orelse.iter().contains(child) {
-                Ok(has_single_child(orelse, deleted))
-            } else {
-                Err(anyhow::anyhow!("Unable to find child in parent body."))
-            }
-        }
-        StmtKind::Try {
-            body,
-            handlers,
-            orelse,
-            finalbody,
-        } => {
-            if body.iter().contains(child) {
-                Ok(has_single_child(body, deleted))
-            } else if orelse.iter().contains(child) {
-                Ok(has_single_child(orelse, deleted))
-            } else if finalbody.iter().contains(child) {
-                Ok(has_single_child(finalbody, deleted))
-            } else if let Some(body) = handlers.iter().find_map(|handler| match &handler.node {
-                ExcepthandlerKind::ExceptHandler { body, .. } => {
-                    if body.iter().contains(child) {
-                        Some(body)
-                    } else {
-                        None
-                    }
-                }
-            }) {
-                Ok(has_single_child(body, deleted))
-            } else {
-                Err(anyhow::anyhow!("Unable to find child in parent body."))
-            }
-        }
-        _ => Err(anyhow::anyhow!("Unable to find child in parent body.")),
-    }
-}
-
-pub fn remove_stmt(stmt: &Stmt, parent: Option<&Stmt>, deleted: &[&Stmt]) -> Result<Fix> {
-    if parent
-        .map(|parent| is_lone_child(stmt, parent, deleted))
-        .map_or(Ok(None), |v| v.map(Some))?
-        .unwrap_or_default()
-    {
-        // If removing this node would lead to an invalid syntax tree, replace
-        // it with a `pass`.
-        Ok(Fix {
-            location: stmt.location,
-            end_location: stmt.end_location,
-            content: "pass".to_string(),
-            applied: false,
-        })
-    } else {
-        // Otherwise, nuke the entire line.
-        // TODO(charlie): This logic assumes that there are no multi-statement physical lines.
-        Ok(Fix {
-            location: Location::new(stmt.location.row(), 1),
-            end_location: Location::new(stmt.end_location.row() + 1, 1),
-            content: "".to_string(),
-            applied: false,
-        })
-    }
-}
-
-/// Generate a Fix to remove any unused imports from an `import` statement.
-pub fn remove_unused_imports(
-    locator: &mut SourceCodeLocator,
-    full_names: &[&str],
-    stmt: &Stmt,
-    parent: Option<&Stmt>,
-    deleted: &[&Stmt],
-) -> Result<Fix> {
-    let mut tree = match libcst_native::parse_module(
-        locator.slice_source_code_range(&Range::from_located(stmt)),
-        None,
-    ) {
-        Ok(m) => m,
-        Err(_) => return Err(anyhow::anyhow!("Failed to extract CST from source.")),
-    };
-
-    let body = if let Some(Statement::Simple(body)) = tree.body.first_mut() {
-        body
-    } else {
-        return Err(anyhow::anyhow!("Expected node to be: Statement::Simple."));
-    };
-    let body = if let Some(SmallStatement::Import(body)) = body.body.first_mut() {
-        body
-    } else {
-        return Err(anyhow::anyhow!(
-            "Expected node to be: SmallStatement::ImportFrom."
-        ));
-    };
-    let aliases = &mut body.names;
-
-    // Preserve the trailing comma (or not) from the last entry.
-    let trailing_comma = aliases.last().and_then(|alias| alias.comma.clone());
-
-    // Identify unused imports from within the `import from`.
-    let mut removable = vec![];
-    for (index, alias) in aliases.iter().enumerate() {
-        if let N(import_name) = &alias.name {
-            if full_names.contains(&import_name.value) {
-                removable.push(index);
-            }
-        }
-    }
-    // TODO(charlie): This is quadratic.
-    for index in removable.iter().rev() {
-        aliases.remove(*index);
-    }
-
-    if let Some(alias) = aliases.last_mut() {
-        alias.comma = trailing_comma;
-    }
-
-    if aliases.is_empty() {
-        remove_stmt(stmt, parent, deleted)
-    } else {
-        let mut state = Default::default();
-        tree.codegen(&mut state);
-
-        Ok(Fix {
-            content: state.to_string(),
-            location: stmt.location,
-            end_location: stmt.end_location,
-            applied: false,
-        })
-    }
-}
-
-/// Generate a Fix to remove any unused imports from an `import from` statement.
-pub fn remove_unused_import_froms(
-    locator: &mut SourceCodeLocator,
-    full_names: &[&str],
-    stmt: &Stmt,
-    parent: Option<&Stmt>,
-    deleted: &[&Stmt],
-) -> Result<Fix> {
-    let mut tree = match libcst_native::parse_module(
-        locator.slice_source_code_range(&Range::from_located(stmt)),
-        None,
-    ) {
-        Ok(m) => m,
-        Err(_) => return Err(anyhow::anyhow!("Failed to extract CST from source.")),
-    };
-
-    let body = if let Some(Statement::Simple(body)) = tree.body.first_mut() {
-        body
-    } else {
-        return Err(anyhow::anyhow!("Expected node to be: Statement::Simple."));
-    };
-    let body = if let Some(SmallStatement::ImportFrom(body)) = body.body.first_mut() {
-        body
-    } else {
-        return Err(anyhow::anyhow!(
-            "Expected node to be: SmallStatement::ImportFrom."
-        ));
-    };
-    let aliases = if let Aliases(aliases) = &mut body.names {
-        aliases
-    } else {
-        return Err(anyhow::anyhow!("Expected node to be: Aliases."));
-    };
-
-    // Preserve the trailing comma (or not) from the last entry.
-    let trailing_comma = aliases.last().and_then(|alias| alias.comma.clone());
-
-    // Identify unused imports from within the `import from`.
-    let mut removable = vec![];
-    for (index, alias) in aliases.iter().enumerate() {
-        if let N(name) = &alias.name {
-            let import_name = if let Some(N(module_name)) = &body.module {
-                format!("{}.{}", module_name.value, name.value)
-            } else {
-                name.value.to_string()
-            };
-            if full_names.contains(&import_name.as_str()) {
-                removable.push(index);
-            }
-        }
-    }
-    // TODO(charlie): This is quadratic.
-    for index in removable.iter().rev() {
-        aliases.remove(*index);
-    }
-
-    if let Some(alias) = aliases.last_mut() {
-        alias.comma = trailing_comma;
-    }
-
-    if aliases.is_empty() {
-        remove_stmt(stmt, parent, deleted)
-    } else {
-        let mut state = Default::default();
-        tree.codegen(&mut state);
-
-        Ok(Fix {
-            content: state.to_string(),
-            location: stmt.location,
-            end_location: stmt.end_location,
-            applied: false,
-        })
-    }
-}

src/autofix/helpers.rs

@@ -0,0 +1,89 @@
+use anyhow::Result;
+use itertools::Itertools;
+use rustpython_parser::ast::{ExcepthandlerKind, Location, Stmt, StmtKind};
+
+use crate::autofix::Fix;
+
+/// Determine if a body contains only a single statement, taking into account deleted.
+fn has_single_child(body: &[Stmt], deleted: &[&Stmt]) -> bool {
+    body.iter().filter(|child| !deleted.contains(child)).count() == 1
+}
+
+/// Determine if a child is the only statement in its body.
+fn is_lone_child(child: &Stmt, parent: &Stmt, deleted: &[&Stmt]) -> Result<bool> {
+    match &parent.node {
+        StmtKind::FunctionDef { body, .. }
+        | StmtKind::AsyncFunctionDef { body, .. }
+        | StmtKind::ClassDef { body, .. }
+        | StmtKind::With { body, .. }
+        | StmtKind::AsyncWith { body, .. } => {
+            if body.iter().contains(child) {
+                Ok(has_single_child(body, deleted))
+            } else {
+                Err(anyhow::anyhow!("Unable to find child in parent body."))
+            }
+        }
+        StmtKind::For { body, orelse, .. }
+        | StmtKind::AsyncFor { body, orelse, .. }
+        | StmtKind::While { body, orelse, .. }
+        | StmtKind::If { body, orelse, .. } => {
+            if body.iter().contains(child) {
+                Ok(has_single_child(body, deleted))
+            } else if orelse.iter().contains(child) {
+                Ok(has_single_child(orelse, deleted))
+            } else {
+                Err(anyhow::anyhow!("Unable to find child in parent body."))
+            }
+        }
+        StmtKind::Try {
+            body,
+            handlers,
+            orelse,
+            finalbody,
+        } => {
+            if body.iter().contains(child) {
+                Ok(has_single_child(body, deleted))
+            } else if orelse.iter().contains(child) {
+                Ok(has_single_child(orelse, deleted))
+            } else if finalbody.iter().contains(child) {
+                Ok(has_single_child(finalbody, deleted))
+            } else if let Some(body) = handlers.iter().find_map(|handler| match &handler.node {
+                ExcepthandlerKind::ExceptHandler { body, .. } => {
+                    if body.iter().contains(child) {
+                        Some(body)
+                    } else {
+                        None
+                    }
+                }
+            }) {
+                Ok(has_single_child(body, deleted))
+            } else {
+                Err(anyhow::anyhow!("Unable to find child in parent body."))
+            }
+        }
+        _ => Err(anyhow::anyhow!("Unable to find child in parent body.")),
+    }
+}
+
+pub fn remove_stmt(stmt: &Stmt, parent: Option<&Stmt>, deleted: &[&Stmt]) -> Result<Fix> {
+    if parent
+        .map(|parent| is_lone_child(stmt, parent, deleted))
+        .map_or(Ok(None), |v| v.map(Some))?
+        .unwrap_or_default()
+    {
+        // If removing this node would lead to an invalid syntax tree, replace
+        // it with a `pass`.
+        Ok(Fix::replacement(
+            "pass".to_string(),
+            stmt.location,
+            stmt.end_location.unwrap(),
+        ))
+    } else {
+        // Otherwise, nuke the entire line.
+        // TODO(charlie): This logic assumes that there are no multi-statement physical lines.
+        Ok(Fix::deletion(
+            Location::new(stmt.location.row(), 1),
+            Location::new(stmt.end_location.unwrap().row() + 1, 1),
+        ))
+    }
+}

src/autofix/mod.rs

@@ -0,0 +1,53 @@
+use rustpython_ast::Location;
+use serde::{Deserialize, Serialize};
+
+pub mod fixer;
+pub mod helpers;
+
+#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Serialize, Deserialize)]
+pub struct Patch {
+    pub content: String,
+    pub location: Location,
+    pub end_location: Location,
+}
+
+#[derive(Debug, PartialEq, Eq, Serialize, Deserialize)]
+pub struct Fix {
+    pub patch: Patch,
+    pub applied: bool,
+}
+
+impl Fix {
+    pub fn deletion(start: Location, end: Location) -> Self {
+        Self {
+            patch: Patch {
+                content: "".to_string(),
+                location: start,
+                end_location: end,
+            },
+            applied: false,
+        }
+    }
+
+    pub fn replacement(content: String, start: Location, end: Location) -> Self {
+        Self {
+            patch: Patch {
+                content,
+                location: start,
+                end_location: end,
+            },
+            applied: false,
+        }
+    }
+
+    pub fn insertion(content: String, at: Location) -> Self {
+        Self {
+            patch: Patch {
+                content,
+                location: at,
+                end_location: at,
+            },
+            applied: false,
+        }
+    }
+}

src/cache.rs

@@ -1,3 +1,9 @@
+// cacache uses asyncd-std which has no wasm support, so currently no caching support on wasm
+#![cfg_attr(
+    target_family = "wasm",
+    allow(unused_imports, unused_variables, dead_code)
+)]
+
 use std::collections::hash_map::DefaultHasher;
 use std::fs::{create_dir_all, File, Metadata};
 use std::hash::{Hash, Hasher};
@@ -5,6 +11,7 @@ use std::io::Write;
 use std::path::Path;
 
 use anyhow::Result;
+#[cfg(not(target_family = "wasm"))]
 use cacache::Error::EntryNotFound;
 use filetime::FileTime;
 use log::error;
@@ -107,6 +114,7 @@ pub fn get(
         return None;
     };
 
+    #[cfg(not(target_family = "wasm"))] // cacache needs async-std which doesn't support wasm
     match cacache::read_sync(cache_dir(), cache_key(path, settings, autofix)) {
         Ok(encoded) => match bincode::deserialize::<CheckResult>(&encoded[..]) {
             Ok(CheckResult {
@@ -137,12 +145,14 @@ pub fn set(
         return;
     };
 
+    #[cfg(not(target_family = "wasm"))] // modification date not supported on wasm
     let check_result = CheckResultRef {
         metadata: &CacheMetadata {
             mtime: FileTime::from_last_modification_time(metadata).unix_seconds(),
         },
         messages,
     };
+    #[cfg(not(target_family = "wasm"))] // cacache needs async-std which doesn't support wasm
     if let Err(e) = cacache::write_sync(
         cache_dir(),
         cache_key(path, settings, autofix),

src/check_lines.rs

@@ -1,10 +1,13 @@
+//! Lint rules based on checking raw physical lines.
+
 use std::collections::BTreeMap;
 
 use rustpython_parser::ast::Location;
 
 use crate::ast::types::Range;
 use crate::autofix::fixer;
-use crate::checks::{Check, CheckCode, CheckKind, Fix};
+use crate::autofix::Fix;
+use crate::checks::{Check, CheckCode, CheckKind};
 use crate::noqa;
 use crate::noqa::Directive;
 use crate::settings::Settings;
@@ -165,16 +168,11 @@ pub fn check_lines(
                                 end_location: Location::new(row + 1, end + 1),
                             },
                         );
-                        if matches!(autofix, fixer::Mode::Generate | fixer::Mode::Apply) {
-                            check.amend(Fix {
-                                content: "".to_string(),
-                                location: Location::new(row + 1, start + 1),
-                                end_location: Location::new(
-                                    row + 1,
-                                    lines[row].chars().count() + 1,
-                                ),
-                                applied: false,
-                            });
+                        if autofix.patch() {
+                            check.amend(Fix::deletion(
+                                Location::new(row + 1, start + 1),
+                                Location::new(row + 1, lines[row].chars().count() + 1),
+                            ));
                         }
                         line_checks.push(check);
                     }
@@ -198,27 +196,18 @@ pub fn check_lines(
                                 end_location: Location::new(row + 1, end + 1),
                             },
                         );
-                        if matches!(autofix, fixer::Mode::Generate | fixer::Mode::Apply) {
+                        if autofix.patch() {
                             if valid_codes.is_empty() {
-                                check.amend(Fix {
-                                    content: "".to_string(),
-                                    location: Location::new(row + 1, start + 1),
-                                    end_location: Location::new(
-                                        row + 1,
-                                        lines[row].chars().count() + 1,
-                                    ),
-                                    applied: false,
-                                });
+                                check.amend(Fix::deletion(
+                                    Location::new(row + 1, start + 1),
+                                    Location::new(row + 1, lines[row].chars().count() + 1),
+                                ));
                             } else {
-                                check.amend(Fix {
-                                    content: format!("  # noqa: {}", valid_codes.join(", ")),
-                                    location: Location::new(row + 1, start + 1),
-                                    end_location: Location::new(
-                                        row + 1,
-                                        lines[row].chars().count() + 1,
-                                    ),
-                                    applied: false,
-                                });
+                                check.amend(Fix::replacement(
+                                    format!("  # noqa: {}", valid_codes.join(", ")),
+                                    Location::new(row + 1, start + 1),
+                                    Location::new(row + 1, lines[row].chars().count() + 1),
+                                ));
                             }
                         }
                         line_checks.push(check);
@@ -240,7 +229,7 @@ pub fn check_lines(
 mod tests {
     use crate::autofix::fixer;
     use crate::checks::{Check, CheckCode};
-    use crate::settings;
+    use crate::settings::Settings;
 
     use super::check_lines;
 
@@ -254,9 +243,9 @@ mod tests {
                 &mut checks,
                 line,
                 &noqa_line_for,
-                &settings::Settings {
+                &Settings {
                     line_length,
-                    ..settings::Settings::for_rule(CheckCode::E501)
+                    ..Settings::for_rule(CheckCode::E501)
                 },
                 &fixer::Mode::Generate,
             );

src/check_tokens.rs

@@ -0,0 +1,54 @@
+//! Lint rules based on token traversal.
+
+use rustpython_parser::lexer::{LexResult, Tok};
+
+use crate::ast::operations::SourceCodeLocator;
+use crate::checks::{Check, CheckCode};
+use crate::flake8_quotes::docstring_detection::StateMachine;
+use crate::{flake8_quotes, pycodestyle, Settings};
+
+pub fn check_tokens(
+    checks: &mut Vec<Check>,
+    contents: &str,
+    tokens: &[LexResult],
+    settings: &Settings,
+) {
+    let enforce_invalid_escape_sequence = settings.enabled.contains(&CheckCode::W605);
+    let enforce_quotes = settings.enabled.contains(&CheckCode::Q000)
+        | settings.enabled.contains(&CheckCode::Q001)
+        | settings.enabled.contains(&CheckCode::Q002)
+        | settings.enabled.contains(&CheckCode::Q003);
+
+    // TODO(charlie): Use a shared SourceCodeLocator between this site and the AST traversal.
+    let locator = SourceCodeLocator::new(contents);
+
+    let mut state_machine = StateMachine::new();
+    for (start, tok, end) in tokens.iter().flatten() {
+        // W605
+        if enforce_invalid_escape_sequence {
+            if matches!(tok, Tok::String { .. }) {
+                checks.extend(pycodestyle::checks::invalid_escape_sequence(
+                    &locator, start, end,
+                ));
+            }
+        }
+
+        // flake8-quotes
+        if enforce_quotes {
+            let is_docstring = state_machine.consume(tok);
+            if matches!(tok, Tok::String { .. }) {
+                if let Some(check) = flake8_quotes::checks::quotes(
+                    &locator,
+                    start,
+                    end,
+                    is_docstring,
+                    &settings.flake8_quotes,
+                ) {
+                    if settings.enabled.contains(check.kind.code()) {
+                        checks.push(check);
+                    }
+                }
+            }
+        }
+    }
+}

src/cli.rs

@@ -5,11 +5,11 @@ use clap::{command, Parser};
 use log::warn;
 use regex::Regex;
 
-use crate::checks::CheckCode;
+use crate::checks_gen::CheckCodePrefix;
 use crate::printer::SerializationFormat;
-use crate::pyproject::StrCheckCodePair;
-use crate::settings::PythonVersion;
-use crate::RawSettings;
+use crate::settings::configuration::Configuration;
+use crate::settings::types::PythonVersion;
+use crate::settings::types::StrCheckCodePair;
 
 #[derive(Debug, Parser)]
 #[command(author, about = "ruff: An extremely fast Python linter.")]
@@ -21,11 +21,14 @@ pub struct Cli {
     #[arg(long)]
     pub config: Option<PathBuf>,
     /// Enable verbose logging.
-    #[arg(short, long)]
+    #[arg(short, long, group = "verbosity")]
     pub verbose: bool,
-    /// Disable all logging (but still exit with status code "1" upon detecting errors).
-    #[arg(short, long)]
+    /// Only log errors.
+    #[arg(short, long, group = "verbosity")]
     pub quiet: bool,
+    /// Disable all logging (but still exit with status code "1" upon detecting errors).
+    #[arg(short, long, group = "verbosity")]
+    pub silent: bool,
     /// Exit with status code "0", even upon detecting errors.
     #[arg(short, long)]
     pub exit_zero: bool,
@@ -40,16 +43,16 @@ pub struct Cli {
     pub no_cache: bool,
     /// List of error codes to enable.
     #[arg(long, value_delimiter = ',')]
-    pub select: Vec<CheckCode>,
+    pub select: Vec<CheckCodePrefix>,
     /// Like --select, but adds additional error codes on top of the selected ones.
     #[arg(long, value_delimiter = ',')]
-    pub extend_select: Vec<CheckCode>,
+    pub extend_select: Vec<CheckCodePrefix>,
     /// List of error codes to ignore.
     #[arg(long, value_delimiter = ',')]
-    pub ignore: Vec<CheckCode>,
+    pub ignore: Vec<CheckCodePrefix>,
     /// Like --ignore, but adds additional error codes on top of the ignored ones.
     #[arg(long, value_delimiter = ',')]
-    pub extend_ignore: Vec<CheckCode>,
+    pub extend_ignore: Vec<CheckCodePrefix>,
     /// List of paths, used to exclude files and/or directories from checks.
     #[arg(long, value_delimiter = ',')]
     pub exclude: Vec<String>,
@@ -103,10 +106,10 @@ impl fmt::Display for Warnable {
 /// Warn the user if they attempt to enable a code that won't be respected.
 pub fn warn_on(
     flag: Warnable,
-    codes: &Vec<CheckCode>,
-    cli_ignore: &Vec<CheckCode>,
-    cli_extend_ignore: &Vec<CheckCode>,
-    pyproject_settings: &RawSettings,
+    codes: &[CheckCodePrefix],
+    cli_ignore: &[CheckCodePrefix],
+    cli_extend_ignore: &[CheckCodePrefix],
+    pyproject_configuration: &Configuration,
     pyproject_path: &Option<PathBuf>,
 ) {
     for code in codes {
@@ -114,7 +117,7 @@ pub fn warn_on(
             if cli_ignore.contains(code) {
                 warn!("{code:?} was passed to {flag}, but ignored via --ignore")
             }
-        } else if pyproject_settings.ignore.contains(code) {
+        } else if pyproject_configuration.ignore.contains(code) {
             if let Some(path) = pyproject_path {
                 warn!(
                     "{code:?} was passed to {flag}, but ignored by the `ignore` field in {}",
@@ -128,7 +131,7 @@ pub fn warn_on(
             if cli_extend_ignore.contains(code) {
                 warn!("{code:?} was passed to {flag}, but ignored via --extend-ignore")
             }
-        } else if pyproject_settings.extend_ignore.contains(code) {
+        } else if pyproject_configuration.extend_ignore.contains(code) {
             if let Some(path) = pyproject_path {
                 warn!(
                     "{code:?} was passed to {flag}, but ignored by the `extend_ignore` field in {}",

src/cst/helpers.rs

@@ -0,0 +1,42 @@
+use libcst_native::{Expression, NameOrAttribute};
+
+fn compose_call_path_inner<'a>(expr: &'a Expression, parts: &mut Vec<&'a str>) {
+    match &expr {
+        Expression::Call(expr) => {
+            compose_call_path_inner(&expr.func, parts);
+        }
+        Expression::Attribute(expr) => {
+            compose_call_path_inner(&expr.value, parts);
+            parts.push(expr.attr.value);
+        }
+        Expression::Name(expr) => {
+            parts.push(expr.value);
+        }
+        _ => {}
+    }
+}
+
+pub fn compose_call_path(expr: &Expression) -> Option<String> {
+    let mut segments = vec![];
+    compose_call_path_inner(expr, &mut segments);
+    if segments.is_empty() {
+        None
+    } else {
+        Some(segments.join("."))
+    }
+}
+
+pub fn compose_module_path(module: &NameOrAttribute) -> String {
+    match module {
+        NameOrAttribute::N(name) => name.value.to_string(),
+        NameOrAttribute::A(attr) => {
+            let name = attr.attr.value;
+            let prefix = compose_call_path(&attr.value);
+            if let Some(prefix) = prefix {
+                format!("{prefix}.{name}")
+            } else {
+                name.to_string()
+            }
+        }
+    }
+}

src/cst/mod.rs

@@ -0,0 +1 @@
+pub mod helpers;

src/docstrings.rs

@@ -1,3 +0,0 @@
-pub mod docstring_checks;
-pub mod sections;
-pub mod types;

src/docstrings/docstring_checks.rs

@@ -1,676 +0,0 @@
-//! Abstractions for tracking and validating docstrings in Python code.
-
-use once_cell::sync::Lazy;
-use regex::Regex;
-use rustpython_ast::{Constant, Expr, ExprKind, Location, Stmt, StmtKind};
-
-use crate::ast::types::Range;
-use crate::check_ast::Checker;
-use crate::checks::{Check, CheckCode, CheckKind};
-use crate::docstrings::sections::{check_numpy_section, section_contexts};
-use crate::docstrings::types::{Definition, DefinitionKind, Documentable};
-use crate::visibility::{is_init, is_magic, is_overload, Modifier, Visibility, VisibleScope};
-
-/// Extract a docstring from a function or class body.
-pub fn docstring_from(suite: &[Stmt]) -> Option<&Expr> {
-    if let Some(stmt) = suite.first() {
-        if let StmtKind::Expr { value } = &stmt.node {
-            if matches!(
-                &value.node,
-                ExprKind::Constant {
-                    value: Constant::Str(_),
-                    ..
-                }
-            ) {
-                return Some(value);
-            }
-        }
-    }
-    None
-}
-
-/// Extract a `Definition` from the AST node defined by a `Stmt`.
-pub fn extract<'a>(
-    scope: &VisibleScope,
-    stmt: &'a Stmt,
-    body: &'a [Stmt],
-    kind: &Documentable,
-) -> Definition<'a> {
-    let expr = docstring_from(body);
-    match kind {
-        Documentable::Function => match scope {
-            VisibleScope {
-                modifier: Modifier::Module,
-                ..
-            } => Definition {
-                kind: DefinitionKind::Function(stmt),
-                docstring: expr,
-            },
-            VisibleScope {
-                modifier: Modifier::Class,
-                ..
-            } => Definition {
-                kind: DefinitionKind::Method(stmt),
-                docstring: expr,
-            },
-            VisibleScope {
-                modifier: Modifier::Function,
-                ..
-            } => Definition {
-                kind: DefinitionKind::NestedFunction(stmt),
-                docstring: expr,
-            },
-        },
-        Documentable::Class => match scope {
-            VisibleScope {
-                modifier: Modifier::Module,
-                ..
-            } => Definition {
-                kind: DefinitionKind::Class(stmt),
-                docstring: expr,
-            },
-            VisibleScope {
-                modifier: Modifier::Class,
-                ..
-            } => Definition {
-                kind: DefinitionKind::NestedClass(stmt),
-                docstring: expr,
-            },
-            VisibleScope {
-                modifier: Modifier::Function,
-                ..
-            } => Definition {
-                kind: DefinitionKind::NestedClass(stmt),
-                docstring: expr,
-            },
-        },
-    }
-}
-
-/// Extract the source code range for a docstring.
-pub fn range_for(docstring: &Expr) -> Range {
-    // RustPython currently omits the first quotation mark in a string, so offset the location.
-    Range {
-        location: Location::new(docstring.location.row(), docstring.location.column() - 1),
-        end_location: docstring.end_location,
-    }
-}
-
-/// D100, D101, D102, D103, D104, D105, D106, D107
-pub fn not_missing(
-    checker: &mut Checker,
-    definition: &Definition,
-    visibility: &Visibility,
-) -> bool {
-    if matches!(visibility, Visibility::Private) {
-        return true;
-    }
-
-    if definition.docstring.is_some() {
-        return true;
-    }
-
-    match definition.kind {
-        DefinitionKind::Module => {
-            if checker.settings.enabled.contains(&CheckCode::D100) {
-                checker.add_check(Check::new(
-                    CheckKind::PublicModule,
-                    Range {
-                        location: Location::new(1, 1),
-                        end_location: Location::new(1, 1),
-                    },
-                ));
-            }
-            false
-        }
-        DefinitionKind::Package => {
-            if checker.settings.enabled.contains(&CheckCode::D104) {
-                checker.add_check(Check::new(
-                    CheckKind::PublicPackage,
-                    Range {
-                        location: Location::new(1, 1),
-                        end_location: Location::new(1, 1),
-                    },
-                ));
-            }
-            false
-        }
-        DefinitionKind::Class(stmt) => {
-            if checker.settings.enabled.contains(&CheckCode::D101) {
-                checker.add_check(Check::new(
-                    CheckKind::PublicClass,
-                    Range::from_located(stmt),
-                ));
-            }
-            false
-        }
-        DefinitionKind::NestedClass(stmt) => {
-            if checker.settings.enabled.contains(&CheckCode::D106) {
-                checker.add_check(Check::new(
-                    CheckKind::PublicNestedClass,
-                    Range::from_located(stmt),
-                ));
-            }
-            false
-        }
-        DefinitionKind::Function(stmt) | DefinitionKind::NestedFunction(stmt) => {
-            if is_overload(stmt) {
-                true
-            } else {
-                if checker.settings.enabled.contains(&CheckCode::D103) {
-                    checker.add_check(Check::new(
-                        CheckKind::PublicFunction,
-                        Range::from_located(stmt),
-                    ));
-                }
-                false
-            }
-        }
-        DefinitionKind::Method(stmt) => {
-            if is_overload(stmt) {
-                true
-            } else if is_magic(stmt) {
-                if checker.settings.enabled.contains(&CheckCode::D105) {
-                    checker.add_check(Check::new(
-                        CheckKind::MagicMethod,
-                        Range::from_located(stmt),
-                    ));
-                }
-                true
-            } else if is_init(stmt) {
-                if checker.settings.enabled.contains(&CheckCode::D107) {
-                    checker.add_check(Check::new(CheckKind::PublicInit, Range::from_located(stmt)));
-                }
-                true
-            } else {
-                if checker.settings.enabled.contains(&CheckCode::D102) {
-                    checker.add_check(Check::new(
-                        CheckKind::PublicMethod,
-                        Range::from_located(stmt),
-                    ));
-                }
-                true
-            }
-        }
-    }
-}
-
-/// D200
-pub fn one_liner(checker: &mut Checker, definition: &Definition) {
-    if let Some(docstring) = &definition.docstring {
-        if let ExprKind::Constant {
-            value: Constant::Str(string),
-            ..
-        } = &docstring.node
-        {
-            let mut line_count = 0;
-            let mut non_empty_line_count = 0;
-            for line in string.lines() {
-                line_count += 1;
-                if !line.trim().is_empty() {
-                    non_empty_line_count += 1;
-                }
-                if non_empty_line_count > 1 {
-                    break;
-                }
-            }
-
-            if non_empty_line_count == 1 && line_count > 1 {
-                checker.add_check(Check::new(CheckKind::FitsOnOneLine, range_for(docstring)));
-            }
-        }
-    }
-}
-
-static COMMENT_REGEX: Lazy<Regex> = Lazy::new(|| Regex::new(r"^\s*#").unwrap());
-
-static INNER_FUNCTION_OR_CLASS_REGEX: Lazy<Regex> =
-    Lazy::new(|| Regex::new(r"^\s+(?:(?:class|def|async def)\s|@)").unwrap());
-
-/// D201, D202
-pub fn blank_before_after_function(checker: &mut Checker, definition: &Definition) {
-    if let Some(docstring) = definition.docstring {
-        if let DefinitionKind::Function(parent)
-        | DefinitionKind::NestedFunction(parent)
-        | DefinitionKind::Method(parent) = &definition.kind
-        {
-            if let ExprKind::Constant {
-                value: Constant::Str(_),
-                ..
-            } = &docstring.node
-            {
-                let (before, _, after) = checker
-                    .locator
-                    .partition_source_code_at(&Range::from_located(parent), &range_for(docstring));
-
-                if checker.settings.enabled.contains(&CheckCode::D201) {
-                    let blank_lines_before = before
-                        .lines()
-                        .rev()
-                        .skip(1)
-                        .take_while(|line| line.trim().is_empty())
-                        .count();
-                    if blank_lines_before != 0 {
-                        checker.add_check(Check::new(
-                            CheckKind::NoBlankLineBeforeFunction(blank_lines_before),
-                            range_for(docstring),
-                        ));
-                    }
-                }
-
-                if checker.settings.enabled.contains(&CheckCode::D202) {
-                    let blank_lines_after = after
-                        .lines()
-                        .skip(1)
-                        .take_while(|line| line.trim().is_empty())
-                        .count();
-                    let all_blank_after = after
-                        .lines()
-                        .skip(1)
-                        .all(|line| line.trim().is_empty() || COMMENT_REGEX.is_match(line));
-                    // Report a D202 violation if the docstring is followed by a blank line
-                    // and the blank line is not itself followed by an inner function or
-                    // class.
-                    if !all_blank_after
-                        && blank_lines_after != 0
-                        && !(blank_lines_after == 1
-                            && INNER_FUNCTION_OR_CLASS_REGEX.is_match(after))
-                    {
-                        checker.add_check(Check::new(
-                            CheckKind::NoBlankLineAfterFunction(blank_lines_after),
-                            range_for(docstring),
-                        ));
-                    }
-                }
-            }
-        }
-    }
-}
-
-/// D203, D204, D211
-pub fn blank_before_after_class(checker: &mut Checker, definition: &Definition) {
-    if let Some(docstring) = &definition.docstring {
-        if let DefinitionKind::Class(parent) | DefinitionKind::NestedClass(parent) =
-            &definition.kind
-        {
-            if let ExprKind::Constant {
-                value: Constant::Str(_),
-                ..
-            } = &docstring.node
-            {
-                let (before, _, after) = checker
-                    .locator
-                    .partition_source_code_at(&Range::from_located(parent), &range_for(docstring));
-
-                if checker.settings.enabled.contains(&CheckCode::D203)
-                    || checker.settings.enabled.contains(&CheckCode::D211)
-                {
-                    let blank_lines_before = before
-                        .lines()
-                        .rev()
-                        .skip(1)
-                        .take_while(|line| line.trim().is_empty())
-                        .count();
-                    if blank_lines_before != 0
-                        && checker.settings.enabled.contains(&CheckCode::D211)
-                    {
-                        checker.add_check(Check::new(
-                            CheckKind::NoBlankLineBeforeClass(blank_lines_before),
-                            range_for(docstring),
-                        ));
-                    }
-                    if blank_lines_before != 1
-                        && checker.settings.enabled.contains(&CheckCode::D203)
-                    {
-                        checker.add_check(Check::new(
-                            CheckKind::OneBlankLineBeforeClass(blank_lines_before),
-                            range_for(docstring),
-                        ));
-                    }
-                }
-
-                if checker.settings.enabled.contains(&CheckCode::D204) {
-                    let blank_lines_after = after
-                        .lines()
-                        .skip(1)
-                        .take_while(|line| line.trim().is_empty())
-                        .count();
-                    let all_blank_after = after
-                        .lines()
-                        .skip(1)
-                        .all(|line| line.trim().is_empty() || COMMENT_REGEX.is_match(line));
-                    if !all_blank_after && blank_lines_after != 1 {
-                        checker.add_check(Check::new(
-                            CheckKind::OneBlankLineAfterClass(blank_lines_after),
-                            range_for(docstring),
-                        ));
-                    }
-                }
-            }
-        }
-    }
-}
-
-/// D205
-pub fn blank_after_summary(checker: &mut Checker, definition: &Definition) {
-    if let Some(docstring) = definition.docstring {
-        if let ExprKind::Constant {
-            value: Constant::Str(string),
-            ..
-        } = &docstring.node
-        {
-            let mut lines_count = 1;
-            let mut blanks_count = 0;
-            for line in string.trim().lines().skip(1) {
-                lines_count += 1;
-                if line.trim().is_empty() {
-                    blanks_count += 1;
-                } else {
-                    break;
-                }
-            }
-            if lines_count > 1 && blanks_count != 1 {
-                checker.add_check(Check::new(
-                    CheckKind::NoBlankLineAfterSummary,
-                    range_for(docstring),
-                ));
-            }
-        }
-    }
-}
-
-/// D209
-pub fn newline_after_last_paragraph(checker: &mut Checker, definition: &Definition) {
-    if let Some(docstring) = definition.docstring {
-        if let ExprKind::Constant {
-            value: Constant::Str(string),
-            ..
-        } = &docstring.node
-        {
-            let mut line_count = 0;
-            for line in string.lines() {
-                if !line.trim().is_empty() {
-                    line_count += 1;
-                }
-                if line_count > 1 {
-                    let content = checker
-                        .locator
-                        .slice_source_code_range(&range_for(docstring));
-                    if let Some(line) = content.lines().last() {
-                        let line = line.trim();
-                        if line != "\"\"\"" && line != "'''" {
-                            checker.add_check(Check::new(
-                                CheckKind::NewLineAfterLastParagraph,
-                                range_for(docstring),
-                            ));
-                        }
-                    }
-                    return;
-                }
-            }
-        }
-    }
-}
-
-/// D210
-pub fn no_surrounding_whitespace(checker: &mut Checker, definition: &Definition) {
-    if let Some(docstring) = definition.docstring {
-        if let ExprKind::Constant {
-            value: Constant::Str(string),
-            ..
-        } = &docstring.node
-        {
-            let mut lines = string.lines();
-            if let Some(line) = lines.next() {
-                if line.trim().is_empty() {
-                    return;
-                }
-                if line.starts_with(' ') || (matches!(lines.next(), None) && line.ends_with(' ')) {
-                    checker.add_check(Check::new(
-                        CheckKind::NoSurroundingWhitespace,
-                        range_for(docstring),
-                    ));
-                }
-            }
-        }
-    }
-}
-
-/// D212, D213
-pub fn multi_line_summary_start(checker: &mut Checker, definition: &Definition) {
-    if let Some(docstring) = definition.docstring {
-        if let ExprKind::Constant {
-            value: Constant::Str(string),
-            ..
-        } = &docstring.node
-        {
-            if string.lines().nth(1).is_some() {
-                let content = checker
-                    .locator
-                    .slice_source_code_range(&range_for(docstring));
-                if let Some(first_line) = content.lines().next() {
-                    let first_line = first_line.trim();
-                    if first_line == "\"\"\"" || first_line == "'''" {
-                        if checker.settings.enabled.contains(&CheckCode::D212) {
-                            checker.add_check(Check::new(
-                                CheckKind::MultiLineSummaryFirstLine,
-                                range_for(docstring),
-                            ));
-                        }
-                    } else if checker.settings.enabled.contains(&CheckCode::D213) {
-                        checker.add_check(Check::new(
-                            CheckKind::MultiLineSummarySecondLine,
-                            range_for(docstring),
-                        ));
-                    }
-                }
-            }
-        }
-    }
-}
-
-/// D300
-pub fn triple_quotes(checker: &mut Checker, definition: &Definition) {
-    if let Some(docstring) = definition.docstring {
-        if let ExprKind::Constant {
-            value: Constant::Str(string),
-            ..
-        } = &docstring.node
-        {
-            let content = checker
-                .locator
-                .slice_source_code_range(&range_for(docstring));
-            if string.contains("\"\"\"") {
-                if !content.starts_with("'''") {
-                    checker.add_check(Check::new(
-                        CheckKind::UsesTripleQuotes,
-                        range_for(docstring),
-                    ));
-                }
-            } else if !content.starts_with("\"\"\"") {
-                checker.add_check(Check::new(
-                    CheckKind::UsesTripleQuotes,
-                    range_for(docstring),
-                ));
-            }
-        }
-    }
-}
-
-/// D400
-pub fn ends_with_period(checker: &mut Checker, definition: &Definition) {
-    if let Some(docstring) = definition.docstring {
-        if let ExprKind::Constant {
-            value: Constant::Str(string),
-            ..
-        } = &docstring.node
-        {
-            if let Some(string) = string.lines().next() {
-                if !string.ends_with('.') {
-                    checker.add_check(Check::new(CheckKind::EndsInPeriod, range_for(docstring)));
-                }
-            }
-        }
-    }
-}
-
-/// D402
-pub fn no_signature(checker: &mut Checker, definition: &Definition) {
-    if let Some(docstring) = definition.docstring {
-        if let DefinitionKind::Function(parent)
-        | DefinitionKind::NestedFunction(parent)
-        | DefinitionKind::Method(parent) = definition.kind
-        {
-            if let StmtKind::FunctionDef { name, .. } = &parent.node {
-                if let ExprKind::Constant {
-                    value: Constant::Str(string),
-                    ..
-                } = &docstring.node
-                {
-                    if let Some(first_line) = string.lines().next() {
-                        if first_line.contains(&format!("{name}(")) {
-                            checker.add_check(Check::new(
-                                CheckKind::NoSignature,
-                                range_for(docstring),
-                            ));
-                        }
-                    }
-                }
-            }
-        }
-    }
-}
-
-/// D403
-pub fn capitalized(checker: &mut Checker, definition: &Definition) {
-    if !matches!(definition.kind, DefinitionKind::Function(_)) {
-        return;
-    }
-
-    if let Some(docstring) = definition.docstring {
-        if let ExprKind::Constant {
-            value: Constant::Str(string),
-            ..
-        } = &docstring.node
-        {
-            if let Some(first_word) = string.split(' ').next() {
-                if first_word == first_word.to_uppercase() {
-                    return;
-                }
-                for char in first_word.chars() {
-                    if !char.is_ascii_alphabetic() && char != '\'' {
-                        return;
-                    }
-                }
-                if let Some(first_char) = first_word.chars().next() {
-                    if !first_char.is_uppercase() {
-                        checker.add_check(Check::new(
-                            CheckKind::FirstLineCapitalized,
-                            range_for(docstring),
-                        ));
-                    }
-                }
-            }
-        }
-    }
-}
-
-/// D404
-pub fn starts_with_this(checker: &mut Checker, definition: &Definition) {
-    if let Some(docstring) = definition.docstring {
-        if let ExprKind::Constant {
-            value: Constant::Str(string),
-            ..
-        } = &docstring.node
-        {
-            let trimmed = string.trim();
-            if trimmed.is_empty() {
-                return;
-            }
-
-            if let Some(first_word) = string.split(' ').next() {
-                if first_word
-                    .replace(|c: char| !c.is_alphanumeric(), "")
-                    .to_lowercase()
-                    == "this"
-                {
-                    checker.add_check(Check::new(CheckKind::NoThisPrefix, range_for(docstring)));
-                }
-            }
-        }
-    }
-}
-
-/// D415
-pub fn ends_with_punctuation(checker: &mut Checker, definition: &Definition) {
-    if let Some(docstring) = definition.docstring {
-        if let ExprKind::Constant {
-            value: Constant::Str(string),
-            ..
-        } = &docstring.node
-        {
-            if let Some(string) = string.lines().next() {
-                if !(string.ends_with('.') || string.ends_with('!') || string.ends_with('?')) {
-                    checker.add_check(Check::new(
-                        CheckKind::EndsInPunctuation,
-                        range_for(docstring),
-                    ));
-                }
-            }
-        }
-    }
-}
-
-/// D418
-pub fn if_needed(checker: &mut Checker, definition: &Definition) {
-    if definition.docstring.is_some() {
-        if let DefinitionKind::Function(stmt)
-        | DefinitionKind::NestedFunction(stmt)
-        | DefinitionKind::Method(stmt) = definition.kind
-        {
-            if is_overload(stmt) {
-                checker.add_check(Check::new(
-                    CheckKind::SkipDocstring,
-                    Range::from_located(stmt),
-                ));
-            }
-        }
-    }
-}
-
-/// D419
-pub fn not_empty(checker: &mut Checker, definition: &Definition) -> bool {
-    if let Some(docstring) = definition.docstring {
-        if let ExprKind::Constant {
-            value: Constant::Str(string),
-            ..
-        } = &docstring.node
-        {
-            if string.trim().is_empty() {
-                if checker.settings.enabled.contains(&CheckCode::D419) {
-                    checker.add_check(Check::new(CheckKind::NonEmpty, range_for(docstring)));
-                }
-                return false;
-            }
-        }
-    }
-    true
-}
-
-pub fn check_sections(checker: &mut Checker, definition: &Definition) {
-    if let Some(docstring) = definition.docstring {
-        if let ExprKind::Constant {
-            value: Constant::Str(string),
-            ..
-        } = &docstring.node
-        {
-            let lines: Vec<&str> = string.lines().collect();
-            if lines.len() < 2 {
-                return;
-            }
-            for context in &section_contexts(&lines) {
-                check_numpy_section(checker, definition, context);
-            }
-        }
-    }
-}

src/docstrings/extraction.rs

@@ -0,0 +1,82 @@
+//! Extract docstrings from an AST.
+
+use rustpython_ast::{Constant, Expr, ExprKind, Stmt, StmtKind};
+
+use crate::docstrings::definition::{Definition, DefinitionKind, Documentable};
+use crate::visibility::{Modifier, VisibleScope};
+
+/// Extract a docstring from a function or class body.
+pub fn docstring_from(suite: &[Stmt]) -> Option<&Expr> {
+    if let Some(stmt) = suite.first() {
+        if let StmtKind::Expr { value } = &stmt.node {
+            if matches!(
+                &value.node,
+                ExprKind::Constant {
+                    value: Constant::Str(_),
+                    ..
+                }
+            ) {
+                return Some(value);
+            }
+        }
+    }
+    None
+}
+
+/// Extract a `Definition` from the AST node defined by a `Stmt`.
+pub fn extract<'a>(
+    scope: &VisibleScope,
+    stmt: &'a Stmt,
+    body: &'a [Stmt],
+    kind: &Documentable,
+) -> Definition<'a> {
+    let expr = docstring_from(body);
+    match kind {
+        Documentable::Function => match scope {
+            VisibleScope {
+                modifier: Modifier::Module,
+                ..
+            } => Definition {
+                kind: DefinitionKind::Function(stmt),
+                docstring: expr,
+            },
+            VisibleScope {
+                modifier: Modifier::Class,
+                ..
+            } => Definition {
+                kind: DefinitionKind::Method(stmt),
+                docstring: expr,
+            },
+            VisibleScope {
+                modifier: Modifier::Function,
+                ..
+            } => Definition {
+                kind: DefinitionKind::NestedFunction(stmt),
+                docstring: expr,
+            },
+        },
+        Documentable::Class => match scope {
+            VisibleScope {
+                modifier: Modifier::Module,
+                ..
+            } => Definition {
+                kind: DefinitionKind::Class(stmt),
+                docstring: expr,
+            },
+            VisibleScope {
+                modifier: Modifier::Class,
+                ..
+            } => Definition {
+                kind: DefinitionKind::NestedClass(stmt),
+                docstring: expr,
+            },
+            VisibleScope {
+                modifier: Modifier::Function,
+                ..
+            } => Definition {
+                kind: DefinitionKind::NestedClass(stmt),
+                docstring: expr,
+            },
+        },
+    }
+}

src/docstrings/google.rs

@@ -0,0 +1,71 @@
+//! Abstractions for Google-style docstrings.
+
+use std::collections::BTreeSet;
+
+use once_cell::sync::Lazy;
+
+pub(crate) static GOOGLE_SECTION_NAMES: Lazy<BTreeSet<&'static str>> = Lazy::new(|| {
+    BTreeSet::from([
+        "Args",
+        "Arguments",
+        "Attention",
+        "Attributes",
+        "Caution",
+        "Danger",
+        "Error",
+        "Example",
+        "Examples",
+        "Hint",
+        "Important",
+        "Keyword Args",
+        "Keyword Arguments",
+        "Methods",
+        "Note",
+        "Notes",
+        "Return",
+        "Returns",
+        "Raises",
+        "References",
+        "See Also",
+        "Tip",
+        "Todo",
+        "Warning",
+        "Warnings",
+        "Warns",
+        "Yield",
+        "Yields",
+    ])
+});
+
+pub(crate) static LOWERCASE_GOOGLE_SECTION_NAMES: Lazy<BTreeSet<&'static str>> = Lazy::new(|| {
+    BTreeSet::from([
+        "args",
+        "arguments",
+        "attention",
+        "attributes",
+        "caution",
+        "danger",
+        "error",
+        "example",
+        "examples",
+        "hint",
+        "important",
+        "keyword args",
+        "keyword arguments",
+        "methods",
+        "note",
+        "notes",
+        "return",
+        "returns",
+        "raises",
+        "references",
+        "see also",
+        "tip",
+        "todo",
+        "warning",
+        "warnings",
+        "warns",
+        "yield",
+        "yields",
+    ])
+});

src/docstrings/helpers.rs

@@ -0,0 +1,42 @@
+use rustpython_ast::{Expr, Location};
+
+use crate::ast::types::Range;
+use crate::check_ast::Checker;
+
+pub const TRIPLE_QUOTE_PREFIXES: &[&str] = &[
+    "ur\"\"\"", "ur'''", "u\"\"\"", "u'''", "r\"\"\"", "r'''", "\"\"\"", "'''",
+];
+
+pub const SINGLE_QUOTE_PREFIXES: &[&str] = &["ur\"", "ur'", "u\"", "u'", "r\"", "r'", "\"", "'"];
+
+/// Extract the leading words from a line of text.
+pub fn leading_words(line: &str) -> String {
+    line.trim()
+        .chars()
+        .take_while(|char| char.is_alphanumeric() || char.is_whitespace())
+        .collect()
+}
+
+/// Extract the leading whitespace from a line of text.
+pub fn leading_space(line: &str) -> String {
+    line.chars()
+        .take_while(|char| char.is_whitespace())
+        .collect()
+}
+
+/// Extract the leading indentation from a docstring.
+pub fn indentation<'a>(checker: &'a Checker, docstring: &Expr) -> &'a str {
+    let range = Range::from_located(docstring);
+    checker.get_locator().slice_source_code_range(&Range {
+        location: Location::new(range.location.row(), 1),
+        end_location: Location::new(range.location.row(), range.location.column()),
+    })
+}
+
+/// Replace any non-whitespace characters from an indentation string.
+pub fn clean(indentation: &str) -> String {
+    indentation
+        .chars()
+        .map(|char| if char.is_whitespace() { char } else { ' ' })
+        .collect()
+}

src/docstrings/mod.rs

@@ -0,0 +1,7 @@
+pub mod definition;
+pub mod extraction;
+pub mod google;
+pub mod helpers;
+pub mod numpy;
+pub mod sections;
+pub mod styles;

src/docstrings/numpy.rs

@@ -0,0 +1,41 @@
+//! Abstractions for NumPy-style docstrings.
+
+use std::collections::BTreeSet;
+
+use once_cell::sync::Lazy;
+
+pub(crate) static LOWERCASE_NUMPY_SECTION_NAMES: Lazy<BTreeSet<&'static str>> = Lazy::new(|| {
+    BTreeSet::from([
+        "short summary",
+        "extended summary",
+        "parameters",
+        "returns",
+        "yields",
+        "other parameters",
+        "raises",
+        "see also",
+        "notes",
+        "references",
+        "examples",
+        "attributes",
+        "methods",
+    ])
+});
+
+pub(crate) static NUMPY_SECTION_NAMES: Lazy<BTreeSet<&'static str>> = Lazy::new(|| {
+    BTreeSet::from([
+        "Short Summary",
+        "Extended Summary",
+        "Parameters",
+        "Returns",
+        "Yields",
+        "Other Parameters",
+        "Raises",
+        "See Also",
+        "Notes",
+        "References",
+        "Examples",
+        "Attributes",
+        "Methods",
+    ])
+});

src/docstrings/sections.rs

@@ -1,120 +1,20 @@
-use itertools::Itertools;
-use std::collections::BTreeSet;
-
-use once_cell::sync::Lazy;
-use rustpython_ast::{Arg, Expr, Location, StmtKind};
-use titlecase::titlecase;
-
-use crate::ast::types::Range;
-use crate::check_ast::Checker;
-use crate::checks::{Check, CheckCode, CheckKind};
-use crate::docstrings::docstring_checks::range_for;
-use crate::docstrings::types::{Definition, DefinitionKind};
-use crate::visibility::is_static;
-
-static NUMPY_SECTION_NAMES: Lazy<BTreeSet<&'static str>> = Lazy::new(|| {
-    BTreeSet::from([
-        "Short Summary",
-        "Extended Summary",
-        "Parameters",
-        "Returns",
-        "Yields",
-        "Other Parameters",
-        "Raises",
-        "See Also",
-        "Notes",
-        "References",
-        "Examples",
-        "Attributes",
-        "Methods",
-    ])
-});
-
-static NUMPY_SECTION_NAMES_LOWERCASE: Lazy<BTreeSet<&'static str>> = Lazy::new(|| {
-    BTreeSet::from([
-        "short summary",
-        "extended summary",
-        "parameters",
-        "returns",
-        "yields",
-        "other parameters",
-        "raises",
-        "see also",
-        "notes",
-        "references",
-        "examples",
-        "attributes",
-        "methods",
-    ])
-});
-
-// TODO(charlie): Include Google section names.
-// static GOOGLE_SECTION_NAMES: Lazy<BTreeSet<&'static str>> = Lazy::new(|| {
-//     BTreeSet::from([
-//         "Args",
-//         "Arguments",
-//         "Attention",
-//         "Attributes",
-//         "Caution",
-//         "Danger",
-//         "Error",
-//         "Example",
-//         "Examples",
-//         "Hint",
-//         "Important",
-//         "Keyword Args",
-//         "Keyword Arguments",
-//         "Methods",
-//         "Note",
-//         "Notes",
-//         "Return",
-//         "Returns",
-//         "Raises",
-//         "References",
-//         "See Also",
-//         "Tip",
-//         "Todo",
-//         "Warning",
-//         "Warnings",
-//         "Warns",
-//         "Yield",
-//         "Yields",
-//     ])
-// });
-
-fn indentation<'a>(checker: &'a mut Checker, docstring: &Expr) -> &'a str {
-    let range = range_for(docstring);
-    checker.locator.slice_source_code_range(&Range {
-        location: Location::new(range.location.row(), 1),
-        end_location: Location::new(range.location.row(), range.location.column()),
-    })
-}
-
-fn leading_space(line: &str) -> String {
-    line.chars()
-        .take_while(|char| char.is_whitespace())
-        .collect()
-}
-
-fn leading_words(line: &str) -> String {
-    line.trim()
-        .chars()
-        .take_while(|char| char.is_alphanumeric() || char.is_whitespace())
-        .collect()
-}
-
-fn suspected_as_section(line: &str) -> bool {
-    NUMPY_SECTION_NAMES_LOWERCASE.contains(&leading_words(line).to_lowercase().as_str())
-}
+use crate::docstrings::helpers;
+use crate::docstrings::styles::SectionStyle;
 
 #[derive(Debug)]
-pub struct SectionContext<'a> {
-    section_name: String,
-    previous_line: &'a str,
-    line: &'a str,
-    following_lines: &'a [&'a str],
-    original_index: usize,
-    is_last_section: bool,
+pub(crate) struct SectionContext<'a> {
+    pub(crate) section_name: String,
+    pub(crate) previous_line: &'a str,
+    pub(crate) line: &'a str,
+    pub(crate) following_lines: &'a [&'a str],
+    pub(crate) is_last_section: bool,
+    pub(crate) original_index: usize,
+}
+
+fn suspected_as_section(line: &str, style: &SectionStyle) -> bool {
+    style
+        .lowercase_section_names()
+        .contains(&helpers::leading_words(line).to_lowercase().as_str())
 }
 
 /// Check if the suspected context is really a section header.
@@ -145,12 +45,15 @@ fn is_docstring_section(context: &SectionContext) -> bool {
 }
 
 /// Extract all `SectionContext` values from a docstring.
-pub fn section_contexts<'a>(lines: &'a [&'a str]) -> Vec<SectionContext<'a>> {
+pub(crate) fn section_contexts<'a>(
+    lines: &'a [&'a str],
+    style: &SectionStyle,
+) -> Vec<SectionContext<'a>> {
     let suspected_section_indices: Vec<usize> = lines
         .iter()
         .enumerate()
         .filter_map(|(lineno, line)| {
-            if lineno > 0 && suspected_as_section(line) {
+            if lineno > 0 && suspected_as_section(line, style) {
                 Some(lineno)
             } else {
                 None
@@ -161,7 +64,7 @@ pub fn section_contexts<'a>(lines: &'a [&'a str]) -> Vec<SectionContext<'a>> {
     let mut contexts = vec![];
     for lineno in suspected_section_indices {
         let context = SectionContext {
-            section_name: leading_words(lines[lineno]),
+            section_name: helpers::leading_words(lines[lineno]),
             previous_line: lines[lineno - 1],
             line: lines[lineno],
             following_lines: &lines[lineno + 1..],
@@ -194,319 +97,3 @@ pub fn section_contexts<'a>(lines: &'a [&'a str]) -> Vec<SectionContext<'a>> {
     truncated_contexts.reverse();
     truncated_contexts
 }
-
-fn check_blanks_and_section_underline(
-    checker: &mut Checker,
-    definition: &Definition,
-    context: &SectionContext,
-) {
-    let docstring = definition
-        .docstring
-        .expect("Sections are only available for docstrings.");
-
-    let mut blank_lines_after_header = 0;
-    for line in context.following_lines {
-        if !line.trim().is_empty() {
-            break;
-        }
-        blank_lines_after_header += 1;
-    }
-
-    // Nothing but blank lines after the section header.
-    if blank_lines_after_header == context.following_lines.len() {
-        if checker.settings.enabled.contains(&CheckCode::D407) {
-            checker.add_check(Check::new(
-                CheckKind::DashedUnderlineAfterSection(context.section_name.to_string()),
-                range_for(docstring),
-            ));
-        }
-        if checker.settings.enabled.contains(&CheckCode::D414) {
-            checker.add_check(Check::new(
-                CheckKind::NonEmptySection(context.section_name.to_string()),
-                range_for(docstring),
-            ));
-        }
-        return;
-    }
-
-    let non_empty_line = context.following_lines[blank_lines_after_header];
-    let dash_line_found = non_empty_line
-        .chars()
-        .all(|char| char.is_whitespace() || char == '-');
-
-    if !dash_line_found {
-        if checker.settings.enabled.contains(&CheckCode::D407) {
-            checker.add_check(Check::new(
-                CheckKind::DashedUnderlineAfterSection(context.section_name.to_string()),
-                range_for(docstring),
-            ));
-        }
-        if blank_lines_after_header > 0 {
-            if checker.settings.enabled.contains(&CheckCode::D212) {
-                checker.add_check(Check::new(
-                    CheckKind::NoBlankLinesBetweenHeaderAndContent(
-                        context.section_name.to_string(),
-                    ),
-                    range_for(docstring),
-                ));
-            }
-        }
-    } else {
-        if blank_lines_after_header > 0 {
-            if checker.settings.enabled.contains(&CheckCode::D408) {
-                checker.add_check(Check::new(
-                    CheckKind::SectionUnderlineAfterName(context.section_name.to_string()),
-                    range_for(docstring),
-                ));
-            }
-        }
-
-        if non_empty_line
-            .trim()
-            .chars()
-            .filter(|char| *char == '-')
-            .count()
-            != context.section_name.len()
-        {
-            if checker.settings.enabled.contains(&CheckCode::D409) {
-                checker.add_check(Check::new(
-                    CheckKind::SectionUnderlineMatchesSectionLength(
-                        context.section_name.to_string(),
-                    ),
-                    range_for(docstring),
-                ));
-            }
-        }
-
-        if checker.settings.enabled.contains(&CheckCode::D215) {
-            if leading_space(non_empty_line).len() > indentation(checker, docstring).len() {
-                checker.add_check(Check::new(
-                    CheckKind::SectionUnderlineNotOverIndented(context.section_name.to_string()),
-                    range_for(docstring),
-                ));
-            }
-        }
-
-        let line_after_dashes_index = blank_lines_after_header + 1;
-
-        if line_after_dashes_index < context.following_lines.len() {
-            let line_after_dashes = context.following_lines[line_after_dashes_index];
-            if line_after_dashes.trim().is_empty() {
-                let rest_of_lines = &context.following_lines[line_after_dashes_index..];
-                if rest_of_lines.iter().all(|line| line.trim().is_empty()) {
-                    if checker.settings.enabled.contains(&CheckCode::D414) {
-                        checker.add_check(Check::new(
-                            CheckKind::NonEmptySection(context.section_name.to_string()),
-                            range_for(docstring),
-                        ));
-                    }
-                } else {
-                    if checker.settings.enabled.contains(&CheckCode::D412) {
-                        checker.add_check(Check::new(
-                            CheckKind::NoBlankLinesBetweenHeaderAndContent(
-                                context.section_name.to_string(),
-                            ),
-                            range_for(docstring),
-                        ));
-                    }
-                }
-            }
-        } else {
-            if checker.settings.enabled.contains(&CheckCode::D414) {
-                checker.add_check(Check::new(
-                    CheckKind::NonEmptySection(context.section_name.to_string()),
-                    range_for(docstring),
-                ));
-            }
-        }
-    }
-}
-
-fn check_common_section(checker: &mut Checker, definition: &Definition, context: &SectionContext) {
-    let docstring = definition
-        .docstring
-        .expect("Sections are only available for docstrings.");
-
-    if checker.settings.enabled.contains(&CheckCode::D405) {
-        if !NUMPY_SECTION_NAMES.contains(&context.section_name.as_str())
-            && NUMPY_SECTION_NAMES.contains(titlecase(&context.section_name).as_str())
-        {
-            checker.add_check(Check::new(
-                CheckKind::CapitalizeSectionName(context.section_name.to_string()),
-                range_for(docstring),
-            ))
-        }
-    }
-
-    if checker.settings.enabled.contains(&CheckCode::D214) {
-        if leading_space(context.line).len() > indentation(checker, docstring).len() {
-            checker.add_check(Check::new(
-                CheckKind::SectionNotOverIndented(context.section_name.to_string()),
-                range_for(docstring),
-            ))
-        }
-    }
-
-    if context
-        .following_lines
-        .last()
-        .map(|line| !line.trim().is_empty())
-        .unwrap_or(true)
-    {
-        if context.is_last_section {
-            if checker.settings.enabled.contains(&CheckCode::D413) {
-                checker.add_check(Check::new(
-                    CheckKind::BlankLineAfterLastSection(context.section_name.to_string()),
-                    range_for(docstring),
-                ))
-            }
-        } else {
-            if checker.settings.enabled.contains(&CheckCode::D410) {
-                checker.add_check(Check::new(
-                    CheckKind::BlankLineAfterSection(context.section_name.to_string()),
-                    range_for(docstring),
-                ))
-            }
-        }
-    }
-
-    if checker.settings.enabled.contains(&CheckCode::D411) {
-        if !context.previous_line.is_empty() {
-            checker.add_check(Check::new(
-                CheckKind::BlankLineBeforeSection(context.section_name.to_string()),
-                range_for(docstring),
-            ))
-        }
-    }
-}
-
-fn check_missing_args(
-    checker: &mut Checker,
-    definition: &Definition,
-    docstrings_args: BTreeSet<&str>,
-) {
-    if let DefinitionKind::Function(parent)
-    | DefinitionKind::NestedFunction(parent)
-    | DefinitionKind::Method(parent) = definition.kind
-    {
-        if let StmtKind::FunctionDef {
-            args: arguments, ..
-        }
-        | StmtKind::AsyncFunctionDef {
-            args: arguments, ..
-        } = &parent.node
-        {
-            // Collect all the arguments into a single vector.
-            let mut all_arguments: Vec<&Arg> = arguments
-                .args
-                .iter()
-                .chain(arguments.posonlyargs.iter())
-                .chain(arguments.kwonlyargs.iter())
-                .skip(
-                    // If this is a non-static method, skip `cls` or `self`.
-                    if matches!(definition.kind, DefinitionKind::Method(_)) && !is_static(parent) {
-                        1
-                    } else {
-                        0
-                    },
-                )
-                .collect();
-            if let Some(arg) = &arguments.vararg {
-                all_arguments.push(arg);
-            }
-            if let Some(arg) = &arguments.kwarg {
-                all_arguments.push(arg);
-            }
-
-            // Look for arguments that weren't included in the docstring.
-            let mut missing_args: BTreeSet<&str> = Default::default();
-            for arg in all_arguments {
-                let arg_name = arg.node.arg.as_str();
-                if arg_name.starts_with('_') {
-                    continue;
-                }
-                if docstrings_args.contains(&arg_name) {
-                    continue;
-                }
-                missing_args.insert(arg_name);
-            }
-
-            if !missing_args.is_empty() {
-                let names = missing_args
-                    .into_iter()
-                    .map(String::from)
-                    .sorted()
-                    .collect();
-                checker.add_check(Check::new(
-                    CheckKind::DocumentAllArguments(names),
-                    Range::from_located(parent),
-                ));
-            }
-        }
-    }
-}
-
-fn check_parameters_section(
-    checker: &mut Checker,
-    definition: &Definition,
-    context: &SectionContext,
-) {
-    // Collect the list of arguments documented in the docstring.
-    let mut docstring_args: BTreeSet<&str> = Default::default();
-    let section_level_indent = leading_space(context.line);
-    for i in 1..context.following_lines.len() {
-        let current_line = context.following_lines[i - 1];
-        let current_leading_space = leading_space(current_line);
-        let next_line = context.following_lines[i];
-        if current_leading_space == section_level_indent
-            && (leading_space(next_line).len() > current_leading_space.len())
-            && !next_line.trim().is_empty()
-        {
-            let parameters = if let Some(semi_index) = current_line.find(':') {
-                // If the parameter has a type annotation, exclude it.
-                &current_line[..semi_index]
-            } else {
-                // Otherwise, it's just a list of parameters on the current line.
-                current_line.trim()
-            };
-            // Notably, NumPy lets you put multiple parameters of the same type on the same line.
-            for parameter in parameters.split(',') {
-                docstring_args.insert(parameter.trim());
-            }
-        }
-    }
-    // Validate that all arguments were documented.
-    check_missing_args(checker, definition, docstring_args);
-}
-
-pub fn check_numpy_section(
-    checker: &mut Checker,
-    definition: &Definition,
-    context: &SectionContext,
-) {
-    check_common_section(checker, definition, context);
-    check_blanks_and_section_underline(checker, definition, context);
-
-    if checker.settings.enabled.contains(&CheckCode::D406) {
-        let suffix = context
-            .line
-            .trim()
-            .strip_prefix(&context.section_name)
-            .unwrap();
-        if !suffix.is_empty() {
-            let docstring = definition
-                .docstring
-                .expect("Sections are only available for docstrings.");
-            checker.add_check(Check::new(
-                CheckKind::NewLineAfterSectionName(context.section_name.to_string()),
-                range_for(docstring),
-            ))
-        }
-    }
-
-    if checker.settings.enabled.contains(&CheckCode::D417) {
-        if titlecase(&context.section_name) == "Parameters" {
-            check_parameters_section(checker, definition, context);
-        }
-    }
-}

src/docstrings/styles.rs

@@ -0,0 +1,27 @@
+use std::collections::BTreeSet;
+
+use once_cell::sync::Lazy;
+
+use crate::docstrings::google::{GOOGLE_SECTION_NAMES, LOWERCASE_GOOGLE_SECTION_NAMES};
+use crate::docstrings::numpy::{LOWERCASE_NUMPY_SECTION_NAMES, NUMPY_SECTION_NAMES};
+
+pub(crate) enum SectionStyle {
+    NumPy,
+    Google,
+}
+
+impl SectionStyle {
+    pub(crate) fn section_names(&self) -> &Lazy<BTreeSet<&'static str>> {
+        match self {
+            SectionStyle::NumPy => &NUMPY_SECTION_NAMES,
+            SectionStyle::Google => &GOOGLE_SECTION_NAMES,
+        }
+    }
+
+    pub(crate) fn lowercase_section_names(&self) -> &Lazy<BTreeSet<&'static str>> {
+        match self {
+            SectionStyle::NumPy => &LOWERCASE_NUMPY_SECTION_NAMES,
+            SectionStyle::Google => &LOWERCASE_GOOGLE_SECTION_NAMES,
+        }
+    }
+}

src/flake8_bugbear/mod.rs

@@ -0,0 +1 @@
+pub mod plugins;

src/flake8_bugbear/plugins/assert_false.rs

@@ -1,9 +1,9 @@
 use rustpython_ast::{Constant, Expr, ExprContext, ExprKind, Stmt, StmtKind};
 
 use crate::ast::types::Range;
-use crate::autofix::fixer;
+use crate::autofix::Fix;
 use crate::check_ast::Checker;
-use crate::checks::{Check, CheckKind, Fix};
+use crate::checks::{Check, CheckKind};
 use crate::code_gen::SourceGenerator;
 
 fn assertion_error(msg: &Option<Box<Expr>>) -> Stmt {
@@ -43,16 +43,15 @@ pub fn assert_false(checker: &mut Checker, stmt: &Stmt, test: &Expr, msg: &Optio
     } = &test.node
     {
         let mut check = Check::new(CheckKind::DoNotAssertFalse, Range::from_located(test));
-        if matches!(checker.autofix, fixer::Mode::Generate | fixer::Mode::Apply) {
+        if checker.patch() {
             let mut generator = SourceGenerator::new();
             if let Ok(()) = generator.unparse_stmt(&assertion_error(msg)) {
                 if let Ok(content) = generator.generate() {
-                    check.amend(Fix {
+                    check.amend(Fix::replacement(
                         content,
-                        location: stmt.location,
-                        end_location: stmt.end_location,
-                        applied: false,
-                    })
+                        stmt.location,
+                        stmt.end_location.unwrap(),
+                    ));
                 }
             }
         }

src/flake8_bugbear/plugins/assert_raises_exception.rs

@@ -0,0 +1,25 @@
+use rustpython_ast::{ExprKind, Stmt, Withitem};
+
+use crate::ast::helpers::match_name_or_attr;
+use crate::ast::types::Range;
+use crate::check_ast::Checker;
+use crate::checks::{Check, CheckKind};
+
+/// B017
+pub fn assert_raises_exception(checker: &mut Checker, stmt: &Stmt, items: &[Withitem]) {
+    if let Some(item) = items.first() {
+        let item_context = &item.context_expr;
+        if let ExprKind::Call { func, args, .. } = &item_context.node {
+            if match_name_or_attr(func, "assertRaises")
+                && args.len() == 1
+                && match_name_or_attr(args.first().unwrap(), "Exception")
+                && item.optional_vars.is_none()
+            {
+                checker.add_check(Check::new(
+                    CheckKind::NoAssertRaisesException,
+                    Range::from_located(stmt),
+                ));
+            }
+        }
+    }
+}

src/flake8_bugbear/plugins/duplicate_exceptions.rs

@@ -5,9 +5,9 @@ use rustpython_ast::{Excepthandler, ExcepthandlerKind, Expr, ExprContext, ExprKi
 
 use crate::ast::helpers;
 use crate::ast::types::{CheckLocator, Range};
-use crate::autofix::fixer;
+use crate::autofix::Fix;
 use crate::check_ast::Checker;
-use crate::checks::{Check, CheckCode, CheckKind, Fix};
+use crate::checks::{Check, CheckCode, CheckKind};
 use crate::code_gen::SourceGenerator;
 
 fn type_pattern(elts: Vec<&Expr>) -> Expr {
@@ -24,7 +24,7 @@ fn type_pattern(elts: Vec<&Expr>) -> Expr {
 pub fn duplicate_handler_exceptions(
     checker: &mut Checker,
     expr: &Expr,
-    elts: &Vec<Expr>,
+    elts: &[Expr],
 ) -> BTreeSet<String> {
     let mut seen: BTreeSet<String> = Default::default();
     let mut duplicates: BTreeSet<String> = Default::default();
@@ -49,17 +49,16 @@ pub fn duplicate_handler_exceptions(
                 ),
                 checker.locate_check(Range::from_located(expr)),
             );
-            if matches!(checker.autofix, fixer::Mode::Generate | fixer::Mode::Apply) {
+            if checker.patch() {
                 // TODO(charlie): If we have a single element, remove the tuple.
                 let mut generator = SourceGenerator::new();
                 if let Ok(()) = generator.unparse_expr(&type_pattern(unique_elts), 0) {
                     if let Ok(content) = generator.generate() {
-                        check.amend(Fix {
+                        check.amend(Fix::replacement(
                             content,
-                            location: expr.location,
-                            end_location: expr.end_location,
-                            applied: false,
-                        })
+                            expr.location,
+                            expr.end_location.unwrap(),
+                        ))
                     }
                 }
             }

src/flake8_bugbear/plugins/mod.rs

@@ -0,0 +1,14 @@
+pub use assert_false::assert_false;
+pub use assert_raises_exception::assert_raises_exception;
+pub use duplicate_exceptions::duplicate_exceptions;
+pub use duplicate_exceptions::duplicate_handler_exceptions;
+pub use redundant_tuple_in_exception_handler::redundant_tuple_in_exception_handler;
+pub use unary_prefix_increment::unary_prefix_increment;
+pub use unused_loop_control_variable::unused_loop_control_variable;
+
+mod assert_false;
+mod assert_raises_exception;
+mod duplicate_exceptions;
+mod redundant_tuple_in_exception_handler;
+mod unary_prefix_increment;
+mod unused_loop_control_variable;

src/flake8_bugbear/plugins/redundant_tuple_in_exception_handler.rs

@@ -0,0 +1,22 @@
+use rustpython_ast::{Excepthandler, ExcepthandlerKind, ExprKind};
+
+use crate::ast::types::{CheckLocator, Range};
+use crate::check_ast::Checker;
+use crate::checks::{Check, CheckKind};
+
+/// B013
+pub fn redundant_tuple_in_exception_handler(checker: &mut Checker, handlers: &[Excepthandler]) {
+    for handler in handlers {
+        let ExcepthandlerKind::ExceptHandler { type_, .. } = &handler.node;
+        if let Some(type_) = type_ {
+            if let ExprKind::Tuple { elts, .. } = &type_.node {
+                if elts.len() == 1 {
+                    checker.add_check(Check::new(
+                        CheckKind::RedundantTupleInExceptionHandler(elts[0].to_string()),
+                        checker.locate_check(Range::from_located(type_)),
+                    ));
+                }
+            }
+        }
+    }
+}

src/flake8_bugbear/plugins/unary_prefix_increment.rs

@@ -0,0 +1,19 @@
+use rustpython_ast::{Expr, ExprKind, Unaryop};
+
+use crate::ast::types::Range;
+use crate::check_ast::Checker;
+use crate::checks::{Check, CheckKind};
+
+/// B002
+pub fn unary_prefix_increment(checker: &mut Checker, expr: &Expr, op: &Unaryop, operand: &Expr) {
+    if matches!(op, Unaryop::UAdd) {
+        if let ExprKind::UnaryOp { op, .. } = &operand.node {
+            if matches!(op, Unaryop::UAdd) {
+                checker.add_check(Check::new(
+                    CheckKind::UnaryPrefixIncrement,
+                    Range::from_located(expr),
+                ))
+            }
+        }
+    }
+}

src/flake8_bugbear/plugins/unused_loop_control_variable.rs

@@ -0,0 +1,79 @@
+use std::collections::BTreeMap;
+
+use rustpython_ast::{Expr, ExprKind, Stmt};
+
+use crate::ast::types::Range;
+use crate::ast::visitor;
+use crate::ast::visitor::Visitor;
+use crate::autofix::Fix;
+use crate::check_ast::Checker;
+use crate::checks::{Check, CheckKind};
+
+/// Identify all `ExprKind::Name` nodes in an AST.
+struct NameFinder<'a> {
+    /// A map from identifier to defining expression.
+    names: BTreeMap<&'a str, &'a Expr>,
+}
+
+impl NameFinder<'_> {
+    fn new() -> Self {
+        NameFinder {
+            names: Default::default(),
+        }
+    }
+}
+
+impl<'a, 'b> Visitor<'b> for NameFinder<'a>
+where
+    'b: 'a,
+{
+    fn visit_expr(&mut self, expr: &'a Expr) {
+        if let ExprKind::Name { id, .. } = &expr.node {
+            self.names.insert(id, expr);
+        }
+        visitor::walk_expr(self, expr);
+    }
+}
+
+/// B007
+pub fn unused_loop_control_variable(checker: &mut Checker, target: &Expr, body: &[Stmt]) {
+    let control_names = {
+        let mut finder = NameFinder::new();
+        finder.visit_expr(target);
+        finder.names
+    };
+
+    let used_names = {
+        let mut finder = NameFinder::new();
+        for stmt in body {
+            finder.visit_stmt(stmt);
+        }
+        finder.names
+    };
+
+    for (name, expr) in control_names {
+        // Ignore names that are already underscore-prefixed.
+        if name.starts_with('_') {
+            continue;
+        }
+
+        // Ignore any names that are actually used in the loop body.
+        if used_names.contains_key(name) {
+            continue;
+        }
+
+        let mut check = Check::new(
+            CheckKind::UnusedLoopControlVariable(name.to_string()),
+            Range::from_located(expr),
+        );
+        if checker.patch() {
+            // Prefix the variable name with an underscore.
+            check.amend(Fix::replacement(
+                format!("_{name}"),
+                expr.location,
+                expr.end_location.unwrap(),
+            ))
+        }
+        checker.add_check(check);
+    }
+}

src/flake8_builtins/checks.rs

@@ -0,0 +1,20 @@
+use crate::ast::types::Range;
+use crate::checks::{Check, CheckKind};
+use crate::flake8_builtins::types::ShadowingType;
+use crate::python::builtins::BUILTINS;
+
+/// Check builtin name shadowing.
+pub fn builtin_shadowing(name: &str, location: Range, node_type: ShadowingType) -> Option<Check> {
+    if BUILTINS.contains(&name) {
+        Some(Check::new(
+            match node_type {
+                ShadowingType::Variable => CheckKind::BuiltinVariableShadowing(name.to_string()),
+                ShadowingType::Argument => CheckKind::BuiltinArgumentShadowing(name.to_string()),
+                ShadowingType::Attribute => CheckKind::BuiltinAttributeShadowing(name.to_string()),
+            },
+            location,
+        ))
+    } else {
+        None
+    }
+}

src/flake8_builtins/mod.rs

@@ -0,0 +1,2 @@
+pub mod checks;
+pub mod types;

src/flake8_builtins/types.rs

@@ -0,0 +1,5 @@
+pub enum ShadowingType {
+    Variable,
+    Argument,
+    Attribute,
+}

src/flake8_comprehensions/checks.rs

@@ -0,0 +1,387 @@
+use num_bigint::BigInt;
+use rustpython_ast::{Comprehension, Constant, Expr, ExprKind, KeywordData, Located, Unaryop};
+
+use crate::ast::types::Range;
+use crate::checks::{Check, CheckKind};
+
+fn function_name(func: &Expr) -> Option<&str> {
+    if let ExprKind::Name { id, .. } = &func.node {
+        Some(id)
+    } else {
+        None
+    }
+}
+
+fn exactly_one_argument_with_matching_function<'a>(
+    name: &str,
+    func: &Expr,
+    args: &'a [Expr],
+) -> Option<&'a ExprKind> {
+    if args.len() != 1 {
+        return None;
+    }
+    if function_name(func)? != name {
+        return None;
+    }
+    Some(&args[0].node)
+}
+
+fn first_argument_with_matching_function<'a>(
+    name: &str,
+    func: &Expr,
+    args: &'a [Expr],
+) -> Option<&'a ExprKind> {
+    if function_name(func)? != name {
+        return None;
+    }
+    Some(&args.first()?.node)
+}
+
+/// C400 (`list(generator)`)
+pub fn unnecessary_generator_list(expr: &Expr, func: &Expr, args: &[Expr]) -> Option<Check> {
+    let argument = exactly_one_argument_with_matching_function("list", func, args)?;
+    if let ExprKind::GeneratorExp { .. } = argument {
+        return Some(Check::new(
+            CheckKind::UnnecessaryGeneratorList,
+            Range::from_located(expr),
+        ));
+    }
+    None
+}
+
+/// C401 (`set(generator)`)
+pub fn unnecessary_generator_set(expr: &Expr, func: &Expr, args: &[Expr]) -> Option<Check> {
+    let argument = exactly_one_argument_with_matching_function("set", func, args)?;
+    if let ExprKind::GeneratorExp { .. } = argument {
+        return Some(Check::new(
+            CheckKind::UnnecessaryGeneratorSet,
+            Range::from_located(expr),
+        ));
+    }
+    None
+}
+
+/// C402 (`dict((x, y) for x, y in iterable)`)
+pub fn unnecessary_generator_dict(expr: &Expr, func: &Expr, args: &[Expr]) -> Option<Check> {
+    let argument = exactly_one_argument_with_matching_function("dict", func, args)?;
+    if let ExprKind::GeneratorExp { elt, .. } = argument {
+        match &elt.node {
+            ExprKind::Tuple { elts, .. } if elts.len() == 2 => {
+                return Some(Check::new(
+                    CheckKind::UnnecessaryGeneratorDict,
+                    Range::from_located(expr),
+                ));
+            }
+            _ => {}
+        }
+    }
+    None
+}
+
+/// C403 (`set([...])`)
+pub fn unnecessary_list_comprehension_set(
+    expr: &Expr,
+    func: &Expr,
+    args: &[Expr],
+) -> Option<Check> {
+    let argument = exactly_one_argument_with_matching_function("set", func, args)?;
+    if let ExprKind::ListComp { .. } = &argument {
+        return Some(Check::new(
+            CheckKind::UnnecessaryListComprehensionSet,
+            Range::from_located(expr),
+        ));
+    }
+    None
+}
+
+/// C404 (`dict([...])`)
+pub fn unnecessary_list_comprehension_dict(
+    expr: &Expr,
+    func: &Expr,
+    args: &[Expr],
+) -> Option<Check> {
+    let argument = exactly_one_argument_with_matching_function("dict", func, args)?;
+    if let ExprKind::ListComp { elt, .. } = &argument {
+        match &elt.node {
+            ExprKind::Tuple { elts, .. } if elts.len() == 2 => {
+                return Some(Check::new(
+                    CheckKind::UnnecessaryListComprehensionDict,
+                    Range::from_located(expr),
+                ));
+            }
+            _ => {}
+        }
+    }
+    None
+}
+
+/// C405 (`set([1, 2])`)
+pub fn unnecessary_literal_set(expr: &Expr, func: &Expr, args: &[Expr]) -> Option<Check> {
+    let argument = exactly_one_argument_with_matching_function("set", func, args)?;
+    let kind = match argument {
+        ExprKind::List { .. } => "list",
+        ExprKind::Tuple { .. } => "tuple",
+        _ => return None,
+    };
+    Some(Check::new(
+        CheckKind::UnnecessaryLiteralSet(kind.to_string()),
+        Range::from_located(expr),
+    ))
+}
+
+/// C406 (`dict([(1, 2)])`)
+pub fn unnecessary_literal_dict(expr: &Expr, func: &Expr, args: &[Expr]) -> Option<Check> {
+    let argument = exactly_one_argument_with_matching_function("dict", func, args)?;
+    let (kind, elts) = match argument {
+        ExprKind::Tuple { elts, .. } => ("tuple", elts),
+        ExprKind::List { elts, .. } => ("list", elts),
+        _ => return None,
+    };
+
+    if let Some(elt) = elts.first() {
+        // dict((1, 2), ...)) or dict([(1, 2), ...])
+        if !matches!(&elt.node, ExprKind::Tuple { elts, .. } if elts.len() == 2) {
+            return None;
+        }
+    }
+
+    Some(Check::new(
+        CheckKind::UnnecessaryLiteralDict(kind.to_string()),
+        Range::from_located(expr),
+    ))
+}
+
+/// C408
+pub fn unnecessary_collection_call(
+    expr: &Expr,
+    func: &Expr,
+    args: &[Expr],
+    keywords: &[Located<KeywordData>],
+) -> Option<Check> {
+    if !args.is_empty() {
+        return None;
+    }
+    let id = function_name(func)?;
+    match id {
+        "dict" if keywords.is_empty() || keywords.iter().all(|kw| kw.node.arg.is_some()) => (),
+        "list" | "tuple" => {
+            // list() or tuple()
+        }
+        _ => return None,
+    };
+    Some(Check::new(
+        CheckKind::UnnecessaryCollectionCall(id.to_string()),
+        Range::from_located(expr),
+    ))
+}
+
+/// C409
+pub fn unnecessary_literal_within_tuple_call(
+    expr: &Expr,
+    func: &Expr,
+    args: &[Expr],
+) -> Option<Check> {
+    let argument = first_argument_with_matching_function("tuple", func, args)?;
+    let argument_kind = match argument {
+        ExprKind::Tuple { .. } => "tuple",
+        ExprKind::List { .. } => "list",
+        _ => return None,
+    };
+    Some(Check::new(
+        CheckKind::UnnecessaryLiteralWithinTupleCall(argument_kind.to_string()),
+        Range::from_located(expr),
+    ))
+}
+
+/// C410
+pub fn unnecessary_literal_within_list_call(
+    expr: &Expr,
+    func: &Expr,
+    args: &[Expr],
+) -> Option<Check> {
+    let argument = first_argument_with_matching_function("list", func, args)?;
+    let argument_kind = match argument {
+        ExprKind::Tuple { .. } => "tuple",
+        ExprKind::List { .. } => "list",
+        _ => return None,
+    };
+    Some(Check::new(
+        CheckKind::UnnecessaryLiteralWithinListCall(argument_kind.to_string()),
+        Range::from_located(expr),
+    ))
+}
+
+/// C411
+pub fn unnecessary_list_call(expr: &Expr, func: &Expr, args: &[Expr]) -> Option<Check> {
+    let argument = first_argument_with_matching_function("list", func, args)?;
+    if let ExprKind::ListComp { .. } = argument {
+        return Some(Check::new(
+            CheckKind::UnnecessaryListCall,
+            Range::from_located(expr),
+        ));
+    }
+    None
+}
+
+/// C413
+pub fn unnecessary_call_around_sorted(expr: &Expr, func: &Expr, args: &[Expr]) -> Option<Check> {
+    let outer = function_name(func)?;
+    if !(outer == "list" || outer == "reversed") {
+        return None;
+    }
+    if let ExprKind::Call { func, .. } = &args.first()?.node {
+        if function_name(func)? == "sorted" {
+            return Some(Check::new(
+                CheckKind::UnnecessaryCallAroundSorted(outer.to_string()),
+                Range::from_located(expr),
+            ));
+        }
+    }
+    None
+}
+
+/// C414
+pub fn unnecessary_double_cast_or_process(
+    expr: &Expr,
+    func: &Expr,
+    args: &[Expr],
+) -> Option<Check> {
+    let outer = function_name(func)?;
+    if !["list", "tuple", "set", "reversed", "sorted"].contains(&outer) {
+        return None;
+    }
+
+    fn new_check(inner: &str, outer: &str, expr: &Expr) -> Check {
+        Check::new(
+            CheckKind::UnnecessaryDoubleCastOrProcess(inner.to_string(), outer.to_string()),
+            Range::from_located(expr),
+        )
+    }
+
+    if let ExprKind::Call { func, .. } = &args.first()?.node {
+        let inner = function_name(func)?;
+        // Ex) set(tuple(...))
+        if (outer == "set" || outer == "sorted")
+            && (inner == "list" || inner == "tuple" || inner == "reversed" || inner == "sorted")
+        {
+            return Some(new_check(inner, outer, expr));
+        }
+
+        // Ex) list(tuple(...))
+        if (outer == "list" || outer == "tuple") && (inner == "list" || inner == "tuple") {
+            return Some(new_check(inner, outer, expr));
+        }
+
+        // Ex) set(set(...))
+        if outer == "set" && inner == "set" {
+            return Some(new_check(inner, outer, expr));
+        }
+    }
+    None
+}
+
+/// C415
+pub fn unnecessary_subscript_reversal(expr: &Expr, func: &Expr, args: &[Expr]) -> Option<Check> {
+    let first_arg = args.first()?;
+    let id = function_name(func)?;
+    if !["set", "sorted", "reversed"].contains(&id) {
+        return None;
+    }
+    if let ExprKind::Subscript { slice, .. } = &first_arg.node {
+        if let ExprKind::Slice { lower, upper, step } = &slice.node {
+            if lower.is_none() && upper.is_none() {
+                if let Some(step) = step {
+                    if let ExprKind::UnaryOp {
+                        op: Unaryop::USub,
+                        operand,
+                    } = &step.node
+                    {
+                        if let ExprKind::Constant {
+                            value: Constant::Int(val),
+                            ..
+                        } = &operand.node
+                        {
+                            if *val == BigInt::from(1) {
+                                return Some(Check::new(
+                                    CheckKind::UnnecessarySubscriptReversal(id.to_string()),
+                                    Range::from_located(expr),
+                                ));
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    }
+    None
+}
+
+/// C416
+pub fn unnecessary_comprehension(
+    expr: &Expr,
+    elt: &Expr,
+    generators: &[Comprehension],
+) -> Option<Check> {
+    if generators.len() != 1 {
+        return None;
+    }
+    let generator = &generators[0];
+    if !(generator.ifs.is_empty() && generator.is_async == 0) {
+        return None;
+    }
+    let elt_id = function_name(elt)?;
+    let target_id = function_name(&generator.target)?;
+    if elt_id != target_id {
+        return None;
+    }
+    let expr_kind = match &expr.node {
+        ExprKind::ListComp { .. } => "list",
+        ExprKind::SetComp { .. } => "set",
+        _ => return None,
+    };
+    Some(Check::new(
+        CheckKind::UnnecessaryComprehension(expr_kind.to_string()),
+        Range::from_located(expr),
+    ))
+}
+
+/// C417
+pub fn unnecessary_map(expr: &Expr, func: &Expr, args: &[Expr]) -> Option<Check> {
+    fn new_check(kind: &str, expr: &Expr) -> Check {
+        Check::new(
+            CheckKind::UnnecessaryMap(kind.to_string()),
+            Range::from_located(expr),
+        )
+    }
+    let id = function_name(func)?;
+    match id {
+        "map" => {
+            if args.len() == 2 && matches!(&args[0].node, ExprKind::Lambda { .. }) {
+                return Some(new_check("generator", expr));
+            }
+        }
+        "list" | "set" => {
+            if let ExprKind::Call { func, args, .. } = &args.first()?.node {
+                let argument = first_argument_with_matching_function("map", func, args)?;
+                if let ExprKind::Lambda { .. } = argument {
+                    return Some(new_check(id, expr));
+                }
+            }
+        }
+        "dict" => {
+            if args.len() == 1 {
+                if let ExprKind::Call { func, args, .. } = &args[0].node {
+                    let argument = first_argument_with_matching_function("map", func, args)?;
+                    if let ExprKind::Lambda { body, .. } = &argument {
+                        if matches!(&body.node, ExprKind::Tuple { elts, .. } | ExprKind::List { elts, .. } if elts.len() == 2)
+                        {
+                            return Some(new_check(id, expr));
+                        }
+                    }
+                }
+            }
+        }
+        _ => (),
+    }
+    None
+}

src/flake8_comprehensions/mod.rs

@@ -0,0 +1 @@
+pub mod checks;

src/flake8_print/checks.rs

@@ -0,0 +1,36 @@
+use rustpython_ast::{Expr, ExprKind};
+
+use crate::ast::types::Range;
+use crate::checks::{Check, CheckKind};
+
+/// Check whether a function call is a `print` or `pprint` invocation
+pub fn print_call(
+    expr: &Expr,
+    func: &Expr,
+    check_print: bool,
+    check_pprint: bool,
+) -> Option<Check> {
+    if let ExprKind::Name { id, .. } = &func.node {
+        if check_print && id == "print" {
+            return Some(Check::new(CheckKind::PrintFound, Range::from_located(expr)));
+        } else if check_pprint && id == "pprint" {
+            return Some(Check::new(
+                CheckKind::PPrintFound,
+                Range::from_located(expr),
+            ));
+        }
+    }
+
+    if let ExprKind::Attribute { value, attr, .. } = &func.node {
+        if let ExprKind::Name { id, .. } = &value.node {
+            if check_pprint && id == "pprint" && attr == "pprint" {
+                return Some(Check::new(
+                    CheckKind::PPrintFound,
+                    Range::from_located(expr),
+                ));
+            }
+        }
+    }
+
+    None
+}

src/flake8_print/mod.rs

@@ -0,0 +1,2 @@
+mod checks;
+pub mod plugins;