From f1f2ceccc757d9743dde39f626eccf05e3e9a5b0 Mon Sep 17 00:00:00 2001
From: MinchinWeb <w_minchin@hotmail.com>
Date: Sat, 27 Jan 2024 10:47:54 -0700
Subject: [PATCH] Warning/error logging: be explicit in how the `stacklevel`
 variable is handled

---
 pelican/log.py | 40 ++++++++++++++++++++++++++++++----------
 1 file changed, 30 insertions(+), 10 deletions(-)

diff --git a/pelican/log.py b/pelican/log.py
index 6a8fcdf1..ef49d280 100644
--- a/pelican/log.py
+++ b/pelican/log.py
@@ -85,19 +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):
-        if "stacklevel" not in kwargs.keys():
-            kwargs["stacklevel"] = 2
-        super().warning(*args, **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):
-        if "stacklevel" not in kwargs.keys():
-            kwargs["stacklevel"] = 2
-        super().error(*args, **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")