astral-sh/ruff

`N999` (`invalid-module-name`) mixes correctness and stylistic recommendations

Open

#12,475 opened on Jul 23, 2024

View on GitHubContributor guide
 (11 comments) (2 reactions) (0 assignees)Rust (2,088 forks)batch import
help wantedrule

Repository metrics

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

Description

Not only does rule N999 check that the PEP8 convention is respected, but also checks that the module name is syntactically correct. The latter is not part of PEP8. This is a problem for me currently working on "old non linted" code. I have to ignore this rule because of some modules whose names are syntactically correct but sometimes with capital letters. I think a E rule is missing that would only include the syntax checking of N999. (If I were you I would also remove that part from N999 for consistency)

Contributor guide

Research direction
Examine the N999 rule implementation in Ruff, understand how it combines PEP8 style checks with module name syntax validation, and research how to create a separate E rule for syntax checking.
Tech stack
rustpython
Domain
clideveloper experience
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-2 days
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
RustPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60