Various documentation updates [skip ci] #8214
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Update the introduction section of the Understanding PyInstaller Hooks - change the minimal hook example from hook for `dnspython` (`hook-dns.rdata.py`) to hook for `xml.dom.domreg.py` module from Python standard libary. Add URLs for browsing the hooks available in both `PyInstaller` and `pyinstaller-hooks-contrib` repositories.
Update the section on macOS app bundles under Using PyInstaller to reflect the current layout of generated app bundles - i.e., the MacOS directory containing only the executable, binaries being placed in the Frameworks directory, cross-linking of content between Frameworks and Resources, etc. Add a note to discourage users from generating onefile .app bundles.
rokm
force-pushed
the
docs-update
branch
2 times, most recently
from
dcf64ab
to
0c7c886
Compare
bwoodsend
approved these changes
Jan 7, 2024
Add a new documentation chapter, "Common Issues and Pitfalls" which at the moment covers the following topics: Frozen applications on macOS and Linux making use of symbolic links since PyInstaller 6.0, and the implications for distribution (e.g., taking care that symlinks are preserved when copying the frozen application or creating an archive). Launching external programs from the frozen application; provides the explanation of why launching external applications requires manual sanitization oflibrary search paths, and how to achieve it. Primary goal is to document the modifications of libary-search-path related environment variables - both by bootloader, and potentially also by run-time hooks. But we also need to mention that on Windows, `SetDllDirectory()` is used, and that in order to undo its effects, `SetDllDirectory(NULL)` call is needed... Multi-processing; document and explain the need for calling `multiprocessing.freeze_support` when using `multiprocessing` functionality. Windowed/noconsole mode on Windows; explain that in noconsole builds on Windows, standard I/O file handles are `None`, and provide a work-around for code that naively tries to access their attributes without first checking that they are available.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update the introduction in
Understanding PyInstaller Hooks. Replace the minimal hook example - instead of outdated hook fordnspython(hook-dns.rdata.py, which is now part of contributed hooks repository anyway), use hook for stdlibxml.dom.domregmodule, which is shipped by core PyInstaller, and is also easier to comment on. Closes #8118.Update the section on macOS app bundles under
Using PyInstallerto reflect the current layout of generated app bundles - i.e., the MacOS directory containing only the executable, binaries being placed in the Frameworks directory, cross-linking of content between Frameworks and Resources, etc. Add a note to discourage users from generating onefile .app bundles. Closes #8119.Lastly, add a new chapter called
Common Issues and Pitfallsthat covers topics such as launching external programs from frozen application (i.e., the need to sanitize library search paths before doing so), use ofmultiprocessing(i.e., the elusivemultiprocessing.freeze_support), symlinks in POSIX builds on non-Windows (implications for copying onedir applications or creatingziparchives; temporary directory requirements for onefile builds),sys.stderrandsys.stdoutbeingNonein Windows noconsole builds.