Added PyInstaller stubs for all documented modules & packages by Avasam · Pull Request #8702 · python/typeshed

Avasam · 2022-09-07T23:13:47Z

stubgen was timing out (python/mypy#9103), so I had to generate these stubs using Pyright rather than create_baseline_stubs.py. Hopefully I didn't miss anything.

ignore_missing_stub set to true because most modules are not meant to be used, yet are not marked as private.
Documented modules:

https://pyinstaller.org/en/stable/usage.html
https://pyinstaller.org/en/stable/hooks.html
https://pyinstaller.org/en/stable/hooks-config.html
https://pyinstaller.org/en/stable/advanced-topics.html
https://github.com/pyinstaller/pyinstaller/blob/master/PyInstaller/fake-modules/pyi_splash.py
All __all__ from documented modules & packages

pyi_splash is a fake module that only exists once the app is frozen. It is meant to manipulate the splash screen.

https://pyinstaller.org/en/stable/usage.html https://pyinstaller.org/en/stable/hooks.html https://pyinstaller.org/en/stable/hooks-config.html https://pyinstaller.org/en/stable/advanced-topics.html https://github.com/pyinstaller/pyinstaller/blob/develop/PyInstaller/fake-modules/pyi_splash.py All `__all__` from documented modules & packages

…staller

AlexWaygood · 2022-09-13T21:16:43Z

+ def __init__(
+ self,
+ scripts: Iterable[StrOrBytesPath],
+ pathex=...,
+ binaries=...,
+ datas=...,
+ hiddenimports=...,
+ hookspath=...,
+ hooksconfig: dict[str, dict[str, object]] | None = ...,
+ excludes=...,
+ runtime_hooks=...,
+ cipher=...,
+ win_no_prefer_redirects: bool = ...,
+ win_private_assemblies: bool = ...,
+ noarchive: bool = ...,
+ module_collection_mode=...,
+ ) -> None: ...


I'm confused about why pyright isn't emitting an error here. There's no entry in the pyrightconfig.stricter.json exclude-list, so it should be erroring for any parameters that don't have a type annotation.

Just a guess:
pyrightconfig.stricter.json has "typeCheckingMode": "basic"
and doesn't configure reportMissingParameterType. The default value for that setting being None

No idea -- anyway, it's not your fault, and we certainly don't have a requirement that all parameters need to be annotated when first adding stubs :)
I'll look into it and try to work it out...

AlexWaygood

Thanks! Mostly looks good, but a few points below :) all are fairly minor!

My main concern is using LiteralString for parameter annotations, which seems quite restrictive. Not sure about that.

Avasam · 2022-09-15T02:06:51Z

Here's a batch of fixes from your comments, and a few discussion points.

AlexWaygood

LGTM! Just needs a couple more allowlist entries. I'll apply them and then merge.

AlexWaygood · 2022-09-15T12:19:40Z

+PyInstaller.utils.tests
+PyInstaller.utils.win32.*
+# Explicitly private implementation details
+PyInstaller\._.*


I like that this allowlist entry ends up looking like an emoji

github-actions · 2022-09-15T12:27:14Z

According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉

AlexWaygood · 2022-09-15T12:28:10Z

Thanks @Avasam! :D

This comment has been minimized.
Sign in to view

Merge branch 'master' ofhttps://github.com/python/typeshedinto PyIn…
2e1546b
…staller

Avasam commented Sep 12, 2022
View reviewed changes

Comment threadstubs/pyinstaller/METADATA.toml Outdated

Remove not yet published method
a0b204a

This comment has been minimized.
Sign in to view

Some missed
3801205

This comment has been minimized.
Sign in to view

Missed :
dd58adc

This comment has been minimized.
Sign in to view

Make scale of ignore_missing_stub clear in comment
e445bea

This comment has been minimized.
Sign in to view

AlexWaygood reviewed Sep 13, 2022
View reviewed changes

Comment threadstubs/pyinstaller/PyInstaller/building/build_main.pyi Outdated

__init__
28cee78

This comment has been minimized.
Sign in to view

AlexWaygood reviewed Sep 13, 2022
View reviewed changes

Comment threadstubs/pyinstaller/pyi_splash/__init__.pyi

Avasam added 2 commits September 13, 2022 23:32

Complete imphookapi with missing documented parts
925152b

missed type for parameter "directory"
9e54a30

This comment has been minimized.
Sign in to view

Fix "stub does not have argument"
7278859

This comment has been minimized.
Sign in to view

pyi_homepath path
e35ee77

Avasam commented Sep 14, 2022
View reviewed changes

Comment threadstubs/pyinstaller/PyInstaller/depend/analysis.pyi

This comment has been minimized.
Sign in to view

Avasam commented Sep 14, 2022
View reviewed changes

Comment threadstubs/pyinstaller/PyInstaller/building/build_main.pyi

PyInstaller.depend.analysis.PyiModuleGraph.__init__
69e18c5

This comment has been minimized.
Sign in to view

AlexWaygood reviewed Sep 14, 2022
View reviewed changes

PR review fixes
927419e

This comment has been minimized.
Sign in to view

__eq__ and __ne__ to work with arbitrary objects
7019f09

This comment has been minimized.
Sign in to view

5.4
202d857

This comment has been minimized.
Sign in to view

AlexWaygood reviewed Sep 15, 2022
View reviewed changes

Comment threadstubs/pyinstaller/PyInstaller/lib/modulegraph/modulegraph.pyi

Avasamand others added 2 commits September 15, 2022 08:05

Literals, equality, and ignore_missing_stub
082ddf2

[pre-commit.ci] auto fixes from pre-commit.com hooks
d05c59c

AlexWaygood approved these changes Sep 15, 2022
View reviewed changes

Comment threadstubs/pyinstaller/@tests/stubtest_allowlist.txt

This comment has been minimized.
Sign in to view

AlexWaygood added 2 commits September 15, 2022 13:14

Allow
307e049

.
0e9f838

AlexWaygood reviewed Sep 15, 2022
View reviewed changes

This comment has been minimized.
Sign in to view

AlexWaygood merged commit c9346f3 into python:masterSep 15, 2022

Avasam deleted the PyInstaller branch September 15, 2022 12:31

Avasam mentioned this pull request Sep 19, 2022
Add reportMissingParameterType to pyrightconfig.stricter.json#8770
Merged

Uh oh!

Uh oh!

Conversation

Avasam commented Sep 7, 2022• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment has been minimized.

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

Uh oh!

This comment has been minimized.

AlexWaygoodSep 13, 2022

Choose a reason for hiding this comment

Uh oh!

AvasamSep 13, 2022

Choose a reason for hiding this comment

Uh oh!

AlexWaygoodSep 13, 2022• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

Uh oh!

This comment has been minimized.

Uh oh!

This comment has been minimized.

AlexWaygood left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Avasam commented Sep 15, 2022

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

Uh oh!

AlexWaygood left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

This comment has been minimized.

AlexWaygoodSep 15, 2022

Choose a reason for hiding this comment

Uh oh!

This comment has been minimized.

github-actionsBot commented Sep 15, 2022

Uh oh!

AlexWaygood commented Sep 15, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Avasam commented Sep 7, 2022•
edited
Loading

AlexWaygoodSep 13, 2022•
edited
Loading

AlexWaygood left a comment •
edited
Loading

AlexWaygood left a comment •
edited
Loading