astral-sh/ruff

INP001 false positive in tests folder

Open

#6,474 opened on Aug 10, 2023

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

Description

The recommended Python + Pytest layout is

  • src/
    • mypkg/
      • __init__.py
      • subpkg/
        • __init__.py
  • tests/
    • test_thing.py
    • test_more/
      • test_other_thing.py

Notably, tests and all files under it aren’t packages. The recommended import mode enforces that you can’t import from them.

Therefore INP001 shouldn’t trigger when tests is on top level of the project.

In fact, it would be great to have both a rule that enforces the opposite and to ensure that tests/**/test_*.py files don’t import things from each other.

Contributor guide

Tech stack
pythonrust
Domain
tooling
Issue type
bug
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 linter architectureUnderstanding of Python packaging and pytest layout
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Examine the implementation of rule INP001 in Ruff's source code, likely in `crates/ruff/src/rules/flake8 copyright.py` or similar rules. The issue suggests that `tests/` directories should be excluded from the rule. A fix would involve modifying the rule's logic to skip paths that are in a `tests` directory at the top level. Check existing tests for INP001 to understand expected behavior. The discussion in the issue may provide additional context on desired behavior.
INP001 false positive in tests folder · astral-sh/ruff#6474 | Good First Issue