fix: load model library when using pyinstaller to build executable fi… #2530
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
appflowy
force-pushed
the
fix_1727
branch
3 times, most recently
from
e0e5b74
to
fe000b7
Compare
cebtenzzre
reviewed
Jul 9, 2024
… windows Signed-off-by: nathan <[email protected]>
cebtenzzre
reviewed
Jul 16, 2024
Comment on lines
57
to
+88
| def load_llmodel_library(): | ||
| """ | ||
| Loads the llmodel shared library based on the current operating system. | ||
|
|
||
| This function attempts to load the shared library using the appropriate file | ||
| extension for the operating system. It first tries to load the library with the | ||
| 'lib' prefix (common for macOS, Linux, and MinGW on Windows). If the file is not | ||
| found and the operating system is Windows, it attempts to load the library without | ||
| the 'lib' prefix (common for MSVC on Windows). | ||
|
|
||
| Returns: | ||
| ctypes.CDLL: The loaded shared library. | ||
|
|
||
| Raises: | ||
| OSError: If the shared library cannot be found. | ||
| """ | ||
| # Determine the appropriate file extension for the shared library based on the platform | ||
| ext = {"Darwin": "dylib", "Linux": "so", "Windows": "dll"}[platform.system()] | ||
|
|
||
| # Define library names with and without the 'lib' prefix | ||
| library_name_with_lib_prefix = f"libllmodel.{ext}" | ||
| library_name_without_lib_prefix = "llmodel.dll" | ||
| base_path = MODEL_LIB_PATH | ||
|
|
||
| try: | ||
| # macOS, Linux, MinGW | ||
| lib = ctypes.CDLL(str(MODEL_LIB_PATH / f"libllmodel.{ext}")) | ||
| except FileNotFoundError: | ||
| if ext != 'dll': | ||
| # Attempt to load the shared library with the 'lib' prefix (common for macOS, Linux, and MinGW) | ||
| lib = ctypes.CDLL(str(base_path / library_name_with_lib_prefix)) | ||
| except OSError: # OSError is more general and includes FileNotFoundError | ||
| if ext != "dll": | ||
| raise | ||
| # MSVC | ||
| lib = ctypes.CDLL(str(MODEL_LIB_PATH / "llmodel.dll")) | ||
| # For Windows (ext == 'dll'), attempt to load the shared library without the 'lib' prefix (common for MSVC) | ||
| lib = ctypes.CDLL(str(base_path / library_name_without_lib_prefix)) |
There was a problem hiding this comment.
Documentation is great, but this is a bit much. All this change really needs to be is:
- Replace FileNotFoundError with OSError
- Add a comment mentioning the specific OSError that appears when using pyinstaller (it will at least have an error code, but often it is a specific subclass of OSError)
- Example:
except OSError: # e.g. FileNotFoundError, PermissionError (pyinstaller)
- Example:
- Make the quotes consistent
- Add a concise docstring - a sentence or two is more than enough
Anything else is unnecessary and IMO too verbose.
Ideally the except clause is as narrow as possible. If there is a specific exception that applies:
try:
...
except (FileNotFoundError, PermissionError): # pyinstaller raises PermissionError
...Otherwise:
try:
...
except OSError as e:
if e.errno not in (errno.ENOENT, errno.EPERM): # pyinstaller fails with EPERM
raise
...And if we're going to add a return type to the docstring, I would prefer we annotate it as well (load_llmodel_library() -> ctypes.CDLL:).
There was a problem hiding this comment.
Thank a bunch! I will make changes later
|
I recently discovered that |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Describe your changes
Fix loading llmmodel library when using pyinstaller to build executable binary that includes gpt4all
Issue ticket number and link
Fix pyinstaller issues: #1727
Checklist before requesting a review