PyCQA / PyCQA/flake8-pyi

Improve error message for chained comparisons

Open
#108 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type-refactoring
Dominant language
Python
Stars
83
Forks
22
PR merge metrics
No merged PRs in 30d

Description

We currently have a very specific test for chained comparisons on lines 506-508:

https://github.com/PyCQA/flake8-pyi/blob/34c17bd7d847905aacf4705dfc95e25ab12ce432/pyi.py#L506-L508

However, we then give a generic error message:

"Y002 If test must be a simple comparison against sys.platform or sys.version_info"

If we split this off into its own error code, we could give a much more specific error message:

YXXX Chained comparisons are not supported by type-checkers

Thoughts?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at pyi.py lines 506-508 and trace how the chained-comparison case currently produces Y002. Define the separate error-code behavior and verify that the chained-comparison test now reports the specific message while the existing generic cases remain covered.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.