Fix minor issues in stubtest wrapper #28897

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Merged

timhoffm merged 2 commits into matplotlib:main from QuLogic:clearer-stubtest

Sep 29, 2024

Merged

Fix minor issues in stubtest wrapper #28897

timhoffm merged 2 commits into matplotlib:main from QuLogic:clearer-stubtest

Sep 29, 2024

Conversation

QuLogic

Copy link

Member

@QuLogic QuLogic commented Sep 27, 2024

PR summary

The stubtest allow list is technically composed of regex patterns, so ensure that entries are correctly escaped. Also, don't add an exception if it's already covered by our generic ones. This fixes the problem seen in #28874.

PR checklist

[n/a] "closes #0000" is in the body of the PR description to link the related issue
new and changed code is tested
[n/a] Plotting related features are demonstrated in an example
[n/a] New Features and API Changes are noted with a directive and release note
[n/a] Documentation complies with general and docstring guidelines

@QuLogic


 ci: Correct stubtest allow list format

674751a

The list is full of regexs, not globs, so correctly escape the periods
to be more specific.
Note that to catch `module.__init__`, you need to specific `module`, so
there is some slight modification for `matplotlib.tests` /
`matplotlib.sphinxext`.

@QuLogic QuLogic added the topic: typing label

Sep 27, 2024

@QuLogic


 ci: Skip adding a stubtest exception when already allowed

1f6bfca

This fixes the "unused allowlist entry" error we see in matplotlib#28874.

@QuLogic QuLogic force-pushed the clearer-stubtest branch from cdc8f7f to 1f6bfca Compare

September 27, 2024 04:33

@timhoffm

Copy link

Member

timhoffm commented Sep 27, 2024

The existing allowlist looks like it was written with fnmatch logic in mind. Would that be simpler/sufficient rather than using regexes?

@QuLogic

Copy link

Member Author

QuLogic commented Sep 27, 2024

The allow list is defined by stubtest, and always was a regex. The old one worked since regex . matches literal . too, but places with .* were not exactly the same.