griefith/test
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

UI: always report to the user when an add-ons fail to load

Browse Source 
Failure to import the module would print a message but not show
any feedback to the user - failing silently.
This commit is contained in:
Campbell Barton
2024-03-21 16:53:37 +11:00
parent 3cb687c32c
commit 429959e268
1 changed files with 14 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
scripts/modules/addon_utils.py
View File

@@ -319,7 +319,14 @@ def enable(module_name, *, default_set=False, persistent=False, handle_error=Non
is_extension = module_name.startswith(_ext_base_pkg_idname_with_dot)
if handle_error is None:
def handle_error(_ex):
def handle_error(ex):
if isinstance(ex, ImportError):
# NOTE: checking "Add-on " prefix is rather weak,
# it's just a way to avoid the noise of a full trace-back when
# an add-on is simply missing on the file-system.
if (type(msg := ex.msg) is str) and msg.startswith("Add-on "):
print(msg)
return
import traceback
traceback.print_exc()
@@ -400,7 +407,7 @@ def enable(module_name, *, default_set=False, persistent=False, handle_error=Non
# Account for `ImportError` & `ModuleNotFoundError`.
if isinstance(ex, ImportError):
if ex.name == module_name:
print("Add-on not loaded: \"%s\", cause: %s" % (module_name, str(ex)))
ex.msg = "Add-on not loaded: \"%s\", cause: %s" % (module_name, str(ex))
# Issue with an add-on from an extension repository, report a useful message.
elif is_extension and module_name.startswith(ex.name + "."):
@@ -410,22 +417,20 @@ def enable(module_name, *, default_set=False, persistent=False, handle_error=Non
None,
)
if repo is None:
print(
ex.msg = (
"Add-on not loaded: \"%s\", cause: extension repository \"%s\" doesn't exist" %
(module_name, repo_id)
)
elif not repo.enabled:
print(
ex.msg = (
"Add-on not loaded: \"%s\", cause: extension repository \"%s\" is disabled" %
(module_name, repo_id)
)
else:
# The repository exists and is enabled, it should have imported.
print("Add-on not loaded: \"%s\", cause: %s" % (module_name, str(ex)))
else:
handle_error(ex)
else:
handle_error(ex)
ex.msg = "Add-on not loaded: \"%s\", cause: %s" % (module_name, str(ex))
handle_error(ex)
if default_set:
_addon_remove(module_name)