Skip to content

"Signature of a method incompatible with supertype" vs pytest fixtures #10065

Closed

Description

@serhiy-storchaka

I don't know whether it is idiomatic or not, but I use the following approach to parametrize pytest tests. Tests are defined as method in a class. Parameters are defined as fixtures in a class. Fixtures are overridden in subclasses to run tests with different parameters.

For example:

import pytest


class TestA:
    @pytest.fixture
    def foo(self) -> int:
        return 42

    def test_foo(self, foo: int) -> None:
        assert foo > 0


@pytest.fixture
def bar() -> str:
    return "abc"


class TestB(TestA):
    @pytest.fixture
    def foo(self, bar: str) -> int:  # line 20
        return len(bar)

TestA.test_foo and TestB.test_foo are executed with different values of foo. The problem is that fixtures can depend on other fixtures, and signatures for methods defining fixture can be different. MyPy complains:

t.py:20: error: Signature of "foo" incompatible with supertype "TestA"
t.py:20: note:      Superclass:
t.py:20: note:          def foo(self) -> int
t.py:20: note:      Subclass:
t.py:20: note:          def foo(self, bar: str) -> int

It is not real error in the user code that the methods have different signatures. These methods are not called directly. They are called by pytest which provides all arguments.

I can add "# type: ignore", but I do not want to lose static type checking completely. It is useful to check that the type of the parameter matches the returning type of corresponding fixture function.

mypy 0.961 (compiled: yes)
pytest 7.1.2
Python 3.9.13

Activity

  1. The-Compiler commented on Jun 22, 2022

    @The-Compiler
    Member

    This doesn't seem like something pytest can do anything about. Maybe it should be a discussion rather than an issue?

    I've seen this message being disputed for other reasons too:

    Note that mypy supports adding error codes to type ignores.

  2. locked and limited conversation to collaborators on Jun 25, 2022
  3. converted this issue into a discussion #10074 on Jun 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions