pylint-dev/pylint

Warn if module dunders are below imports

Open

#5,471 opened on Dec 4, 2021

View on GitHub
 (9 comments) (1 reaction) (0 assignees)Python (1,059 forks)batch import
Enhancement ✨Good first issueHacktoberfestHelp wanted 🙏Needs PRNeeds investigation 🔬

Repository metrics

Stars
 (4,978 stars)
PR merge metrics
 (Avg merge 12h 9m) (29 merged PRs in 30d)

Description

Current problem

The PEP-8 guidelines state that module level dunders are supposed to be above imports. This is something pylint does not warn about if the code does not follow it.

Desired solution

Pylint should raise a warning if the above is not followed.

Additional context

Similar to #965, but also add a warning for it

Contributor guide

Research direction
Examine PEP 8 section on module level dunder names, review existing similar checks like #965, and implement a new check that warns when module dunders appear below imports.
Tech stack
python
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-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
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60