Switch from flake8 to ruff.

andialbrecht · andialbrecht · commit 8efa3935de40 · 2026-05-21T14:07:17.000+02:00
diff --git a/.flake8 b/.flake8
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -4,7 +4,7 @@ Before submitting your pull request please have a look at the
 following checklist:
 
 - [ ] ran the tests (`pytest`)
-- [ ] all style issues addressed (`flake8`)
+- [ ] all style issues addressed (`ruff`)
 - [ ] your changes are covered by tests
 - [ ] your changes are documented, if needed
 
diff --git a/.github/workflows/python-app.yml b/.github/workflows/python-app.yml
@@ -53,7 +53,7 @@ jobs:
 
     - name: Run lint (Python 3.11 only)
       if: matrix.python-version == '3.11' && matrix.os == 'ubuntu-latest'
-      run: uv run --group dev flake8 sqlparse/
+      run: uv run --group dev ruff check sqlparse/
 
     - name: Generate coverage report (Python 3.11 only)
       if: matrix.python-version == '3.11' && matrix.os == 'ubuntu-latest'
diff --git a/AGENTS.md b/AGENTS.md
@@ -18,7 +18,7 @@ This project uses `uv` for dependency and environment management. Common command
 - Using Makefile: `make test`
 
 ### Linting
-- `uv run --group dev flake8 sqlparse/` or `make lint`
+- `uv run --group dev ruff check sqlparse/` or `make lint`
 
 ### Coverage
 - `make coverage` (runs tests with coverage and shows report)
diff --git a/Makefile b/Makefile
@@ -19,7 +19,7 @@ test:
 	uv run --group dev --python 3.14 pytest tests/
 
 lint:
-	uv run --group dev flake8 sqlparse/
+	uv run --group dev ruff check sqlparse/
 
 coverage:
 	uv run --group dev coverage run -m pytest tests/
diff --git a/pyproject.toml b/pyproject.toml
@@ -73,8 +73,44 @@ exclude_lines = [
 dev = [
     "pytest",
     "coverage",
-    "flake8",
+    "ruff",
     "build",
     "sphinx",
 ]
 
+[tool.ruff]
+target-version = "py38"
+exclude = [
+    "dist",
+    "docs",
+    "tests",
+]
+
+[tool.ruff.lint]
+select = [
+    "E",    # pycodestyle errors
+    "F",    # Pyflakes
+    "W",    # pycodestyle warnings
+    "C90",  # mccabe complexity
+    "B",    # flake8-bugbear (bugs/design issues)
+    "I",    # isort (import sorting)
+    "UP",   # pyupgrade (modern python syntax)
+    "SIM",  # flake8-simplify (simpler code)
+    "RUF",  # Ruff-specific rules
+]
+ignore = [
+    "RUF001",  # Ambiguous unicode character (acute accent is used intentionally for quoting)
+    "RUF012",  # Mutable default value for class attribute (used for SQL matching patterns)
+    "B904",    # raise ... from ... (not required for simple custom exceptions)
+    "E501",    # Line too long (managed by formatting choices rather than strict rules)
+    "SIM108",  # Use ternary operator instead of if-else block (traditional if-else is preferred for readability)
+    "RUF005",  # Consider iterable unpacking instead of concatenation
+    "RUF059",  # Unused unpacked variables (retains standard unpacking signatures)
+    "SIM102",  # Nested if statements (sometimes preferred for logic separation)
+    "SIM115",  # Use a context manager for opening files (CLI streams are opened dynamically)
+]
+
+[tool.ruff.lint.mccabe]
+max-complexity = 31
+
+
diff --git a/sqlparse/__init__.py b/sqlparse/__init__.py
@@ -8,18 +8,12 @@
 """Parse SQL statements."""
 
 # Setup namespace
-from typing import Any, Generator, IO, List, Optional, Tuple, Union
-
-from sqlparse import sql
-from sqlparse import cli
-from sqlparse import engine
-from sqlparse import tokens
-from sqlparse import filters
-from sqlparse import formatter
+from typing import IO, Any, Generator, List, Optional, Tuple, Union
 
+from sqlparse import cli, engine, filters, formatter, sql, tokens
 
 __version__ = "0.5.6.dev0"
-__all__ = ["engine", "filters", "formatter", "sql", "tokens", "cli"]
+__all__ = ["cli", "engine", "filters", "formatter", "sql", "tokens"]
 
 
 def parse(
diff --git a/sqlparse/engine/__init__.py b/sqlparse/engine/__init__.py
@@ -10,7 +10,7 @@
 from sqlparse.engine.statement_splitter import StatementSplitter
 
 __all__ = [
-    'grouping',
     'FilterStack',
     'StatementSplitter',
+    'grouping',
 ]
diff --git a/sqlparse/engine/grouping.py b/sqlparse/engine/grouping.py
@@ -8,7 +8,7 @@
 from sqlparse import sql
 from sqlparse import tokens as T
 from sqlparse.exceptions import SQLParseError
-from sqlparse.utils import recurse, imt
+from sqlparse.utils import imt, recurse
 
 # Maximum recursion depth for grouping operations to prevent DoS attacks
 # Set to None to disable limit (not recommended for untrusted input)
@@ -234,12 +234,7 @@ def match(token):
         return token.ttype == T.Operator.Comparison
 
     def valid(token):
-        if imt(token, t=ttypes, i=sqlcls):
-            return True
-        elif token and token.is_keyword and token.normalized == 'NULL':
-            return True
-        else:
-            return False
+        return bool(imt(token, t=ttypes, i=sqlcls) or (token and token.is_keyword and token.normalized == 'NULL'))
 
     def post(tlist, pidx, tidx, nidx):
         return pidx, nidx
diff --git a/sqlparse/engine/statement_splitter.py b/sqlparse/engine/statement_splitter.py
@@ -5,7 +5,8 @@
 # This module is part of python-sqlparse and is released under
 # the BSD License: https://opensource.org/licenses/BSD-3-Clause
 
-from sqlparse import sql, tokens as T
+from sqlparse import sql
+from sqlparse import tokens as T
 
 
 class StatementSplitter:
diff --git a/sqlparse/filters/__init__.py b/sqlparse/filters/__init__.py
@@ -5,38 +5,35 @@
 # This module is part of python-sqlparse and is released under
 # the BSD License: https://opensource.org/licenses/BSD-3-Clause
 
-from sqlparse.filters.others import SerializerUnicode
-from sqlparse.filters.others import StripCommentsFilter
-from sqlparse.filters.others import StripWhitespaceFilter
-from sqlparse.filters.others import StripTrailingSemicolonFilter
-from sqlparse.filters.others import SpacesAroundOperatorsFilter
-
-from sqlparse.filters.output import OutputPHPFilter
-from sqlparse.filters.output import OutputPythonFilter
-
-from sqlparse.filters.tokens import KeywordCaseFilter
-from sqlparse.filters.tokens import IdentifierCaseFilter
-from sqlparse.filters.tokens import TruncateStringFilter
-
+from sqlparse.filters.aligned_indent import AlignedIndentFilter
+from sqlparse.filters.others import (
+    SerializerUnicode,
+    SpacesAroundOperatorsFilter,
+    StripCommentsFilter,
+    StripTrailingSemicolonFilter,
+    StripWhitespaceFilter,
+)
+from sqlparse.filters.output import OutputPHPFilter, OutputPythonFilter
 from sqlparse.filters.reindent import ReindentFilter
 from sqlparse.filters.right_margin import RightMarginFilter
-from sqlparse.filters.aligned_indent import AlignedIndentFilter
+from sqlparse.filters.tokens import (
+    IdentifierCaseFilter,
+    KeywordCaseFilter,
+    TruncateStringFilter,
+)
 
 __all__ = [
-    'SerializerUnicode',
-    'StripCommentsFilter',
-    'StripWhitespaceFilter',
-    'StripTrailingSemicolonFilter',
-    'SpacesAroundOperatorsFilter',
-
+    'AlignedIndentFilter',
+    'IdentifierCaseFilter',
+    'KeywordCaseFilter',
     'OutputPHPFilter',
     'OutputPythonFilter',
-
-    'KeywordCaseFilter',
-    'IdentifierCaseFilter',
-    'TruncateStringFilter',
-
     'ReindentFilter',
     'RightMarginFilter',
-    'AlignedIndentFilter',
+    'SerializerUnicode',
+    'SpacesAroundOperatorsFilter',
+    'StripCommentsFilter',
+    'StripTrailingSemicolonFilter',
+    'StripWhitespaceFilter',
+    'TruncateStringFilter',
 ]
diff --git a/sqlparse/filters/aligned_indent.py b/sqlparse/filters/aligned_indent.py
@@ -5,8 +5,9 @@
 # This module is part of python-sqlparse and is released under
 # the BSD License: https://opensource.org/licenses/BSD-3-Clause
 
-from sqlparse import sql, tokens as T
-from sqlparse.utils import offset, indent
+from sqlparse import sql
+from sqlparse import tokens as T
+from sqlparse.utils import indent, offset
 
 
 class AlignedIndentFilter:
diff --git a/sqlparse/filters/others.py b/sqlparse/filters/others.py
@@ -7,7 +7,8 @@
 
 import re
 
-from sqlparse import sql, tokens as T
+from sqlparse import sql
+from sqlparse import tokens as T
 from sqlparse.utils import split_unquoted_newlines
 
 
diff --git a/sqlparse/filters/output.py b/sqlparse/filters/output.py
@@ -5,7 +5,8 @@
 # This module is part of python-sqlparse and is released under
 # the BSD License: https://opensource.org/licenses/BSD-3-Clause
 
-from sqlparse import sql, tokens as T
+from sqlparse import sql
+from sqlparse import tokens as T
 
 
 class OutputFilter:
@@ -21,7 +22,7 @@ def _process(self, stream, varname, has_nl):
     def process(self, stmt):
         self.count += 1
         if self.count > 1:
-            varname = '{f.varname}{f.count}'.format(f=self)
+            varname = f'{self.varname}{self.count}'
         else:
             varname = self.varname
 
diff --git a/sqlparse/filters/reindent.py b/sqlparse/filters/reindent.py
@@ -5,8 +5,9 @@
 # This module is part of python-sqlparse and is released under
 # the BSD License: https://opensource.org/licenses/BSD-3-Clause
 
-from sqlparse import sql, tokens as T
-from sqlparse.utils import offset, indent
+from sqlparse import sql
+from sqlparse import tokens as T
+from sqlparse.utils import indent, offset
 
 
 class ReindentFilter:
diff --git a/sqlparse/filters/right_margin.py b/sqlparse/filters/right_margin.py
@@ -7,7 +7,8 @@
 
 import re
 
-from sqlparse import sql, tokens as T
+from sqlparse import sql
+from sqlparse import tokens as T
 
 
 # FIXME: Doesn't work
diff --git a/sqlparse/formatter.py b/sqlparse/formatter.py
@@ -11,83 +11,83 @@
 from sqlparse.exceptions import SQLParseError
 
 
-def validate_options(options):  # noqa: C901
+def validate_options(options):
     """Validates options."""
     kwcase = options.get('keyword_case')
     if kwcase not in [None, 'upper', 'lower', 'capitalize']:
         raise SQLParseError('Invalid value for keyword_case: '
-                            '{!r}'.format(kwcase))
+                            f'{kwcase!r}')
 
     idcase = options.get('identifier_case')
     if idcase not in [None, 'upper', 'lower', 'capitalize']:
         raise SQLParseError('Invalid value for identifier_case: '
-                            '{!r}'.format(idcase))
+                            f'{idcase!r}')
 
     ofrmt = options.get('output_format')
     if ofrmt not in [None, 'sql', 'python', 'php']:
         raise SQLParseError('Unknown output format: '
-                            '{!r}'.format(ofrmt))
+                            f'{ofrmt!r}')
 
     strip_comments = options.get('strip_comments', False)
     if strip_comments not in [True, False]:
         raise SQLParseError('Invalid value for strip_comments: '
-                            '{!r}'.format(strip_comments))
+                            f'{strip_comments!r}')
 
     space_around_operators = options.get('use_space_around_operators', False)
     if space_around_operators not in [True, False]:
         raise SQLParseError('Invalid value for use_space_around_operators: '
-                            '{!r}'.format(space_around_operators))
+                            f'{space_around_operators!r}')
 
     strip_ws = options.get('strip_whitespace', False)
     if strip_ws not in [True, False]:
         raise SQLParseError('Invalid value for strip_whitespace: '
-                            '{!r}'.format(strip_ws))
+                            f'{strip_ws!r}')
 
     truncate_strings = options.get('truncate_strings')
     if truncate_strings is not None:
         try:
             truncate_strings = int(truncate_strings)
         except (ValueError, TypeError):
             raise SQLParseError('Invalid value for truncate_strings: '
-                                '{!r}'.format(truncate_strings))
+                                f'{truncate_strings!r}')
         if truncate_strings <= 1:
             raise SQLParseError('Invalid value for truncate_strings: '
-                                '{!r}'.format(truncate_strings))
+                                f'{truncate_strings!r}')
         options['truncate_strings'] = truncate_strings
         options['truncate_char'] = options.get('truncate_char', '[...]')
 
     indent_columns = options.get('indent_columns', False)
     if indent_columns not in [True, False]:
         raise SQLParseError('Invalid value for indent_columns: '
-                            '{!r}'.format(indent_columns))
+                            f'{indent_columns!r}')
     elif indent_columns:
         options['reindent'] = True  # enforce reindent
     options['indent_columns'] = indent_columns
 
     reindent = options.get('reindent', False)
     if reindent not in [True, False]:
         raise SQLParseError('Invalid value for reindent: '
-                            '{!r}'.format(reindent))
+                            f'{reindent!r}')
     elif reindent:
         options['strip_whitespace'] = True
 
     reindent_aligned = options.get('reindent_aligned', False)
     if reindent_aligned not in [True, False]:
         raise SQLParseError('Invalid value for reindent_aligned: '
-                            '{!r}'.format(reindent))
+                            f'{reindent!r}')
     elif reindent_aligned:
         options['strip_whitespace'] = True
 
     indent_after_first = options.get('indent_after_first', False)
     if indent_after_first not in [True, False]:
         raise SQLParseError('Invalid value for indent_after_first: '
-                            '{!r}'.format(indent_after_first))
+                            f'{indent_after_first!r}')
     options['indent_after_first'] = indent_after_first
 
     indent_tabs = options.get('indent_tabs', False)
     if indent_tabs not in [True, False]:
         raise SQLParseError('Invalid value for indent_tabs: '
-                            '{!r}'.format(indent_tabs))
+                            f'{indent_tabs!r}')
     elif indent_tabs:
         options['indent_char'] = '\t'
     else:
diff --git a/sqlparse/lexer.py b/sqlparse/lexer.py
diff --git a/sqlparse/sql.py b/sqlparse/sql.py
diff --git a/uv.lock b/uv.lock

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`	`from sqlparse.engine.statement_splitter import StatementSplitter`
`11`	`11`
`12`	`12`	`__all__ = [`
`13`		`- 'grouping',`
`14`	`13`	`'FilterStack',`
`15`	`14`	`'StatementSplitter',`
	`15`	`+ 'grouping',`
`16`	`16`	`]`