PyCQA/pycodestyle

E126: asks for less indent on one-line protocol functions

Open

#956 opened on Aug 5, 2020

View on GitHub
 (1 comment) (1 reaction) (0 assignees)Python (809 forks)batch import
help wantedneeds patchneeds test

Repository metrics

Stars
 (4,941 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

from typing import Protocol


class _LongPollProtocol(Protocol):
    def __call__(
            self,
            foo: str,
            bar: int,
    ) -> int: ...

running pycodestyle on this yields:

$ ~/opt/venv/bin/pycodestyle --version
2.6.0
$ ~/opt/venv/bin/pycodestyle t.py --ignore=E704
t.py:6:13: E126 continuation line over-indented for hanging indent

but interestingly, this indentation is ok if I move the Ellipsis to the next line

from typing import Protocol


class _LongPollProtocol(Protocol):
    def __call__(
            self,
            foo: str,
            bar: int,
    ) -> int:
        ...

I intentionally want to indent the arguments two indents to differentiate between the body of code

Contributor guide

Research direction
Examine pycodestyle's handling of E126 for function signatures in one line protocol classes. Compare indentation logic between a one line protocol function and a multi line body version. Identify where the tokenizer or indentation check fails to differentiate the hanging indent.
Tech stack
python
Domain
toolingdevtools
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPythonbasic understanding of linting/parsing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65