Skip to content

Stubtest: give more helpful errors if a function is missing from the stub#16517

Merged
hauntsaninja merged 2 commits intopython:masterfrom
AlexWaygood:stubtest-missing-functions
Nov 18, 2023
Merged

Stubtest: give more helpful errors if a function is missing from the stub#16517
hauntsaninja merged 2 commits intopython:masterfrom
AlexWaygood:stubtest-missing-functions

Conversation

@AlexWaygood
Copy link
Member

@AlexWaygood AlexWaygood commented Nov 18, 2023

Currently, if a function exists at runtime but is missing from the stub, stubtest will emit an error message like this:

error: shelve.Shelf.__del__ is not present in stub
Stub: in file stdlib\shelve.pyi
MISSING
Runtime: in file C:\Users\alexw\AppData\Local\Programs\Python\Python312\Lib\shelve.py:157
<function Shelf.__del__ at 0x0000024822FD7060>

error: subprocess.Popen.__del__ is not present in stub
Stub: in file stdlib\subprocess.pyi
MISSING
Runtime: in file C:\Users\alexw\AppData\Local\Programs\Python\Python312\Lib\subprocess.py:1120
<function Popen.__del__ at 0x00000248215D3D80>

This isn't particularly helpful: it doesn't tell you anything about the function at runtime, just that there is one. With this PR, stubtest's error messages change to this, which is much more helpful:

error: shelve.Shelf.__del__ is not present in stub
Stub: in file stdlib\shelve.pyi
MISSING
Runtime: in file C:\Users\alexw\AppData\Local\Programs\Python\Python312\Lib\shelve.py:157
def (self)

error: subprocess.Popen.__del__ is not present in stub
Stub: in file stdlib\subprocess.pyi
MISSING
Runtime: in file C:\Users\alexw\AppData\Local\Programs\Python\Python312\Lib\subprocess.py:1120
def (self, _maxsize=9223372036854775807, _warn=<built-in function warn>)

hauntsaninja
hauntsaninja approved these changes Nov 18, 2023
View reviewed changes
Copy link
Collaborator

@hauntsaninja hauntsaninja left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, thank you!

@hauntsaninja hauntsaninja merged commit 6cbdab8 into python:master Nov 18, 2023
@AlexWaygood AlexWaygood deleted the stubtest-missing-functions branch November 18, 2023 20:23
@QuLogic QuLogic mentioned this pull request Apr 1, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@JelleZijlstra JelleZijlstra JelleZijlstra approved these changes

@hauntsaninja hauntsaninja hauntsaninja approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@AlexWaygood @JelleZijlstra @hauntsaninja