astral-sh/ruff

Avoid raising S310 if user explicitly checks for URL scheme

Open

#7,918 opened on Oct 11, 2023

View on GitHub
 (13 comments) (11 reactions) (0 assignees)Rust (47,527 stars) (2,088 forks)batch import
help wantedrule

Description

  • A minimal code snippet that reproduces the bug.
import urllib.request


def foo(url: str) -> None:
    if not url.startswith(("https://", "http://")):
        raise ValueError
    req = urllib.request.Request(
        url,
        headers=headers,
        data=data,
        method=method,
    )
    resp = urllib.request.urlopen(req)

Also it would be great if ruff could recognize asserts (like assert url.startswith(("https://", "http://")))

  • The command you invoked (e.g., ruff /path/to/file.py --fix), ideally including the --isolated flag.

ruff --isolated --select S t.py

  • The current Ruff settings (any relevant sections from your pyproject.toml).

No pyproject.toml

  • The current Ruff version (ruff --version).

ruff 0.0.292

Contributor guide

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.
1-3 hours
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
Familiarity with Ruff's internalsUnderstanding of Python ASTKnowledge of S310 rule logic
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
Examine the Ruff source code for the S310 rule implementation, likely in a file under `crates/ruff linter/src/rules/` or similar. The issue comments suggest that the check for URL scheme should be respected; look at how other rules handle similar conditions (e.g., see PR #7820 for related changes). The goal is to modify the S310 rule to skip raising when an explicit URL scheme check (like `startswith` or `assert`) is present before the `urlopen` call.