python / python/mypy

stubtest and @deprecated

Offen
#20,160 4 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

bug topic-pep-702 topic-stubtest
Vorherrschende Sprache
Python
Sterne
20.6k
Forks
3.3k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

Bug Report

The @warnings.deprecated decorator adds a few dunders to classes it decorates. This causes stubtest to complain about differences between stub and implementation, unless these changes are added manually to the stubs. I think we should special case @deprecated to ignore these differences.

To Reproduce

For example, adding the following test to StubtestUnit:

    @collect_cases
    def test_deprecated(self) -> Iterator[Case]:
        yield Case(
            stub="""
            from warnings import deprecated

            @deprecated("")
            class Foo: ...
            """,
            runtime="""
            from warnings import deprecated

            @deprecated("")
            class Foo:
                pass
            """,
            error=None,
        )

causes the following error when running the tests with Python 3.13:

E           AssertionError: error: test_module.Foo.__deprecated__ is not present in stub
E             Stub: in file test_module.pyi
E             MISSING
E             Runtime:
E             ''
E             
E             error: test_module.Foo.__init_subclass__ is not present in stub
E             Stub: in file test_module.pyi
E             MISSING
E             Runtime: in file /opt/pyenv/versions/3.13.8/lib/python3.13/warnings.py:621
E             def (*args, **kwargs)
E             
E             error: test_module.Foo.__new__ is not present in stub
E             Stub: in file test_module.pyi
E             MISSING
E             Runtime: in file /opt/pyenv/versions/3.13.8/lib/python3.13/warnings.py
E             def (*args, **kwargs)
E             
E             Found 3 errors (checked 1 module)
E             
E           assert {'test_module....Foo.__new__'} == set()
E             
E             Extra items in the left set:
E             'test_module.Foo.__deprecated__'
E             'test_module.Foo.__new__'
E             'test_module.Foo.__init_subclass__'
E             Use -v to get more diff

Interestingly, this is different from what we see in typeshed (python/typeshed#14893):

error: jwcrypto.jwt.JWTMissingKeyID.__init_subclass__ is inconsistent, stub does not have *args parameter "args"
Stub: in file /home/runner/work/typeshed/typeshed/stubs/jwcrypto/jwcrypto/jwt.pyi:139
def (cls: type[builtins.object])
Runtime: in file /opt/hostedtoolcache/Python/3.13.8/x64/lib/python3.13/warnings.py:621
def (*args, **kwargs)

Your Environment

  • Mypy version used: master for the test above, 1.18.2 in typeshed CI
  • Mypy command-line flags:
  • Mypy configuration options from mypy.ini (and other config files):
  • Python version used: 3.13

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit dem vorgeschlagenen Test in StubtestUnit und reproduziere ihn unter Python 3.13. Verfolge, wie stubtest den Vergleich von Klassen durchführt, die mit warnings.deprecated dekoriert sind, und lasse den Test bestehen, wobei du nur die durch den Decorator hinzugefügten Unterschiede ignorierst.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
tooling
Issue-Typ
Bug
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.