astral-sh/ruff

Auto-fix for SIM103 could be improved or add a new SIM rule?

Open

#6,184 opened on Jul 31, 2023

View on GitHub
 (10 comments) (0 reactions) (0 assignees)Rust (2,088 forks)batch import
acceptedhelp wantedrule

Repository metrics

Stars
 (47,527 stars)
PR merge metrics
 (Avg merge 3d 8h) (573 merged PRs in 30d)

Description

I came across this code on a project:

if not condition_a and condition_b:
    return True
elif condition_a and condition_b:
    return True
else:
    return False

condition_a is redundant and this entire snippet should be simplified to:

return bool(condition_b)

However, this is what ruff produced using ruff --select="SIM103" example.py --fix --isolated:

if not condition_a and condition_b:
  return True
return bool(condition_a and condition_b)

I think this is correct reading the rule docs but I thought there could be some improvement here either within this rule or a new rule.

Ruff version is 0.0.280 and config:

[tool.ruff]
line-length = 120
select = [
  "D3",  # pydocstyle
  "D40", # pydocstyle
  "DTZ", # flake8-datetimez
  "FLY", # flynt
  "I",   # isort
  "INT", # flake8-gettext
  "PIE", # flake8-pie
  "PLC", # pylint
  "PLE", # pylint
  "RSE", # flake8-raise
  "SIM2", # flake8-simplify
  "SIM3", # flake8-simplify
  "TCH", # flake8-type-checking
  "W",   # pycodestyle
  "YTT", # flake8-2020
]
target-version = "py37"

Contributor guide

Research direction
Understand the current SIM103 implementation in Ruff's source code, identify the pattern where an if elif else returns True for both branches and False otherwise, and extend the rule to simplify to `return bool(condition)`.
Tech stack
pythonrust
Domain
tooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonRustGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60