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 (4,978 stars) (1,059 forks)batch import
Enhancement ✨Good first issueHacktoberfestHelp wanted 🙏Needs PRNeeds investigation 🔬

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

Tech stack
python
Domain
toolingdeveloper 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.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
PythonPEP 8 knowledgePylint internals
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
Review the existing implementation for a similar check in issue #965. Examine the pylint source code in 'pylint/checkers' to find where module level dunders are handled. Understand how to detect dunders below imports following PEP 8 guidelines. Consider how to add a new warning message and integrate it into the checker.