Pylint unnecessary pass statement for abstract method

Question

I have an abstract method which just includes a pass statement, as the method implementation is in another class that inherits from this abstract class. Here is the method:

@abstractmethod
def parse_sun_times(self, times_as_strings: Dict[str, str]) -> SunTimes:
    """
    Parses a dictionary of time strings into a SunTimes object.

    Args:
        times_as_strings (Dict[str, str]): A dictionary containing time strings as values and
        sun phases as keys

    Returns:
        SunTimes: An object representing parsed sunrise, sunset, and twilight times.
    """
    pass

Pylint is giving the warning "unnecessary pass statement". Is there some way I can signify to pylint that this is an abstract method, or do I just have to disable the warning manually?

Does the same error occur if you use ... instead of pass? — Alex Duchnowski
– Alex Duchnowski, Commented Nov 22, 2024 at 17:41
The docs appear to assume you already have a docstring as the first element after the signature (which would explain the recommendation to simply remove it, definition would still be syntactically complete) — Mathias R. Jessen
– Mathias R. Jessen, Commented Nov 22, 2024 at 17:50
And I presume that the pylint warning only comes when you have that docstring. I can't believe it would recommend invalid syntax. — Barmar
– Barmar, Commented Nov 22, 2024 at 17:52
Yes, this is correct! Removing the docstring removed the warning, and vice versa with the pass statement! — imad97
– imad97, Commented Nov 22, 2024 at 18:00

Alex Duchnowski · Accepted Answer · 2024-11-23 09:55:56Z

4

As mentioned in Mathias' comment, because there is a docstring as the first element after the signature, the definition is syntactically complete without the need for a pass statement. To remove the warning, either remove the docstring or the pass statement, as it is unnecessary to include both.

edited Nov 23, 2024 at 9:55

Alex Duchnowski

6115 silver badges20 bronze badges

answered Nov 22, 2024 at 19:24

imad97

2861 silver badge12 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Pylint unnecessary pass statement for abstract method

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related