Skip to content
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

Better error logging if a plugin refuses to load #3276

Merged
merged 3 commits into from
Jan 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion pelican/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,14 @@ def init_plugins(self):
plugin.register()
self.plugins.append(plugin)
except Exception as e:
logger.error("Cannot register plugin `%s`\n%s", name, e)
logger.error(
"Cannot register plugin `%s`\n%s",
name,
e,
stacklevel=2,
)
if self.settings.get("DEBUG", False):
console.print_exception()

self.settings["PLUGINS"] = [get_plugin_name(p) for p in self.plugins]

Expand Down
36 changes: 30 additions & 6 deletions pelican/log.py
Original file line number Diff line number Diff line change
Expand Up @@ -85,15 +85,39 @@ class FatalLogger(LimitLogger):
warnings_fatal = False
errors_fatal = False

# adding `stacklevel=2` means that the displayed filename and line number
# will match the "original" calling location, rather than the wrapper here
def warning(self, *args, **kwargs):
super().warning(*args, stacklevel=2, **kwargs)
def warning(self, *args, stacklevel=1, **kwargs):
"""
Displays a logging warning.

Wrapping it here allows Pelican to filter warnings, and conditionally
make warnings fatal.

Args:
stacklevel (int): the stacklevel that would be used to display the
calling location, except for this function. Adjusting the
stacklevel allows you to see the "true" calling location of the
warning, rather than this wrapper location.
"""
stacklevel += 1
super().warning(*args, stacklevel=stacklevel, **kwargs)
if FatalLogger.warnings_fatal:
raise RuntimeError("Warning encountered")

def error(self, *args, **kwargs):
super().error(*args, stacklevel=2, **kwargs)
def error(self, *args, stacklevel=1, **kwargs):
"""
Displays a logging error.

Wrapping it here allows Pelican to filter errors, and conditionally
make errors non-fatal.

Args:
stacklevel (int): the stacklevel that would be used to display the
calling location, except for this function. Adjusting the
stacklevel allows you to see the "true" calling location of the
error, rather than this wrapper location.
"""
stacklevel += 1
super().error(*args, stacklevel=stacklevel, **kwargs)
if FatalLogger.errors_fatal:
raise RuntimeError("Error encountered")

Expand Down
Loading